AI Workspace
1.0.0
References
Platform API

Applications¶

Application management operations

Create a new application¶

POST /applications

Code samples

curl -X POST https://localhost:9243/api/v0.9/applications \
  -H 'Authorization: Bearer {access_token}' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d @payload.json

Creates a new application within the organization specified in the JWT token.

Payload

{
  "id": "my-app-handle",
  "displayName": "GenAI Demo App",
  "projectId": "default-project",
  "type": "genai",
  "description": "Sample GenAI application"
}

Authentication¶

This operation requires a Bearer JWT access token in the Authorization header. Required scopes (the token must carry at least one of): `ap:application:create`, `ap:application:manage`

Parameters

Name	In	Type	Required	Description
body	body	CreateApplicationRequest	true	none

Example responses

201 Response

{
  "id": "my-app-handle",
  "displayName": "GenAI Demo App",
  "projectId": "default-project",
  "type": "genai",
  "description": "Sample GenAI application",
  "createdBy": "john.doe",
  "updatedBy": "john.doe",
  "createdAt": "2025-11-15T10:30:00Z",
  "updatedAt": "2025-11-15T11:30:00Z"
}

400 Response

{
  "status": "error",
  "code": "VALIDATION_FAILED",
  "message": "The request failed validation.",
  "errors": [
    {
      "field": "<name of the offending field>",
      "message": "<reason this field failed validation>"
    }
  ]
}

401 Response

{
  "status": "error",
  "code": "UNAUTHORIZED",
  "message": "Authorization header is required, or the token is invalid or expired."
}

403 Response

{
  "status": "error",
  "code": "FORBIDDEN",
  "message": "You do not have permission to perform this action."
}

404 Response

{
  "status": "error",
  "code": "NOT_FOUND",
  "message": "The specified resource does not exist."
}

409 Response

{
  "status": "error",
  "code": "CONFLICT",
  "message": "The request conflicts with the current state of the resource."
}

500 Response

{
  "status": "error",
  "code": "INTERNAL_ERROR",
  "message": "An unexpected error occurred.",
  "trackingId": "4f1c6f2e-8a4b-4c93-b1de-9f2f6f0c2a11"
}

Responses

Status	Meaning	Description	Schema
201	Created	Application created successfully	Application
400	Bad Request	Bad Request. Invalid request or validation error.	Error
401	Unauthorized	Unauthorized. Authentication credentials are missing or invalid.	Error
403	Forbidden	Forbidden. The authenticated user does not have permission to access this resource.	Error
404	Not Found	Not Found. The specified resource does not exist.	Error
409	Conflict	Conflict. The request conflicts with the current state of the resource.	Error
500	Internal Server Error	Internal Server Error.	Error

Response Headers¶

Status	Header	Type	Format	Description
201	Location	string	uri	URL of the newly created resource.

Get applications for current user's organization¶

GET /applications

Code samples

curl -X GET https://localhost:9243/api/v0.9/applications?projectId=default-project \
  -H 'Authorization: Bearer {access_token}' \
  -H 'Accept: application/json'

Retrieves applications belonging to the organization specified in the JWT token. Filters by project using the required projectId query parameter.

Authentication¶

This operation requires a Bearer JWT access token in the Authorization header. Required scopes (the token must carry at least one of): `ap:application:read`, `ap:application:manage`

Parameters

Name	In	Type	Required	Description
projectId	query	string	true	Project ID consisting of the handle (unique slug identifier) of the Project whose resources should be returned.
limit	query	integer	false	Maximum number of items to return per page.
offset	query	integer	false	Zero-based index of the first item to return.
sortBy	query	string	false	Field to sort the collection by. An unrecognized value falls back to the default sort (createdAt).
sortOrder	query	string	false	Sort direction applied to `sortBy`.
query	query	string	false	Case-insensitive substring filter matched against the resource id (handle).

Detailed descriptions

projectId: Project ID consisting of the handle (unique slug identifier) of the Project whose resources should be returned.

Enumerated Values

Parameter	Value
sortBy	name
sortBy	createdAt
sortOrder	asc
sortOrder	desc

Example responses

200 Response

{
  "count": 2,
  "list": [
    {
      "id": "my-app-handle",
      "displayName": "GenAI Demo App",
      "projectId": "default-project",
      "type": "genai",
      "description": "Sample GenAI application",
      "createdBy": "john.doe",
      "updatedBy": "john.doe",
      "createdAt": "2025-11-15T10:30:00Z",
      "updatedAt": "2025-11-15T11:30:00Z"
    }
  ],
  "pagination": {
    "total": 10,
    "offset": 0,
    "limit": 10
  }
}

