Skip to main content
PUT
/
deploymentStage
/
{deploymentStageId}
Edit deployment stage
curl --request PUT \
  --url https://api.qovery.com/deploymentStage/{deploymentStageId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "environment": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "updated_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "description": "<string>",
  "deployment_order": 1,
  "services": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "service_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "service_type": "<string>",
      "is_skipped": true
    }
  ]
}

Authorizations

​
Authorization
string
header
required

JWT tokens should be used with OIDC account (human to machine). JWT tokens used by the Qovery console to communicate with the API have a TTL. Curl Example ' curl https://console.qovery.com/organization -H "Authorization: Bearer $qovery_token" '

Path Parameters

​
deploymentStageId
string<uuid>
required

Deployment Stage ID

Body

application/json
​
name
string
required

The name of the deployment stage

​
description
string | null

free test describing this stage

Response

created deployment stage

​
id
string<uuid>
required
read-only
​
created_at
string<date-time>
required
read-only
​
environment
object
required
​
updated_at
string<date-time>
read-only
​
name
string

name is case insensitive

​
description
string
​
deployment_order
integer

Position of the deployment stage within the environment

Example:

1

​
services
object[]