PorticoDocs

Admin Ingestion

Generated admin ingestion operations.

DELETE/v1/admin/ingestion/jobs/{id}Remove server ingestion jobslibrary
Audience
Integrations · Native API
Authorization
API key or personal access token with the library scope, or a signed-in session
OpenAPI operation ID
delete_admin_ingestion_jobs_id

Parameters

NameInTypeDescription
idrequiredpathstring

Responses

204Success

defaultRequest refused or unavailableapplication/json

Example
{
  "error": {
    "code": "string",
    "message": "string"
  }
}
Schema
  • errorobjectrequired
    • codestringrequired
    • messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busywriter_capacity

Example request

curl -X DELETE "http://127.0.0.1:32500/v1/admin/ingestion/jobs/{id}" \
  -H "Authorization: Bearer $PORTICO_API_KEY"
GET/v1/admin/ingestion/jobs/{id}Read server ingestion jobslibrary
Audience
Integrations · Native API
Authorization
API key or personal access token with the library scope, or a signed-in session
OpenAPI operation ID
get_admin_ingestion_jobs_id

Parameters

NameInTypeDescription
idrequiredpathstring

Responses

200Successapplication/json

Example
{
  "analyzed": 0,
  "error": "string",
  "id": "id_8h2k4q",
  "jobs": [
    "string"
  ],
  "phase": "string",
  "processed": 0,
  "scanMode": "string",
  "sourceId": "id_8h2k4q",
  "status": "string",
  "warnings": 0
}
Schema
  • analyzedintegerrequired
  • errorstring
  • idstringrequired
  • jobsarray of string
  • phasestring
  • processedintegerrequired
  • scanModestring
  • sourceIdstring
  • statusstringrequired
  • warningsintegerrequired

defaultRequest refused or unavailableapplication/json

Example
{
  "error": {
    "code": "string",
    "message": "string"
  }
}
Schema
  • errorobjectrequired
    • codestringrequired
    • messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/admin/ingestion/jobs/{id}" \
  -H "Authorization: Bearer $PORTICO_API_KEY"
POST/v1/admin/ingestion/jobs/{id}/{action}Run server ingestion jobslibrary
Audience
Integrations · Native API
Authorization
API key or personal access token with the library scope, or a signed-in session
OpenAPI operation ID
post_admin_ingestion_jobs_id_action

Parameters

NameInTypeDescription
idrequiredpathstring
actionrequiredpathstring

Responses

202Successapplication/json

Example
{
  "analyzed": 0,
  "error": "string",
  "id": "id_8h2k4q",
  "jobs": [
    "string"
  ],
  "phase": "string",
  "processed": 0,
  "scanMode": "string",
  "sourceId": "id_8h2k4q",
  "status": "string",
  "warnings": 0
}
Schema
  • analyzedintegerrequired
  • errorstring
  • idstringrequired
  • jobsarray of string
  • phasestring
  • processedintegerrequired
  • scanModestring
  • sourceIdstring
  • statusstringrequired
  • warningsintegerrequired

204Success

defaultRequest refused or unavailableapplication/json

Example
{
  "error": {
    "code": "string",
    "message": "string"
  }
}
Schema
  • errorobjectrequired
    • codestringrequired
    • messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/v1/admin/ingestion/jobs/{id}/{action}" \
  -H "Authorization: Bearer $PORTICO_API_KEY"