401 Response

{
  "status": "error",
  "code": "UNAUTHORIZED",
  "message": "Authorization header is required, or the token is invalid or expired."
}

404 Response

{
  "status": "error",
  "code": "NOT_FOUND",
  "message": "The specified resource does not exist."
}

500 Response

{
  "status": "error",
  "code": "INTERNAL_ERROR",
  "message": "An unexpected error occurred.",
  "trackingId": "4f1c6f2e-8a4b-4c93-b1de-9f2f6f0c2a11"
}

Responses

Status	Meaning	Description	Schema
200	OK	Applications retrieved successfully	ApplicationListResponse
401	Unauthorized	Unauthorized. Authentication credentials are missing or invalid.	Error
404	Not Found	Not Found. The specified resource does not exist.	Error
500	Internal Server Error	Internal Server Error.	Error

Get application by handle¶

GET /applications/{applicationId}

Code samples

curl -X GET https://localhost:9243/api/v0.9/applications/{applicationId} \
  -H 'Authorization: Bearer {access_token}' \
  -H 'Accept: application/json'

Retrieves a specific application by handle. Access is validated against the organization in the JWT token.

Authentication¶

This operation requires a Bearer JWT access token in the Authorization header. Required scopes (the token must carry at least one of): `ap:application:read`, `ap:application:manage`

Parameters

Name	In	Type	Required	Description
applicationId	path	string	true	Application ID consisting of the handle of the application.

Detailed descriptions

applicationId: Application ID consisting of the handle of the application.

Example responses

200 Response

{
  "id": "my-app-handle",
  "displayName": "GenAI Demo App",
  "projectId": "default-project",
  "type": "genai",
  "description": "Sample GenAI application",
  "createdBy": "john.doe",
  "updatedBy": "john.doe",
  "createdAt": "2025-11-15T10:30:00Z",
  "updatedAt": "2025-11-15T11:30:00Z"
}

400 Response

{
  "status": "error",
  "code": "VALIDATION_FAILED",
  "message": "The request failed validation.",
  "errors": [
    {
      "field": "<name of the offending field>",
      "message": "<reason this field failed validation>"
    }
  ]
}

401 Response

{
  "status": "error",
  "code": "UNAUTHORIZED",
  "message": "Authorization header is required, or the token is invalid or expired."
}

404 Response

{
  "status": "error",
  "code": "NOT_FOUND",
  "message": "The specified resource does not exist."
}

500 Response

{
  "status": "error",
  "code": "INTERNAL_ERROR",
  "message": "An unexpected error occurred.",
  "trackingId": "4f1c6f2e-8a4b-4c93-b1de-9f2f6f0c2a11"
}

Responses

Status	Meaning	Description	Schema
200	OK	Application retrieved successfully	Application
400	Bad Request	Bad Request. Invalid request or validation error.	Error
401	Unauthorized	Unauthorized. Authentication credentials are missing or invalid.	Error
404	Not Found	Not Found. The specified resource does not exist.	Error
500	Internal Server Error	Internal Server Error.	Error

Update application¶

PUT /applications/{applicationId}

Code samples

curl -X PUT https://localhost:9243/api/v0.9/applications/{applicationId} \
  -H 'Authorization: Bearer {access_token}' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d @payload.json

Updates an existing application by handle.

Payload

{
  "id": "my-app-handle",
  "displayName": "GenAI Demo App",
  "projectId": "default-project",
  "type": "genai",
  "description": "Sample GenAI application"
}

Authentication¶

This operation requires a Bearer JWT access token in the Authorization header. Required scopes (the token must carry at least one of): `ap:application:update`, `ap:application:manage`

Parameters

Name	In	Type	Required	Description
applicationId	path	string	true	Application ID consisting of the handle of the application.
body	body	Application	true	none

Detailed descriptions

applicationId: Application ID consisting of the handle of the application.

Example responses

200 Response

{
  "id": "my-app-handle",
  "displayName": "GenAI Demo App",
  "projectId": "default-project",
  "type": "genai",
  "description": "Sample GenAI application",
  "createdBy": "john.doe",
  "updatedBy": "john.doe",
  "createdAt": "2025-11-15T10:30:00Z",
  "updatedAt": "2025-11-15T11:30:00Z"
}

