v1

latestOpenAPI 3.1.02026-07-261344388.3 KB

Deployments

Update deployment

Update an existing deployment configuration by its ID.

put/api/deployments/{deploymentId}

Path parameters

deploymentIdstring uuid required

Unique identifier of the deployment to update

Request body

namestring required

Name of the deployment

descriptionstring nullable

Description of the deployment

{"stackTrail":"paths:/api/deployments/{deploymentId}:put:requestBody:content:application/json:schema:properties:configuration","oasType":"schema","type":"unknown","description":"Provider-specific configuration settings"}

updateSecretsboolean

Whether to update the secrets

{"stackTrail":"paths:/api/deployments/{deploymentId}:put:requestBody:content:application/json:schema:properties:secrets","oasType":"schema","type":"unknown","description":"Provider-specific secrets (e.g., access keys, credentials)","nullable":true}

Response

The updated deployment

idstring uuid required

Unique identifier of the deployment

namestring required

Name of the deployment

descriptionstring

Description of the deployment

provider'aws_s3' | 'azure_storage' | 'google_cloud_storage' required

Cloud storage provider type (aws_s3, azure_storage, google_cloud_storage)

{"stackTrail":"paths:/api/deployments/{deploymentId}:put:responses:200:content:application/json:schema:properties:configuration","oasType":"schema","type":"unknown","description":"Provider-specific configuration settings"}

organisationIdstring uuid required

ID of the organisation this deployment belongs to

createdAtstring required

Timestamp when the deployment was created

updatedAtstring required

Timestamp when the deployment was last updated

deletedAtstring

Timestamp when the deployment was deleted