ApiSpecifications

List API specifications

get

Authorizations

bearerAuth

AuthorizationstringRequired

Enter your bearer token in the format Bearer <token>

Query parameters

PageNumberinteger · int32Optional

Current page number. Default value is 1.

PageSizeinteger · int32Optional

Maximum page size is 200. Default page size is 30.

Responses

200

OK

application/json

get

/api/v1/api-management/api-specifications

HTTPcURLJavaScriptPython

GET /api/v1/api-management/api-specifications HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

OK

{
  "data": [
    {
      "id": 1,
      "name": "text",
      "activeVersion": 1,
      "description": "text"
    }
  ],
  "paging": {
    "currentPage": 1,
    "pageSize": 1,
    "totalCount": 1,
    "firstPage": "https://example.com",
    "lastPage": "https://example.com",
    "nextPage": "https://example.com",
    "previousPage": "https://example.com"
  }
}

Create API specification

post

The Base path (openAPI 2) / Server url (openAPI 3) cannot be modified later.

Authorizations

bearerAuth

AuthorizationstringRequired

Enter your bearer token in the format Bearer <token>

Body

application/json

stringOptional

Responses

201

API specification created

application/json

400

Missing API specification

application/problem+json

409

A path is already used in an existing API

application/problem+json

post

/api/v1/api-management/api-specifications

HTTPcURLJavaScriptPython

POST /api/v1/api-management/api-specifications HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"

{
  "data": {
    "id": 1,
    "name": "text",
    "activeVersion": 1,
    "description": "text"
  }
}

Import API specification

post

This can be a very slow action. Please make sure your client has a long enough timeout so that the operation does not get cancelled. This creates version 1 of the API specification to the default Agent group. The Base path (openAPI 2) / Server url (openAPI 3) cannot be modified later.

Authorizations

bearerAuth

AuthorizationstringRequired

Enter your bearer token in the format Bearer <token>

Body

multipart/form-data

File to upload.

filestring · binaryRequired

Responses

201

API specification created

application/json

400

Bad Request

application/problem+json

409

A path is already used in an existing API

application/problem+json

415

Unsupported Media Type

application/problem+json

post

/api/v1/api-management/api-specifications/import

HTTPcURLJavaScriptPython

POST /api/v1/api-management/api-specifications/import HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 17

{
  "file": "binary"
}

{
  "data": {
    "id": 1,
    "name": "text",
    "activeVersion": 1,
    "description": "text"
  }
}

Get a single API specification

get

Authorizations

bearerAuth

AuthorizationstringRequired

Enter your bearer token in the format Bearer <token>

Path parameters

idinteger · int64Required

API specification identifier

Responses

200

OK

application/json

404

API specification not found

application/problem+json

get

/api/v1/api-management/api-specifications/{id}

HTTPcURLJavaScriptPython

GET /api/v1/api-management/api-specifications/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "id": 1,
    "name": "text",
    "activeVersion": 1,
    "description": "text"
  }
}

Update API specification

put

Authorizations

bearerAuth

AuthorizationstringRequired

Enter your bearer token in the format Bearer <token>

Path parameters

idinteger · int64Required

API specification identifier

Body

application/json

stringOptional

Responses

200

OK

400

Bad Request

application/problem+json

404

API specification not found

application/problem+json

put

/api/v1/api-management/api-specifications/{id}

HTTPcURLJavaScriptPython

PUT /api/v1/api-management/api-specifications/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"

No content

Get a specific version of an API specification

get

Authorizations

bearerAuth

AuthorizationstringRequired

Enter your bearer token in the format Bearer <token>

Path parameters

idinteger · int64Required

API specification identifier

apiVersioninteger · int32Required

API specification version

Responses

200

OK

application/json

404

API specification or version not found

application/problem+json

get

/api/v1/api-management/api-specifications/{id}/{apiVersion}

HTTPcURLJavaScriptPython

GET /api/v1/api-management/api-specifications/{id}/{apiVersion} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "id": 1,
    "name": "text",
    "activeVersion": 1,
    "description": "text"
  }
}

Delete API specification from an Agent Group

delete

To delete a specification from the default Agent group, it must first be deleted from all other Agent groups. Deleting the API specification from the default Agent group deletes it permanently. Linked processes are not deleted.

Authorizations