400 Response

{
  "status": "error",
  "code": "VALIDATION_FAILED",
  "message": "The request failed validation.",
  "errors": [
    {
      "field": "<name of the offending field>",
      "message": "<reason this field failed validation>"
    }
  ]
}

401 Response

{
  "status": "error",
  "code": "UNAUTHORIZED",
  "message": "Authorization header is required, or the token is invalid or expired."
}

403 Response

{
  "status": "error",
  "code": "FORBIDDEN",
  "message": "You do not have permission to perform this action."
}

404 Response

{
  "status": "error",
  "code": "NOT_FOUND",
  "message": "The specified resource does not exist."
}

409 Response

{
  "status": "error",
  "code": "CONFLICT",
  "message": "The request conflicts with the current state of the resource."
}

500 Response

{
  "status": "error",
  "code": "INTERNAL_ERROR",
  "message": "An unexpected error occurred.",
  "trackingId": "4f1c6f2e-8a4b-4c93-b1de-9f2f6f0c2a11"
}

Responses

Status	Meaning	Description	Schema
200	OK	Application updated successfully	Application
400	Bad Request	Bad Request. Invalid request or validation error.	Error
401	Unauthorized	Unauthorized. Authentication credentials are missing or invalid.	Error
403	Forbidden	Forbidden. The authenticated user does not have permission to access this resource.	Error
404	Not Found	Not Found. The specified resource does not exist.	Error
409	Conflict	Conflict. The request conflicts with the current state of the resource.	Error
500	Internal Server Error	Internal Server Error.	Error

Delete application¶

DELETE /applications/{applicationId}

Code samples

curl -X DELETE https://localhost:9243/api/v0.9/applications/{applicationId} \
  -H 'Authorization: Bearer {access_token}' \
  -H 'Accept: application/json'

Deletes an existing application by handle.

Authentication¶

This operation requires a Bearer JWT access token in the Authorization header. Required scopes (the token must carry at least one of): `ap:application:delete`, `ap:application:manage`

Parameters

Name	In	Type	Required	Description
applicationId	path	string	true	Application ID consisting of the handle of the application.

Detailed descriptions

applicationId: Application ID consisting of the handle of the application.

Example responses

400 Response

{
  "status": "error",
  "code": "VALIDATION_FAILED",
  "message": "The request failed validation.",
  "errors": [
    {
      "field": "<name of the offending field>",
      "message": "<reason this field failed validation>"
    }
  ]
}

401 Response

{
  "status": "error",
  "code": "UNAUTHORIZED",
  "message": "Authorization header is required, or the token is invalid or expired."
}

403 Response

{
  "status": "error",
  "code": "FORBIDDEN",
  "message": "You do not have permission to perform this action."
}

404 Response

{
  "status": "error",
  "code": "NOT_FOUND",
  "message": "The specified resource does not exist."
}

500 Response

{
  "status": "error",
  "code": "INTERNAL_ERROR",
  "message": "An unexpected error occurred.",
  "trackingId": "4f1c6f2e-8a4b-4c93-b1de-9f2f6f0c2a11"
}

Responses

Status	Meaning	Description	Schema
204	No Content	Application deleted successfully	None
400	Bad Request	Bad Request. Invalid request or validation error.	Error
401	Unauthorized	Unauthorized. Authentication credentials are missing or invalid.	Error
403	Forbidden	Forbidden. The authenticated user does not have permission to access this resource.	Error
404	Not Found	Not Found. The specified resource does not exist.	Error
500	Internal Server Error	Internal Server Error.	Error

List application API key mappings¶

GET /applications/{applicationId}/api-keys

Code samples

curl -X GET https://localhost:9243/api/v0.9/applications/{applicationId}/api-keys \
  -H 'Authorization: Bearer {access_token}' \
  -H 'Accept: application/json'

Lists all API keys mapped to the specified application.

Authentication¶

This operation requires a Bearer JWT access token in the Authorization header. Required scopes (the token must carry at least one of): `ap:application:api_key:read`, `ap:application:api_key:manage`, `ap:application:manage`, `ap:api_key:all:manage`

Parameters

Name	In	Type	Required	Description
applicationId	path	string	true	Application ID consisting of the handle of the application.
limit	query	integer	false	Maximum number of items to return per page.
offset	query	integer	false	Zero-based index of the first item to return.

