Create a terraform deployment restriction

Create a terraform deployment restriction

POST /terraform/{terraformId}/deploymentRestriction

Create a terraform deployment restriction

cURL

curl --request POST \
  --url https://api.qovery.com/terraform/{terraformId}/deploymentRestriction \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "mode": "MATCH",
  "type": "PATH",
  "value": "<string>"
}
'

201

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "mode": "MATCH",
  "type": "PATH",
  "value": "<string>",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

bearerAuthApiKeyAuth

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

terraformId · string · required

Body

application/json

mode · enum<string> · required

Match mode will rebuild app only if specified items are updated. Exclude mode will not rebuild app if specified items are updated.

Available options: EXCLUDE, MATCH

Example:

"MATCH"

type · enum<string> · required

Available options: PATH

Example:

"PATH"

value · string · required

‘For PATH restrictions, the value must not start with /’

Response

201

application/json

Added an terraform deployment restriction

id · string<uuid> · required · read-only

created_at · string<date-time> · required · read-only

mode · enum<string> · required

Match mode will rebuild app only if specified items are updated. Exclude mode will not rebuild app if specified items are updated.

Available options: EXCLUDE, MATCH

Example:

"MATCH"

type · enum<string> · required

Available options: PATH

Example:

"PATH"

value · string · required

‘For PATH restrictions, the value must not start with /’

updated_at · string<date-time> · read-only