Deployments

Update deployment

Update an existing deployment configuration by its ID.

put/api/deployments/{deploymentId}

Request

The document declares no server URL.
Auth
HTTP internal
TypeScript
https://skmtc.dev/gorules/apis/gorules-agent-api/docs/api/deployments/:deploymentId/put.ts
A function with typed inputs. Its response is checked against the schema.

deploymentIdstring uuid required

Unique identifier of the deployment to update

namestring required

Name of the deployment

descriptionstring nullable

Description of the deployment

configurationunknown

updateSecretsboolean

Whether to update the secrets

secretsunknown

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)

configurationunknown

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

No recorded changes to this operation across all 1 revision of this API.