Detailed descriptions

applicationId: Application ID consisting of the handle of the application.

Example responses

200 Response

{
  "count": 2,
  "list": [
    {
      "keyId": "client-key-1",
      "associatedEntity": {
        "id": "pizza-api",
        "kind": "RestApi"
      },
      "status": "ACTIVE",
      "userId": "john.doe",
      "createdAt": "2025-11-15T10:30:00Z",
      "updatedAt": "2025-11-15T11:30:00Z",
      "expiresAt": "2026-11-15T10:30:00Z"
    }
  ],
  "pagination": {
    "total": 10,
    "offset": 0,
    "limit": 10
  }
}

400 Response

{
  "status": "error",
  "code": "VALIDATION_FAILED",
  "message": "The request failed validation.",
  "errors": [
    {
      "field": "<name of the offending field>",
      "message": "<reason this field failed validation>"
    }
  ]
}

401 Response

{
  "status": "error",
  "code": "UNAUTHORIZED",
  "message": "Authorization header is required, or the token is invalid or expired."
}

403 Response

{
  "status": "error",
  "code": "FORBIDDEN",
  "message": "You do not have permission to perform this action."
}

404 Response

{
  "status": "error",
  "code": "NOT_FOUND",
  "message": "The specified resource does not exist."
}

500 Response

{
  "status": "error",
  "code": "INTERNAL_ERROR",
  "message": "An unexpected error occurred.",
  "trackingId": "4f1c6f2e-8a4b-4c93-b1de-9f2f6f0c2a11"
}

Responses

Status	Meaning	Description	Schema
200	OK	Mapped API keys retrieved successfully	MappedAPIKeyListResponse
400	Bad Request	Bad Request. Invalid request or validation error.	Error
401	Unauthorized	Unauthorized. Authentication credentials are missing or invalid.	Error
403	Forbidden	Forbidden. The authenticated user does not have permission to access this resource.	Error
404	Not Found	Not Found. The specified resource does not exist.	Error
500	Internal Server Error	Internal Server Error.	Error

Add application API key mappings¶

POST /applications/{applicationId}/api-keys

Code samples

curl -X POST https://localhost:9243/api/v0.9/applications/{applicationId}/api-keys \
  -H 'Authorization: Bearer {access_token}' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d @payload.json

Adds API key mappings to the specified application.

Payload

{
  "apiKeys": [
    {
      "keyId": "client-key-1",
      "associatedEntity": {
        "id": "pizza-api"
      }
    }
  ]
}

Authentication¶

This operation requires a Bearer JWT access token in the Authorization header. Required scopes (the token must carry at least one of): `ap:application:api_key:create`, `ap:application:api_key:manage`, `ap:application:manage`, `ap:api_key:all:manage`

Parameters

Name	In	Type	Required	Description
applicationId	path	string	true	Application ID consisting of the handle of the application.
body	body	AddApplicationAPIKeysRequest	true	none

Detailed descriptions

applicationId: Application ID consisting of the handle of the application.

Example responses

200 Response

{
  "count": 2,
  "list": [
    {
      "keyId": "client-key-1",
      "associatedEntity": {
        "id": "pizza-api",
        "kind": "RestApi"
      },
      "status": "ACTIVE",
      "userId": "john.doe",
      "createdAt": "2025-11-15T10:30:00Z",
      "updatedAt": "2025-11-15T11:30:00Z",
      "expiresAt": "2026-11-15T10:30:00Z"
    }
  ],
  "pagination": {
    "total": 10,
    "offset": 0,
    "limit": 10
  }
}

400 Response

{
  "status": "error",
  "code": "VALIDATION_FAILED",
  "message": "The request failed validation.",
  "errors": [
    {
      "field": "<name of the offending field>",
      "message": "<reason this field failed validation>"
    }
  ]
}

401 Response

{
  "status": "error",
  "code": "UNAUTHORIZED",
  "message": "Authorization header is required, or the token is invalid or expired."
}

403 Response

{
  "status": "error",
  "code": "FORBIDDEN",
  "message": "You do not have permission to perform this action."
}

404 Response

{
  "status": "error",
  "code": "NOT_FOUND",
  "message": "The specified resource does not exist."
}

500 Response

{
  "status": "error",
  "code": "INTERNAL_ERROR",
  "message": "An unexpected error occurred.",
  "trackingId": "4f1c6f2e-8a4b-4c93-b1de-9f2f6f0c2a11"
}

