ApiSpecifications
Current page number. Default value is 1.
Maximum page size is 200. Default page size is 30.
Success
GET /api/v1/api-management/api-specifications HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
Success
{
"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"
}
}The Base path (openAPI 2) / Server url (openAPI 3) cannot be modified later.
API specification created
Missing API specification
A path is already used in an existing API
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"
}
}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.
File to upload.
API specification created
Bad Request
A path is already used in an existing API
Client Error
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"
}
}API specification identifier
Success
API specification not found
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"
}
}API specification identifier
Success
No content
Bad Request
API specification not found
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
API specification identifier
API specification version
Success
API specification or version not found
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"
}
}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.
API specification identifier
Agent Group identifier
API specification deleted successfully
Could not find the requested API specification or Agent Group
Could not delete the API specification from the default Agent group, because it is deployed to another Agent Group
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"
}API specification identifier
API specification version
The path of the HTTP endpoint, as specified in the API specification
The operation of the endpoint (e.g. GET)
Success
Bad Request
API specification or version not found
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-09-27T13:37:04.840Z",
"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-09-27T13:37:04.840Z",
"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": {
"major": 1,
"minor": 1,
"build": 1,
"revision": 1,
"majorRevision": 1,
"minorRevision": 1
}
},
"processTemplateDeviated": "2025-09-27T13:37:04.840Z",
"nextProcessTemplate": {
"id": 1,
"name": "text",
"modifier": "text",
"modified": "2025-09-27T13:37:04.840Z",
"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": {
"major": 1,
"minor": 1,
"build": 1,
"revision": 1,
"majorRevision": 1,
"minorRevision": 1
}
}
}
}This locks down the current specification and process versions. A new active version is created, and the previous one becomes deployable.
API specification identifier
Description of the changes made
API specification published
No content
API specification not found
The current state of linked processes is not fit for publishing
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
Returns information about the processes which must be deployed to finish the API deployment. The processes can be deployed using the process-deployments API.
API specification identifier
API specification version
Agent Group identifier
Deployment started
No content
Bad Request
API specification, version or Agent group not found
POST /api/v1/api-management/api-specifications/{id}/{apiVersion}/deploy/{agentGroupId} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
No content
API specification identifier
API specification version
Success
API version not found
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-09-27T13:37:04.840Z",
"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"
]
}
]
}API specification identifier
API specification version
Is CORS enabled
Allowed origins. Used when CORS is enabled.
Source API path for this passthrough configuration. Not used when IsDefault is set to true.
HTTP method. Not used when IsDefault is set to true.
Is this configuration used for all paths and HTTP methods
API passthrough configuration created
No content
Invalid API passthrough configuration
API version not found
A path is already used in an existing API
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
API specification identifier
API specification version
API passthrough configuration identifier
Is CORS enabled
Allowed origins. Used when CORS is enabled.
Success
Bad Request
API version or passthrough configuration not found
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-09-27T13:37:04.840Z",
"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"
]
}
}API specification identifier
API specification version
API passthrough configuration identifier
API passthrough configuration deleted successfully
No content
API version or passthrough configuration not found
DELETE /api/v1/api-management/api-specifications/{apiSpecificationId}/{apiVersion}/api-passthrough/{passthroughConfigId} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
No content
Was this helpful?