Admin Analysis Operations

Generated admin analysis operations operations.

GET/v1/admin/analysis-operationsRead server analysis operationslibrary

Audience: Clients · Native API
Authorization: API key or personal access token with the library scope, or a signed-in session
OpenAPI operation ID: get_admin_analysis_operations

Responses

200Successapplication/json

Example

{
  "protocolVersion": "string",
  "result": {
    "costClasses": [
      {
        "description": "string",
        "id": "id_8h2k4q",
        "name": "Fargo",
        "order": 0
      }
    ],
    "operations": [
      {
        "costClass": "string",
        "defaultEnabled": true,
        "description": "string",
        "id": "id_8h2k4q",
        "mediaKinds": [
          "string"
        ],
        "name": "Fargo",
        "network": true,
        "producesArtifacts": true,
        "requires": [
          "string"
        ]
      }
    ]
  },
  "serverId": "id_8h2k4q"
}

Schema

protocolVersionstringrequired
resultobjectrequired
- costClassesarray of objectrequired
  - descriptionstringrequired
  - idstringrequired
  - namestringrequired
  - orderintegerrequired
- operationsarray of objectrequired
  - costClassstringrequired
  - defaultEnabledbooleanrequired
  - descriptionstringrequired
  - idstringrequired
  - mediaKindsarray of stringrequired
  - namestringrequired
  - networkbooleanrequired
  - producesArtifactsbooleanrequired
  - requiresarray of stringrequired
serverIdstringrequired

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/analysis-operations" \
  -H "Authorization: Bearer $PORTICO_API_KEY"