bearerAuth

AuthorizationstringRequired

Enter your bearer token in the format Bearer <token>

Path parameters

apiSpecificationIdinteger · int64Required

API specification identifier

agentGroupIdinteger · int64Required

Agent Group identifier

Responses

204

API specification deleted successfully

application/problem+json

404

Could not find the requested API specification or Agent Group

application/problem+json

409

Could not delete the API specification from the default Agent group, because it is deployed to another Agent Group

application/problem+json

delete

/api/v1/api-management/api-specifications/{apiSpecificationId}/agent-group/{agentGroupId}

HTTPcURLJavaScriptPython

DELETE /api/v1/api-management/api-specifications/{apiSpecificationId}/agent-group/{agentGroupId} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "type": "text",
  "title": "text",
  "status": 1,
  "detail": "text",
  "instance": "text",
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Get process template for a specific endpoint of an API specification

post

Authorizations

bearerAuth

AuthorizationstringRequired

Enter your bearer token in the format Bearer <token>

Path parameters

idinteger · int64Required

API specification identifier

apiVersioninteger · int32Required

API specification version

Body

application/json

pathstringOptional

The path of the HTTP endpoint, as specified in the API specification

operationstringOptional

The operation of the endpoint (e.g. GET)

Responses

200

OK

application/json

400

Bad Request

application/problem+json

404

API specification or version not found

application/problem+json

post

/api/v1/api-management/api-specifications/{id}/{apiVersion}/processTemplate

HTTPcURLJavaScriptPython

POST /api/v1/api-management/api-specifications/{id}/{apiVersion}/processTemplate HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 34

{
  "path": "text",
  "operation": "text"
}

{
  "data": {
    "isDeleted": true,
    "version": 1,
    "uniqueIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "id": 1,
    "name": "text",
    "modified": "2025-12-18T15:30:00.492Z",
    "modifier": "text",
    "description": "text",
    "isNotLatestVersion": true,
    "changeDescription": "text",
    "bpmn": "text",
    "elementParameters": [
      {
        "id": "text",
        "type": "Start",
        "parameters": {
          "ANY_ADDITIONAL_PROPERTY": [
            "[Circular Reference]"
          ]
        },
        "selectedTypeId": "text",
        "promoteResultAs": "text",
        "name": "text",
        "description": "text",
        "isDefault": true,
        "shouldRetry": true,
        "maxRetryCount": 1,
        "shouldNotLogResult": true,
        "shouldDispose": true
      }
    ],
    "manualTrigger": [
      [
        [
          [
            "[Circular Reference]"
          ]
        ]
      ]
    ],
    "obsoleteTasks": [
      {
        "uri": "text",
        "argumentsJson": "text",
        "returnType": "text",
        "name": "text",
        "displayName": "text",
        "packageName": "text",
        "description": "text",
        "isNotLatestVersion": true,
        "isStandard": true,
        "isDotNet": true
      }
    ],
    "draftId": 1,
    "idOfBaseProcessForDraft": 1,
    "isDraft": true,
    "isSubprocess": true,
    "graphData": {
      "ANY_ADDITIONAL_PROPERTY": [
        [
          [
            "[Circular Reference]"
          ]
        ]
      ]
    },
    "triggerData": [
      [
        [
          [
            "[Circular Reference]"
          ]
        ]
      ]
    ],
    "majorVersion": 1,
    "minorVersion": 1,
    "isMigration": true,
    "activateIfNew": true,
    "frendsVersion": "text",
    "ignoreDependencyConflicts": true,
    "documentationMarkdown": "text",
    "targetFramework": "text",
    "apiSpecId": 1,
    "isForMonitoringRule": true,
    "validationOnly": true,
    "cancellationDisabled": true,
    "processVariables": [
      {
        "name": "text",
        "value": "text",
        "isSecret": true,
        "mode": "text",
        "description": "text"
      }
    ],
    "processTemplate": {
      "id": 1,
      "name": "text",
      "modifier": "text",
      "modified": "2025-12-18T15:30:00.492Z",
      "majorVersion": 1,
      "minorVersion": 1,
      "targetFramework": "text",
      "frendsVersion": "text",
      "isSubprocess": true,
      "staticRequiredEnvironmentVariablesJson": "text",
      "isForMonitoringRule": true,
      "cancellationDisabled": true,
      "description": "text",
      "changeDescription": "text",
      "bpmn": "text",
      "elementParameters": "text",
      "promotedResultVariablesJson": "text",
      "usedSubprocessesJson": "text",
      "usedTasksJson": "text",
      "triggersJson": "text",
      "manualTriggerJson": "text",
      "uniqueIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "isListed": true,
      "version": 1,
      "isDeleted": true,
      "processVariablesJson": "text",
      "processTags": "text",
      "templateTags": [
        "text"
      ],
      "getVersion": "text"
    },
    "processTemplateDeviated": "2025-12-18T15:30:00.492Z",
    "nextProcessTemplate": {
      "id": 1,
      "name": "text",
      "modifier": "text",
      "modified": "2025-12-18T15:30:00.492Z",
      "majorVersion": 1,
      "minorVersion": 1,
      "targetFramework": "text",
      "frendsVersion": "text",
      "isSubprocess": true,
      "staticRequiredEnvironmentVariablesJson": "text",
      "isForMonitoringRule": true,
      "cancellationDisabled": true,
      "description": "text",
      "changeDescription": "text",
      "bpmn": "text",
      "elementParameters": "text",
      "promotedResultVariablesJson": "text",
      "usedSubprocessesJson": "text",
      "usedTasksJson": "text",
      "triggersJson": "text",
      "manualTriggerJson": "text",
      "uniqueIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "isListed": true,
      "version": 1,
      "isDeleted": true,
      "processVariablesJson": "text",
      "processTags": "text",
      "templateTags": [
        "text"
      ],
      "getVersion": "text"
    },
    "performAdditionalSyntaxValidation": true
  }
}

