Skip to content
Press.js Press.js Press.js Docs

Update deploy settings

PATCH
/v1/deploys/{deployId}/settings
 
curl --request PATCH \
  --url https://api.presscloud.example/v1/deploys/example/settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "webhook": { "enabled": true, "signingSecretAction": "disable", "url": "https://example.com" }, "versionLifecycle": { "enabled": true, "retainLatestVersions": 1 }, "environment": { "variables": [ { "name": "example", "value": "example" } ] }, "secrets": { "upsert": [ { "name": "example", "value": "example" } ], "delete": [ "example" ] } }'

Updates deploy-level webhook, version lifecycle, environment, and deploy secret settings. Deploy secret values are write-only and are never returned.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
deployId
required
string
>= 1 characters

Request Body required

Section titled “Request Body required ”
Media type application/json
Any of:
object
webhook
required
object
enabled
required
boolean
signingSecretConfigured

Whether a signing secret is configured for this webhook.

boolean
signingSecretPreview

Masked preview of the configured signing secret, for example whsec******.

string
signingSecretAction

Staged deploy-level webhook signing secret action applied when deploy settings are saved.

string
Allowed values: disable rotate
url
string format: uri
>= 1 characters
versionLifecycle
object
enabled
required
boolean
retainLatestVersions
required
integer
>= 1
environment
object
variables
required
Array<object>
<= 100 items
object
name
required
string
/^[A-Za-z_][A-Za-z0-9_]*$/
value
required
string
secrets
Any of:
object
upsert
required
Array<object>
<= 100 items
object
name
required
string
/^[A-Za-z_][A-Za-z0-9_]*$/
value
required
string
delete
Array<string>
<= 100 items

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Deploy settings updated.

Media type application/json
object
settings
required
object
deployId
required
string
webhook
required
object
enabled
required
boolean
signingSecretConfigured

Whether a signing secret is configured for this webhook.

boolean
signingSecretPreview

Masked preview of the configured signing secret, for example whsec******.

string
signingSecretAction

Staged deploy-level webhook signing secret action applied when deploy settings are saved.

string
Allowed values: disable rotate
url
string format: uri
>= 1 characters
versionLifecycle
required
object
enabled
required
boolean
retainLatestVersions
required
integer
>= 1
environment
required
object
variables
required
Array<object>
object
deployId
required
string
name
required
string
/^[A-Za-z_][A-Za-z0-9_]*$/
value
required
string
createdAt
required
integer
updatedAt
required
integer
secrets
required
object
items
required
Array<object>
object
deployId
required
string
name
required
string
/^[A-Za-z_][A-Za-z0-9_]*$/
createdAt
required
integer
updatedAt
required
integer
Example 
{
  "settings": {
    "webhook": {
      "signingSecretAction": "disable"
    }
  }
}

400

Section titled “400 ”

Invalid request payload or parameters.

Media type application/json
object
error
required
string
message
required
string
Example generated
{
  "error": "example",
  "message": "example"
}

404

Section titled “404 ”

Requested resource was not found.

Media type application/json
object
error
required
string
message
required
string
Example generated
{
  "error": "example",
  "message": "example"
}