curl --request PUT \
--url https://api.example.com/api/deployments/{deploymentId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"configuration": "<unknown>",
"updateSecrets": false,
"secrets": "<unknown>"
}
'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"provider": "aws_s3",
"organisationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organisation": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"displayName": "<string>",
"onboarded": true,
"themeLogo": "<string>",
"themePrimaryColor": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"license": "<string>",
"licenseData": "<unknown>",
"url": "<string>",
"preferences": "<unknown>",
"deletedAt": "<string>"
},
"createdAt": "<string>",
"updatedAt": "<string>",
"description": "<string>",
"configuration": "<unknown>",
"deletedAt": "<string>"
}Update an existing deployment configuration by its ID.
curl --request PUT \
--url https://api.example.com/api/deployments/{deploymentId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"configuration": "<unknown>",
"updateSecrets": false,
"secrets": "<unknown>"
}
'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"provider": "aws_s3",
"organisationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organisation": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"displayName": "<string>",
"onboarded": true,
"themeLogo": "<string>",
"themePrimaryColor": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"license": "<string>",
"licenseData": "<unknown>",
"url": "<string>",
"preferences": "<unknown>",
"deletedAt": "<string>"
},
"createdAt": "<string>",
"updatedAt": "<string>",
"description": "<string>",
"configuration": "<unknown>",
"deletedAt": "<string>"
}Unique identifier of the deployment to update
The updated deployment
The updated deployment
Unique identifier of the deployment
Name of the deployment
Cloud storage provider type (aws_s3, azure_storage, google_cloud_storage)
aws_s3, azure_storage, google_cloud_storage ID of the organisation this deployment belongs to
Organisation associated with the deployment
Show child attributes
Timestamp when the deployment was created
Timestamp when the deployment was last updated
Description of the deployment
Provider-specific configuration settings
Timestamp when the deployment was deleted
Was this page helpful?