Configurations
Returns the configurations available to the caller, optionally filtered by type.
Requires administrative privileges (administrator or service account).
No pagination is applied. The response is further scoped by the caller's visibility rules inside the configurations context.
Filter by configuration type. Restricts the result to configurations of the given type. When omitted, all configurations visible to the caller are returned.
Configurations
Unauthorized
Forbidden
Internal Server Error
GET /api/configurations HTTP/1.1
Accept: */*
{
"data": [
{
"content": {
"key": "value"
},
"external_id": "config-001",
"id": 1,
"inserted_at": "2026-06-18T10:00:00Z",
"type": "jwt",
"updated_at": "2026-06-18T10:00:00Z"
}
]
}Creates a new configuration resource.
Requires administrative privileges (administrator or service account).
Request body:
configuration(required) – Object containing:external_id(required, string) – Unique external identifier.type(required, string) – Configuration type.content(optional, object) – Configuration content. May be omitted at creation.
The response includes a Location header pointing to the created configuration.
Created
Unauthorized
Forbidden
Unprocessable Entity
Internal Server Error
POST /api/configurations HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 85
{
"configuration": {
"content": {
"key": "value"
},
"external_id": "config-001",
"type": "jwt"
}
}{
"data": {
"content": {
"key": "value"
},
"dynamic_content": {
"key": {
"origin": "user",
"value": "value"
}
},
"external_id": "config-001",
"id": 1,
"inserted_at": "2026-06-18T10:00:00Z",
"secrets_key": null,
"type": "jwt",
"updated_at": "2026-06-18T10:00:00Z"
}
}Signs a caller-provided payload using the signing key stored in the specified configuration.
Request body:
payload(required, object) – Data to be signed. Returned as a JWT signed with HS256 using the configuration's secret key.
On success, the response contains the signed token (201 Created).
Configuration external ID
Signed
Signed JWT token
Unauthorized
Not found
Unprocessable Entity
Internal Server Error
POST /api/configurations/{configuration_external_id}/sign HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 30
{
"payload": {
"data": "to_sign"
}
}{
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}Fetches a single configuration using its external ID.
Requires administrative privileges (administrator or service account).
The result is scoped by the caller's visibility rules.
Configuration external ID
Configuration
Unauthorized
Forbidden
Internal Server Error
GET /api/configurations/{external_id} HTTP/1.1
Accept: */*
{
"data": {
"content": {
"key": "value"
},
"dynamic_content": {
"key": {
"origin": "user",
"value": "value"
}
},
"external_id": "config-001",
"id": 1,
"inserted_at": "2026-06-18T10:00:00Z",
"secrets_key": null,
"type": "jwt",
"updated_at": "2026-06-18T10:00:00Z"
}
}Updates an existing configuration identified by its external ID.
Requires administrative privileges (administrator or service account).
Request body:
configuration(required) – Object containing fields to update:type(optional, string) – New configuration type.content(optional, object) – New configuration content.
Only the provided fields are updated; omitted fields retain their previous values. The external_id itself cannot be modified.
Configuration external ID
Updated
Unauthorized
Forbidden
Unprocessable Entity
Internal Server Error
PUT /api/configurations/{external_id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 58
{
"configuration": {
"content": {
"key": "value"
},
"type": "jwt"
}
}{
"data": {
"content": {
"key": "value"
},
"dynamic_content": {
"key": {
"origin": "user",
"value": "value"
}
},
"external_id": "config-001",
"id": 1,
"inserted_at": "2026-06-18T10:00:00Z",
"secrets_key": null,
"type": "jwt",
"updated_at": "2026-06-18T10:00:00Z"
}
}Permanently deletes a configuration by its external ID. The deletion is immediate. There is no public API to restore a deleted configuration.
Requires administrative privileges (administrator or service account).
Configuration external ID
Configuration deleted
No content
Unauthorized
Forbidden
Internal Server Error
DELETE /api/configurations/{external_id} HTTP/1.1
Accept: */*
No content
Updates an existing configuration identified by its external ID.
Requires administrative privileges (administrator or service account).
Request body:
configuration(required) – Object containing fields to update:type(optional, string) – New configuration type.content(optional, object) – New configuration content.
Only the provided fields are updated; omitted fields retain their previous values. The external_id itself cannot be modified.
Configuration external ID
Updated
Unauthorized
Forbidden
Unprocessable Entity
Internal Server Error
PATCH /api/configurations/{external_id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 58
{
"configuration": {
"content": {
"key": "value"
},
"type": "jwt"
}
}{
"data": {
"content": {
"key": "value"
},
"dynamic_content": {
"key": {
"origin": "user",
"value": "value"
}
},
"external_id": "config-001",
"id": 1,
"inserted_at": "2026-06-18T10:00:00Z",
"secrets_key": null,
"type": "jwt",
"updated_at": "2026-06-18T10:00:00Z"
}
}Last updated