Responses

Status	Meaning	Description	Schema
200	OK	API key mappings added successfully	MappedAPIKeyListResponse
400	Bad Request	Bad Request. Invalid request or validation error.	Error
401	Unauthorized	Unauthorized. Authentication credentials are missing or invalid.	Error
403	Forbidden	Forbidden. The authenticated user does not have permission to access this resource.	Error
404	Not Found	Not Found. The specified resource does not exist.	Error
500	Internal Server Error	Internal Server Error.	Error

Remove application API key mapping¶

DELETE /applications/{applicationId}/api-keys/{apiKeyId}

Code samples

curl -X DELETE https://localhost:9243/api/v0.9/applications/{applicationId}/api-keys/{apiKeyId}?entityID=my-rest-api-handle \
  -H 'Authorization: Bearer {access_token}' \
  -H 'Accept: application/json'

Removes a mapped API key from the specified application.

Authentication¶

This operation requires a Bearer JWT access token in the Authorization header. Required scopes (the token must carry at least one of): `ap:application:api_key:delete`, `ap:application:api_key:manage`, `ap:application:manage`, `ap:api_key:all:manage`

Parameters

Name	In	Type	Required	Description
applicationId	path	string	true	Application ID consisting of the handle of the application.
apiKeyId	path	string	true	API Key ID consisting of the name of the API key.
entityID	query	string	true	Entity ID of the artifact associated with the API key mapping.

Detailed descriptions

applicationId: Application ID consisting of the handle of the application.

apiKeyId: API Key ID consisting of the name of the API key.

entityID: Entity ID of the artifact associated with the API key mapping.

Example responses

400 Response

{
  "status": "error",
  "code": "VALIDATION_FAILED",
  "message": "The request failed validation.",
  "errors": [
    {
      "field": "<name of the offending field>",
      "message": "<reason this field failed validation>"
    }
  ]
}

401 Response

{
  "status": "error",
  "code": "UNAUTHORIZED",
  "message": "Authorization header is required, or the token is invalid or expired."
}

403 Response

{
  "status": "error",
  "code": "FORBIDDEN",
  "message": "You do not have permission to perform this action."
}

404 Response

{
  "status": "error",
  "code": "NOT_FOUND",
  "message": "The specified resource does not exist."
}

500 Response

{
  "status": "error",
  "code": "INTERNAL_ERROR",
  "message": "An unexpected error occurred.",
  "trackingId": "4f1c6f2e-8a4b-4c93-b1de-9f2f6f0c2a11"
}

Responses

Status	Meaning	Description	Schema
204	No Content	API key mapping removed successfully	None
400	Bad Request	Bad Request. Invalid request or validation error.	Error
401	Unauthorized	Unauthorized. Authentication credentials are missing or invalid.	Error
403	Forbidden	Forbidden. The authenticated user does not have permission to access this resource.	Error
404	Not Found	Not Found. The specified resource does not exist.	Error
500	Internal Server Error	Internal Server Error.	Error

List application associations¶

GET /applications/{applicationId}/associations

Code samples

curl -X GET https://localhost:9243/api/v0.9/applications/{applicationId}/associations \
  -H 'Authorization: Bearer {access_token}' \
  -H 'Accept: application/json'

Lists association targets mapped to the specified application.

Authentication¶

This operation requires a Bearer JWT access token in the Authorization header. Required scopes (the token must carry at least one of): `ap:application:association:read`, `ap:application:association:manage`, `ap:application:manage`

Parameters

Name	In	Type	Required	Description
applicationId	path	string	true	Application ID consisting of the handle of the application.
limit	query	integer	false	Maximum number of items to return per page.
offset	query	integer	false	Zero-based index of the first item to return.

Detailed descriptions

applicationId: Application ID consisting of the handle of the application.

Example responses

200 Response

{
  "count": 2,
  "list": [
    {
      "id": "provider-handle",
      "displayName": "OpenAI Provider",
      "version": "v1.0",
      "kind": "LlmProvider",
      "createdAt": "2025-11-15T10:30:00Z",
      "updatedAt": "2025-11-15T11:30:00Z"
    }
  ],
  "pagination": {
    "total": 10,
    "offset": 0,
    "limit": 10
  }
}

400 Response