Publish ("save") the active version of an API specification

post

This locks down the current specification and process versions. A new active version is created, and the previous one becomes deployable.

Authorizations

bearerAuth

AuthorizationstringRequired

Enter your bearer token in the format Bearer <token>

Path parameters

idinteger · int64Required

API specification identifier

Body

application/json

changeDescriptionstring | nullableOptional

Description of the changes made

Responses

200

API specification published

404

API specification not found

application/problem+json

409

The current state of linked processes is not fit for publishing

application/problem+json

post

/api/v1/api-management/api-specifications/{id}/publish

HTTPcURLJavaScriptPython

POST /api/v1/api-management/api-specifications/{id}/publish HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "changeDescription": "text"
}

No content

Begin deploying a version of an API specification to an Agent Group

post

Returns information about the processes which must be deployed to finish the API deployment. The processes can be deployed using the process-deployments API.

Authorizations

bearerAuth

AuthorizationstringRequired

Enter your bearer token in the format Bearer <token>

Path parameters

idinteger · int64Required

API specification identifier

apiVersioninteger · int32Required

API specification version

agentGroupIdinteger · int64Required

Agent Group identifier

Responses

200

Deployment started

400

Bad Request

application/problem+json

404

API specification, version or Agent group not found

application/problem+json

post

/api/v1/api-management/api-specifications/{id}/{apiVersion}/deploy/{agentGroupId}

HTTPcURLJavaScriptPython

POST /api/v1/api-management/api-specifications/{id}/{apiVersion}/deploy/{agentGroupId} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

No content

List API passthrough configurations

get

Authorizations

bearerAuth

AuthorizationstringRequired

Enter your bearer token in the format Bearer <token>

Path parameters

apiSpecificationIdinteger · int64Required

API specification identifier

apiVersioninteger · int32Required

API specification version

Responses

200

OK

application/json

404

API version not found

application/problem+json

get

/api/v1/api-management/api-specifications/{apiSpecificationId}/{apiVersion}/api-passthrough

HTTPcURLJavaScriptPython

GET /api/v1/api-management/api-specifications/{apiSpecificationId}/{apiVersion}/api-passthrough HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "id": 1,
      "apiVersionId": 1,
      "modifier": "text",
      "modified": "2025-12-18T15:30:00.492Z",
      "path": "text",
      "method": "text",
      "isDefault": true,
      "corsEnabled": true,
      "targetUrl": {
        "server": "text",
        "basePath": "text",
        "operationPath": "text",
        "query": "text"
      },
      "headers": [
        {
          "action": "text",
          "name": "text",
          "value": "text"
        }
      ],
      "allowedOrigins": [
        "text"
      ]
    }
  ]
}

