Version

Configuration 1.8.0

Dedicated API for component configurations

Servers: http://localhost:4010http://localhost:4000/api/v2

Configuration

Configuration properties for the main API. Can also be used for components.

List configurations

GET /configurations

List all configurations of any component.

Filtering: Only top-level properties are supported as filter fields (kind, tenantId, etc.). Nested properties within spec or meta are not filterable.

Example: filter[kind][eq]=AccessControlUnitMap

Parameters

filter (query, object)
Filter results using field/operator pairs. The format is filter[field][operator]=value.

Supported operators: eq, ne, gt, gte, lt, lte, like.

Multiple filters are combined with AND.
page (query, object)
Cursor-based pagination. Use page[after] or page[before] with a resource id to navigate pages.

Responses

200
OK
400
The server could not understand the request due to invalid syntax.
500
An unexpected error occurred on the server.

Add Configuration

POST /configurations

Create a configuration with specified component type. The "kind" property serves as a discriminator determining which schema is used.

Request body

application/vnd.api+json · AllConfigurations

type (string enum) – The resource type
apiVersion (string, required) – Api version to target with this configuration. This is specific to the configuration kind in the component. Each kind has its own definition with enums. Keeping it here as string for simplicity but must exactly match the enum in the component.
kind (string, required) – The component name to target with this configuration
meta (object, required)
spec (object, required) – configuration specific specifications

Responses

201
Created - Returns the created configuration with the same structure as the request (using the same "kind" discriminator), plus an assigned ID.
400
The server could not understand the request due to invalid syntax.
422
The request body failed validation.
500
An unexpected error occurred on the server.

Get Configuration

GET /configurations/{configurationId}

Get a single Configuration

Parameters

configurationId (path, string (uuid), required)
Uuid of the configuration

Responses

200
OK
404
The requested resource could not be found.
500
An unexpected error occurred on the server.

Overwrite Configuration

PUT /configurations/{configurationId}

Overwrites a configuration. Send the complete spec: this replaces, it does not merge.

Any property left out of the request loses its value, so omitting a property is how you remove one — there is no delete verb and no null sentinel. An omitted property reads back as whatever the schema declares as its default, which is usually nothing but is a real value for properties such as preStartWindow.

Secret properties are the exception. They are read back as REDACTED and can never be echoed, so they may be omitted, or sent as that placeholder, and keep their stored value either way.

The following properties cannot be modified after configuration creation:

api_version
kind

Parameters

configurationId (path, string (uuid), required)
Uuid of the configuration

Request body

application/vnd.api+json · AllConfigurations

type (string enum) – The resource type
apiVersion (string, required) – Api version to target with this configuration. This is specific to the configuration kind in the component. Each kind has its own definition with enums. Keeping it here as string for simplicity but must exactly match the enum in the component.
kind (string, required) – The component name to target with this configuration
meta (object, required)
spec (object, required) – configuration specific specifications

Responses

200
OK
400
The server could not understand the request due to invalid syntax.
404
The requested resource could not be found.
422
The request body failed validation.
500
An unexpected error occurred on the server.

Delete Configuration

DELETE /configurations/{configurationId}

Remove the specified configuration.

Refused with 409 while another configuration still references it — for example an accessController naming this provider in providerId. The referring configuration must be repointed or removed first.

Parameters

configurationId (path, string (uuid), required)
Uuid of the configuration

Responses

204
No Content
404
The requested resource could not be found.
409
The resource cannot be deleted because it is still referenced by other resources.