{
  "status": "error",
  "code": "VALIDATION_FAILED",
  "message": "The request failed validation.",
  "errors": [
    {
      "field": "<name of the offending field>",
      "message": "<reason this field failed validation>"
    }
  ]
}

401 Response

{
  "status": "error",
  "code": "UNAUTHORIZED",
  "message": "Authorization header is required, or the token is invalid or expired."
}

404 Response

{
  "status": "error",
  "code": "NOT_FOUND",
  "message": "The specified resource does not exist."
}

500 Response

{
  "status": "error",
  "code": "INTERNAL_ERROR",
  "message": "An unexpected error occurred.",
  "trackingId": "4f1c6f2e-8a4b-4c93-b1de-9f2f6f0c2a11"
}

Responses

Status	Meaning	Description	Schema
200	OK	Application associations retrieved successfully	ApplicationAssociationListResponse
400	Bad Request	Bad Request. Invalid request or validation error.	Error
401	Unauthorized	Unauthorized. Authentication credentials are missing or invalid.	Error
404	Not Found	Not Found. The specified resource does not exist.	Error
500	Internal Server Error	Internal Server Error.	Error

Add application associations¶

POST /applications/{applicationId}/associations

Code samples

curl -X POST https://localhost:9243/api/v0.9/applications/{applicationId}/associations \
  -H 'Authorization: Bearer {access_token}' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d @payload.json

Adds association targets to the specified application.

Payload

{
  "associations": [
    {
      "id": "provider-handle",
      "kind": "LlmProvider"
    }
  ]
}

Authentication¶

This operation requires a Bearer JWT access token in the Authorization header. Required scopes (the token must carry at least one of): `ap:application:association:create`, `ap:application:association:manage`, `ap:application:manage`

Parameters

Name	In	Type	Required	Description
applicationId	path	string	true	Application ID consisting of the handle of the application.
body	body	AddApplicationAssociationsRequest	true	none

Detailed descriptions

applicationId: Application ID consisting of the handle of the application.

Example responses

200 Response

{
  "count": 2,
  "list": [
    {
      "id": "provider-handle",
      "displayName": "OpenAI Provider",
      "version": "v1.0",
      "kind": "LlmProvider",
      "createdAt": "2025-11-15T10:30:00Z",
      "updatedAt": "2025-11-15T11:30:00Z"
    }
  ],
  "pagination": {
    "total": 10,
    "offset": 0,
    "limit": 10
  }
}

400 Response

{
  "status": "error",
  "code": "VALIDATION_FAILED",
  "message": "The request failed validation.",
  "errors": [
    {
      "field": "<name of the offending field>",
      "message": "<reason this field failed validation>"
    }
  ]
}

401 Response

{
  "status": "error",
  "code": "UNAUTHORIZED",
  "message": "Authorization header is required, or the token is invalid or expired."
}

403 Response

{
  "status": "error",
  "code": "FORBIDDEN",
  "message": "You do not have permission to perform this action."
}

404 Response

{
  "status": "error",
  "code": "NOT_FOUND",
  "message": "The specified resource does not exist."
}

500 Response

{
  "status": "error",
  "code": "INTERNAL_ERROR",
  "message": "An unexpected error occurred.",
  "trackingId": "4f1c6f2e-8a4b-4c93-b1de-9f2f6f0c2a11"
}

Responses

Status	Meaning	Description	Schema
200	OK	Application associations added successfully	ApplicationAssociationListResponse
400	Bad Request	Bad Request. Invalid request or validation error.	Error
401	Unauthorized	Unauthorized. Authentication credentials are missing or invalid.	Error
403	Forbidden	Forbidden. The authenticated user does not have permission to access this resource.	Error
404	Not Found	Not Found. The specified resource does not exist.	Error
500	Internal Server Error	Internal Server Error.	Error

Remove application association¶

DELETE /applications/{applicationId}/associations/{associationId}

Code samples

curl -X DELETE https://localhost:9243/api/v0.9/applications/{applicationId}/associations/{associationId} \
  -H 'Authorization: Bearer {access_token}' \
  -H 'Accept: application/json'

Removes an association target from the specified application.

Authentication¶

This operation requires a Bearer JWT access token in the Authorization header. Required scopes (the token must carry at least one of): `ap:application:association:delete`, `ap:application:association:manage`, `ap:application:manage`

Parameters

Name	In	Type	Required	Description
applicationId	path	string	true	Application ID consisting of the handle of the application.
associationId	path	string	true	Association ID consisting of the handle or UUID of the association target.