Create API passthrough configuration

post

Authorizations

bearerAuth

AuthorizationstringRequired

Enter your bearer token in the format Bearer <token>

Path parameters

apiSpecificationIdinteger · int64Required

API specification identifier

apiVersioninteger · int32Required

API specification version

Body

application/json

corsEnabledbooleanOptional

Is CORS enabled

allowedOriginsstring[] | nullableOptional

Allowed origins. Used when CORS is enabled.

pathstring | nullableOptional

Source API path for this passthrough configuration. Not used when IsDefault is set to true.

methodstring | nullableOptional

HTTP method. Not used when IsDefault is set to true.

isDefaultbooleanOptional

Is this configuration used for all paths and HTTP methods

Responses

201

API passthrough configuration created

No content

400

Invalid API passthrough configuration

application/problem+json

404

API version not found

application/problem+json

409

A path is already used in an existing API

application/problem+json

post

/api/v1/api-management/api-specifications/{apiSpecificationId}/{apiVersion}/api-passthrough

HTTPcURLJavaScriptPython

POST /api/v1/api-management/api-specifications/{apiSpecificationId}/{apiVersion}/api-passthrough HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 238

{
  "corsEnabled": true,
  "targetUrl": {
    "server": "text",
    "basePath": "text",
    "operationPath": "text",
    "query": "text"
  },
  "headers": [
    {
      "action": "text",
      "name": "text",
      "value": "text"
    }
  ],
  "allowedOrigins": [
    "text"
  ],
  "path": "text",
  "method": "text",
  "isDefault": true
}

No content

Update API passthrough configuration

put

Authorizations

bearerAuth

AuthorizationstringRequired

Enter your bearer token in the format Bearer <token>

Path parameters

apiSpecificationIdinteger · int64Required

API specification identifier

apiVersioninteger · int32Required

API specification version

passthroughConfigIdinteger · int64Required

API passthrough configuration identifier

Body

application/json

corsEnabledbooleanOptional

Is CORS enabled

allowedOriginsstring[] | nullableOptional

Allowed origins. Used when CORS is enabled.

Responses

200

OK

application/json

400

Bad Request

application/problem+json

404

API version or passthrough configuration not found

application/problem+json

put

/api/v1/api-management/api-specifications/{apiSpecificationId}/{apiVersion}/api-passthrough/{passthroughConfigId}

HTTPcURLJavaScriptPython

PUT /api/v1/api-management/api-specifications/{apiSpecificationId}/{apiVersion}/api-passthrough/{passthroughConfigId} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 191

{
  "corsEnabled": true,
  "targetUrl": {
    "server": "text",
    "basePath": "text",
    "operationPath": "text",
    "query": "text"
  },
  "headers": [
    {
      "action": "text",
      "name": "text",
      "value": "text"
    }
  ],
  "allowedOrigins": [
    "text"
  ]
}

{
  "data": {
    "id": 1,
    "apiVersionId": 1,
    "modifier": "text",
    "modified": "2025-12-18T15:30:00.492Z",
    "path": "text",
    "method": "text",
    "isDefault": true,
    "corsEnabled": true,
    "targetUrl": {
      "server": "text",
      "basePath": "text",
      "operationPath": "text",
      "query": "text"
    },
    "headers": [
      {
        "action": "text",
        "name": "text",
        "value": "text"
      }
    ],
    "allowedOrigins": [
      "text"
    ]
  }
}

Delete API passthrough configuration

delete

Authorizations

bearerAuth

AuthorizationstringRequired

Enter your bearer token in the format Bearer <token>

Path parameters

apiSpecificationIdinteger · int64Required

API specification identifier

apiVersioninteger · int32Required

API specification version

passthroughConfigIdinteger · int64Required

API passthrough configuration identifier

Responses

204

API passthrough configuration deleted successfully

404

API version or passthrough configuration not found

application/problem+json

delete

/api/v1/api-management/api-specifications/{apiSpecificationId}/{apiVersion}/api-passthrough/{passthroughConfigId}

HTTPcURLJavaScriptPython

DELETE /api/v1/api-management/api-specifications/{apiSpecificationId}/{apiVersion}/api-passthrough/{passthroughConfigId} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

No content