For the complete documentation index, see llms.txt. This page is also available as Markdown.

Managing Configurations

Remove Property (External)

delete

Removes a property from the configuration store via external API key authentication

Authorizations
api_keystringRequired

API key authentication via query parameter

Path parameters
externalIdstringRequired
keystringRequired
Query parameters
api_keystringOptional
workspaceIdinteger · int64Required
Header parameters
X-API-KEYstringOptional
Responses
200

Property removed successfully

No content

delete/configurations/{externalId}/properties/{key}/external

No content

Bulk Update Properties (External)

put

Updates multiple properties via external API key authentication

Authorizations
api_keystringRequired

API key authentication via query parameter

Path parameters
externalIdstringRequired
Query parameters
api_keystringOptional
workspaceIdinteger · int64Required
Header parameters
X-API-KEYstringOptional
Body
Responses
200

Properties updated successfully

*/*
idinteger · int64Optional
workspaceIdinteger · int64Optional
namestringOptional
externalIdstringOptional
archivedAtstring · date-timeOptional
put/configurations/{externalId}/properties/external

Get Configuration Keys (External)

get

Retrieves list of property keys via external API key authentication

Authorizations
api_keystringRequired

API key authentication via query parameter

Path parameters
externalIdstringRequired
Query parameters
api_keystringOptional
workspaceIdinteger · int64Required
Header parameters
X-API-KEYstringOptional
Responses
200

Configuration keys retrieved successfully

*/*
keysstring[]Required
externalIdstringRequired
namestringRequired
get/configurations/{externalId}/keys/external

Create Configuration Store (External)

post

Creates a new configuration store via external API key authentication

Authorizations
api_keystringRequired

API key authentication via query parameter

Query parameters
api_keystringOptional
Header parameters
X-API-KEYstringOptional
Body
workspaceIdinteger · int64Required
namestringRequired
externalIdstringRequired
Responses
201

Configuration store created successfully

*/*
idinteger · int64Optional
workspaceIdinteger · int64Optional
namestringOptional
externalIdstringOptional
archivedAtstring · date-timeOptional
post/configurations/external
201

Configuration store created successfully

Delete Configuration Store (External)

delete

Archives a configuration store via external API key authentication

Authorizations
api_keystringRequired

API key authentication via query parameter

Path parameters
externalIdstringRequired
Query parameters
api_keystringOptional
Header parameters
X-API-KEYstringOptional
Responses
204

Configuration store archived successfully

No content

delete/configurations/{externalId}/external

No content

Restore Configuration Store (External)

put

Restores an archived configuration store via external API key authentication

Authorizations
api_keystringRequired

API key authentication via query parameter

Path parameters
externalIdstringRequired
Query parameters
api_keystringOptional
Header parameters
X-API-KEYstringOptional
Responses
200

Configuration store restored successfully

*/*
idinteger · int64Optional
workspaceIdinteger · int64Optional
namestringOptional
externalIdstringOptional
archivedAtstring · date-timeOptional
put/configurations/{externalId}/restore/external

Last updated

Was this helpful?