Detailed descriptions

applicationId: Application ID consisting of the handle of the application.

associationId: Association ID consisting of the handle or UUID of the association target.

Example responses

400 Response

{
  "status": "error",
  "code": "VALIDATION_FAILED",
  "message": "The request failed validation.",
  "errors": [
    {
      "field": "<name of the offending field>",
      "message": "<reason this field failed validation>"
    }
  ]
}

401 Response

{
  "status": "error",
  "code": "UNAUTHORIZED",
  "message": "Authorization header is required, or the token is invalid or expired."
}

403 Response

{
  "status": "error",
  "code": "FORBIDDEN",
  "message": "You do not have permission to perform this action."
}

404 Response

{
  "status": "error",
  "code": "NOT_FOUND",
  "message": "The specified resource does not exist."
}

500 Response

{
  "status": "error",
  "code": "INTERNAL_ERROR",
  "message": "An unexpected error occurred.",
  "trackingId": "4f1c6f2e-8a4b-4c93-b1de-9f2f6f0c2a11"
}

Responses

Status	Meaning	Description	Schema
204	No Content	Application association removed successfully	None
400	Bad Request	Bad Request. Invalid request or validation error.	Error
401	Unauthorized	Unauthorized. Authentication credentials are missing or invalid.	Error
403	Forbidden	Forbidden. The authenticated user does not have permission to access this resource.	Error
404	Not Found	Not Found. The specified resource does not exist.	Error
500	Internal Server Error	Internal Server Error.	Error

List application API key mappings for an association¶

GET /applications/{applicationId}/associations/{associationId}/api-keys

Code samples

curl -X GET https://localhost:9243/api/v0.9/applications/{applicationId}/associations/{associationId}/api-keys \
  -H 'Authorization: Bearer {access_token}' \
  -H 'Accept: application/json'

Lists API keys mapped to the specified application for the given associated target.

Authentication¶

This operation requires a Bearer JWT access token in the Authorization header. Required scopes (the token must carry at least one of): `ap:application:association:api_key:read`, `ap:application:association:manage`, `ap:application:manage`, `ap:api_key:all:manage`

Parameters

Name	In	Type	Required	Description
applicationId	path	string	true	Application ID consisting of the handle of the application.
associationId	path	string	true	Association ID consisting of the handle or UUID of the association target.
limit	query	integer	false	Maximum number of items to return per page.
offset	query	integer	false	Zero-based index of the first item to return.

Detailed descriptions

applicationId: Application ID consisting of the handle of the application.

associationId: Association ID consisting of the handle or UUID of the association target.

Example responses

200 Response

{
  "count": 2,
  "list": [
    {
      "keyId": "client-key-1",
      "associatedEntity": {
        "id": "pizza-api",
        "kind": "RestApi"
      },
      "status": "ACTIVE",
      "userId": "john.doe",
      "createdAt": "2025-11-15T10:30:00Z",
      "updatedAt": "2025-11-15T11:30:00Z",
      "expiresAt": "2026-11-15T10:30:00Z"
    }
  ],
  "pagination": {
    "total": 10,
    "offset": 0,
    "limit": 10
  }
}

400 Response

{
  "status": "error",
  "code": "VALIDATION_FAILED",
  "message": "The request failed validation.",
  "errors": [
    {
      "field": "<name of the offending field>",
      "message": "<reason this field failed validation>"
    }
  ]
}

401 Response

{
  "status": "error",
  "code": "UNAUTHORIZED",
  "message": "Authorization header is required, or the token is invalid or expired."
}

404 Response

{
  "status": "error",
  "code": "NOT_FOUND",
  "message": "The specified resource does not exist."
}

500 Response

{
  "status": "error",
  "code": "INTERNAL_ERROR",
  "message": "An unexpected error occurred.",
  "trackingId": "4f1c6f2e-8a4b-4c93-b1de-9f2f6f0c2a11"
}

Responses

Status	Meaning	Description	Schema
200	OK	Mapped API keys retrieved successfully	MappedAPIKeyListResponse
400	Bad Request	Bad Request. Invalid request or validation error.	Error
401	Unauthorized	Unauthorized. Authentication credentials are missing or invalid.	Error
404	Not Found	Not Found. The specified resource does not exist.	Error
500	Internal Server Error	Internal Server Error.	Error