Skip to Content

Settings

12 endpoints

POST /api/v5/artifacts/settings/search

Search Setting

Search settings — composable infra architecture.

Parameters:

NameInRequiredDescription
X-Api-KeyheaderNo
authorizationheaderNo
X-MCPheaderNo

Request body:

`object`

Response:

{ actor_name?: `string` | `null` user_role?: `string` | `null` settings?: `ListSettingApiSetting`[] | `null` keys?: `ListSettingApiKey`[] | `null` }

POST /api/v5/artifacts/settings/get

Get Setting

Get setting information using the canonical shared setting operation.

Parameters:

NameInRequiredDescription
X-Api-KeyheaderNo
authorizationheaderNo
X-MCPheaderNo

Request body:

{ settings_id?: `string` | `null` color_search?: `string` | `null` draft_id?: `string` | `null` mcp?: `boolean` | `null` }

Response:

{ actor_name?: `string` | `null` setting_exists?: `boolean` | `null` can_edit?: `boolean` | `null` disabled_reason?: `string` | `null` draft_version?: `integer` | `null` group_id?: `string` | `null` names?: `SettingNameSection` | `null` descriptions?: `SettingDescriptionSection` | `null` colors?: `SettingColorSection` | `null` flags?: `SettingFlagSection` | `null` departments?: `SettingDepartmentSection` | `null` profiles?: `SettingProfileSection` | `null` auths?: `SettingAuthSection` | `null` provider_keys?: `SettingProviderKeySection` | `null` auth_item_keys?: `SettingAuthItemKeySection` | `null` systems?: `SettingSystemSection` | `null` }

POST /api/v5/artifacts/settings/create

Create Setting

Create settings using composable infra architecture.

Parameters:

NameInRequiredDescription
X-Api-KeyheaderNo
authorizationheaderNo
X-MCPheaderNo

Request body:

{ settings: `CreateSettingItem`[] }

Response:

{ results: `SettingResultItem`[] }

POST /api/v5/artifacts/settings/update

Update Setting

Update settings using composable infra architecture.

Parameters:

NameInRequiredDescription
X-Api-KeyheaderNo
authorizationheaderNo
X-MCPheaderNo

Request body:

{ settings: `UpdateSettingItem`[] }

Response:

{ results: `SettingResultItem`[] }

POST /api/v5/artifacts/settings/duplicate

Duplicate Setting

Duplicate a setting — composable infra architecture.

Parameters:

NameInRequiredDescription
X-Api-KeyheaderNo
authorizationheaderNo
X-MCPheaderNo

Request body:

{ setting_id: `string` }

Response:

{ success: `boolean` setting_id: `string` message: `string` }

POST /api/v5/artifacts/settings/delete

Delete Setting

Bulk delete settings — composable infra architecture.

Parameters:

NameInRequiredDescription
X-Api-KeyheaderNo
authorizationheaderNo
X-MCPheaderNo

Request body:

{ setting_ids: `string`[] }

Response:

{ results: `DeleteSettingResult`[] }

PATCH /api/v5/artifacts/settings/draft

Patch Setting Draft

Patch setting draft — composable infra architecture.

Parameters:

NameInRequiredDescription
X-Api-KeyheaderNo
authorizationheaderNo
X-MCPheaderNo

Request body:

{ input_draft_id?: `string` | `null` expected_version?: `integer` name?: `string` | `null` name_id?: `string` | `null` description?: `string` | `null` description_id?: `string` | `null` flag_id?: `string` | `null` department_ids?: `string`[] | `null` color_ids?: `string`[] | `null` profile_ids?: `string`[] | `null` auth_ids?: `string`[] | `null` provider_key_ids?: `string`[] | `null` auth_item_key_ids?: `string`[] | `null` threshold_ids?: `string`[] | `null` }

Response:

{ success: `boolean` draft_id: `string` new_version: `integer` message: `string` form_state?: `SettingDraftFormState` | `null` }

POST /api/v5/artifacts/settings/drafts

Get Setting Drafts

List setting drafts owned by the current profile.

Parameters:

NameInRequiredDescription
X-Api-KeyheaderNo
authorizationheaderNo
X-MCPheaderNo

Response:

{ entries?: `GetSettingDraftResponse`[] | `null` }

POST /api/v5/artifacts/settings/export

Export Settings

Export all settings as a clean, denormalized CSV.

Parameters:

NameInRequiredDescription
X-Api-KeyheaderNo
authorizationheaderNo
X-MCPheaderNo

Request body:

{ setting_id?: `string` | `null` }

Response:

{ upload_id: `string` file_name: `string` row_count: `integer` }

POST /api/v5/artifacts/settings/docs

Get Setting Docs Endpoint

Get composed documentation for the setting artifact.

Parameters:

NameInRequiredDescription
X-Api-KeyheaderNo
authorizationheaderNo
X-MCPheaderNo

Request body:

{ entity_id?: `string` | `null` }

Response:

{ name: `string` type: `string` description: `string` artifact?: `DocsResponse` | `null` entries: `DocsResponse`[] resources: `DocsResponse`[] permissions: `OperationInfo`[] api_operations: `OperationInfo`[] page_metadata?: `DocsApiResponse` | `null` }

POST /api/v5/artifacts/settings/refresh

Setting Refresh

Refresh setting materialized views and invalidate caches.

Parameters:

NameInRequiredDescription
X-Api-KeyheaderNo
authorizationheaderNo
X-MCPheaderNo

Response:

{ success: `boolean` refreshed_views: `string`[] invalidated_tags: `string`[] }

POST /api/v5/artifacts/settings/decrypt

Decrypt Setting Key

Decrypt a key scoped to a setting artifact.

Parameters:

NameInRequiredDescription
X-Api-KeyheaderNo
authorizationheaderNo
X-MCPheaderNo

Request body:

{ setting_id: `string` key_id: `string` }

Response:

{ key?: `string` | `null` name?: `string` | `null` actor_name?: `string` | `null` }

Last updated on