Skip to content
digizeDocs

Change a Worker's settings

PATCH
/api/v1/sites/{site}
curl --request PATCH \
  --url https://digize.com/api/v1/sites/example \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: 5f1c2a8e-3b7d-4c55-9a0e-1f2d3c4b5a69' \
  --header 'x-api-key: <x-api-key>' \
  --data '{ "description": "example", "vars": { "additionalProperty": "example" }, "compatibilityDate": "example", "compatibilityFlags": [ "example" ], "placement": "default", "branch": "example", "buildOnPush": true, "buildCommand": "example", "outputDir": "example", "rootDir": "example", "installCommand": "example", "nodeVersion": "example" }'

Changes a Worker’s description, plain variables, compatibility date and flags, placement, branch, builds on push, or build and output settings. Runtime changes apply at the next deploy.

Needs the sites:write permission.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
site
required
string
>= 1 characters <= 64 characters

Header Parameters

Section titled “Header Parameters”
Idempotency-Key
string
>= 1 characters <= 255 characters

Makes the request safe to send again: for 24 hours the same key and request answer the first response without repeating the change.

Example 

5f1c2a8e-3b7d-4c55-9a0e-1f2d3c4b5a69

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
description
string
<= 200 characters
vars
object
key
additional properties
string
compatibilityDate
string
compatibilityFlags
Array<string>
placement
string
Allowed values: default smart
branch
string
buildOnPush
boolean
buildCommand
string
outputDir
string
rootDir
string
installCommand
string
nodeVersion
string

Responses

Section titled “Responses”

200

Section titled “200”

Done

Media typeapplication/json
object
id
required
string
name
required
string
kind
required
string
Allowed values: site api consumer scheduled
description
required
string
hostnames
required
Array<string>
routes
required
Array<string>
crons
required
Array<string>
createdAt
required
string format: date-time
scriptName
required
string
gitRemote
required
string
platformHostname
required
string | null
mainHostname
required
string | null
status
required
string
Allowed values: live deploying not_deployed
liveVersion
required
number | null
lastDeployment
required
Any of:
object
id
required
string
version
required
number
status
required
string
Allowed values: queued building deploying live failed superseded
createdAt
required
string format: date-time
requests
required
number
errors
required
number
cpuTime
required
number
bindingCount
required
number
consumes
required
Array<string>
settings
required
object
vars
required
object
key
additional properties
string
secrets
required
Array<string>
compatibilityDate
required
string
compatibilityFlags
required
Array<string>
placement
required
string
Allowed values: default smart
branch
required
string
buildOnPush
required
boolean
buildCommand
required
string
outputDir
required
string | null
rootDir
required
string | null
installCommand
required
string | null
nodeVersion
required
string | null
bindings
required
Array<object>
object
id
required
string | null
worker
required
string
type
required
string
Allowed values: d1 r2 kv queue_producer queue_consumer
variable
required
string | null
resource
required
string
consumers
required
Array<object>
object
worker
required
string
queue
required
string
batchSize
required
number
maxWaitSeconds
required
number
maxRetries
required
number
deadLetterQueue
required
string | null
domains
required
Array<object>
object
id
required
string
hostname
required
string
worker
required
string | null
kind
required
string
Allowed values: custom platform
setup
required
Any of:
string
Allowed values: full hostname
status
required
string
Allowed values: active pending_dns verifying failed
certificate
required
string
Allowed values: active issuing waiting failed
primary
required
boolean
redirectsTo
required
string | null
records
required
Array<object>
object
type
required
string
Allowed values: CNAME TXT MX
name
required
string
value
required
string
priority
number
status
required
string
Allowed values: found missing mismatch
purpose
required
string
optional
boolean
nameservers
required
Array<string>
error
required
string | null
addedAt
required
string format: date-time
verifiedAt
required
Any of:
string format: date-time
checkedAt
required
string format: date-time
traffic
required
Array<object>
object
at
required
string format: date-time
requests
required
number
errors
required
number
cpuMedian
required
number
cpuP99
required
number
previous
required
object
requests
required
number
errors
required
number
cpuTime
required
number
recentDeployments
required
Array<object>
object
id
required
string
siteId
required
string
worker
required
string
version
required
number
status
required
string
Allowed values: queued building deploying live failed superseded
kind
required
string
Allowed values: push manual redeploy rollback
commit
required
object
sha
required
string
message
required
string
author
required
string
branch
required
string
requestedBy
required
string | null
createdAt
required
string format: date-time
startedAt
required
Any of:
string format: date-time
finishedAt
required
Any of:
string format: date-time
duration
required
number | null
error
required
string | null
failedStage
required
Any of:
string
Allowed values: build deploy
canRedeploy
required
boolean
analytics
required
boolean

Example 

{
  "kind": "site",
  "status": "live",
  "lastDeployment": {
    "status": "queued"
  },
  "settings": {
    "placement": "default"
  },
  "bindings": [
    {
      "type": "d1"
    }
  ],
  "domains": [
    {
      "kind": "custom",
      "setup": "full",
      "status": "active",
      "certificate": "active",
      "records": [
        {
          "type": "CNAME",
          "status": "found"
        }
      ]
    }
  ],
  "recentDeployments": [
    {
      "status": "queued",
      "kind": "push",
      "failedStage": "build"
    }
  ]
}

400

Section titled “400”

What was sent isn’t valid (invalid).

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

401

Section titled “401”

No key, or one that’s unknown, off or expired.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

403

Section titled “403”

The key doesn’t have the permission this needs.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

404

Section titled “404”

Nothing has that id (not_found).

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

409

Section titled “409”

A request with the same Idempotency-Key is still running (conflict).

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

422

Section titled “422”

The Idempotency-Key was used with a different request.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

429

Section titled “429”

Over the rate limit; see retry-after.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}