Sign in

v1

latestOpenAPI 3.1.02026-07-26289714404.6 KB
Configuration

Create or update variable

post/configuration

Request body

namestring required
valuestring
idstring

The ID of the configuration property. If provided, will act as an update. Otherwise, a new configuration property will be created.

isSensitiveboolean
isReadonlyboolean
isRequiredboolean
regexstring
scopeIdstring

The ID of the entity of the provided scope. e.g. a project's ID when the provided scope is PROJECT. Inapplicable for GLOBAL scope, as it has no specific entity.

scope'SET' | 'GLOBAL' | 'BLUEPRINT' | 'SUB_ENVIRONMENT_BLUEPRINT' | 'PROJECT' | 'WORKFLOW' | 'ENVIRONMENT' | 'DEPLOYMENT' | 'SET' | 'GLOBAL' | 'BLUEPRINT' | 'SUB_ENVIRONMENT_BLUEPRINT' | 'PROJECT' | 'WORKFLOW' | 'ENVIRONMENT' | 'DEPLOYMENT' | 'SET' | 'GLOBAL' | 'BLUEPRINT' | 'SUB_ENVIRONMENT_BLUEPRINT' | 'PROJECT' | 'WORKFLOW' | 'ENVIRONMENT' | 'DEPLOYMENT' | 'SET' | 'GLOBAL' | 'BLUEPRINT' | 'SUB_ENVIRONMENT_BLUEPRINT' | 'PROJECT' | 'WORKFLOW' | 'ENVIRONMENT' | 'DEPLOYMENT' | 'SET' | 'GLOBAL' | 'BLUEPRINT' | 'SUB_ENVIRONMENT_BLUEPRINT' | 'PROJECT' | 'WORKFLOW' | 'ENVIRONMENT' | 'DEPLOYMENT' required
type0 | 1 | 0 | 1 | 0 | 1 | 0 | 1 | 0 | 1 required
toDeleteboolean
projectIdstring
organizationIdstring required
descriptionstring
isOutputboolean

Response

createdAtstring date-time
updatedAtstring date-time
namestring
valuestring
idstring

The ID of the configuration property. If provided, will act as an update. Otherwise, a new configuration property will be created.

userIdstring
isSensitiveboolean
isReadonlyboolean
isRequiredboolean
regexstring
scopeIdstring

The ID of the entity of the provided scope. e.g. a project's ID when the provided scope is PROJECT. Inapplicable for GLOBAL scope, as it has no specific entity.

scope'SET' | 'GLOBAL' | 'BLUEPRINT' | 'SUB_ENVIRONMENT_BLUEPRINT' | 'PROJECT' | 'WORKFLOW' | 'ENVIRONMENT' | 'DEPLOYMENT' | 'SET' | 'GLOBAL' | 'BLUEPRINT' | 'SUB_ENVIRONMENT_BLUEPRINT' | 'PROJECT' | 'WORKFLOW' | 'ENVIRONMENT' | 'DEPLOYMENT' | 'SET' | 'GLOBAL' | 'BLUEPRINT' | 'SUB_ENVIRONMENT_BLUEPRINT' | 'PROJECT' | 'WORKFLOW' | 'ENVIRONMENT' | 'DEPLOYMENT' | 'SET' | 'GLOBAL' | 'BLUEPRINT' | 'SUB_ENVIRONMENT_BLUEPRINT' | 'PROJECT' | 'WORKFLOW' | 'ENVIRONMENT' | 'DEPLOYMENT' | 'SET' | 'GLOBAL' | 'BLUEPRINT' | 'SUB_ENVIRONMENT_BLUEPRINT' | 'PROJECT' | 'WORKFLOW' | 'ENVIRONMENT' | 'DEPLOYMENT'
type0 | 1 | 0 | 1 | 0 | 1 | 0 | 1 | 0 | 1
projectIdstring
organizationIdstring
descriptionstring
isOutputboolean