List Workers

GET

/api/v1/sites

curl --request GET \
  --url https://digize.com/api/v1/sites \
  --header 'x-api-key: <x-api-key>'

• Digize

The workspace’s Workers (sites, APIs, consumers and scheduled jobs) with their status, live version and last 24 hours of traffic.

Needs the sites:read permission.

Authorizations

• apiKey
• bearer

Responses

200

Done

Media typeapplication/json

Array<object>

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

object

id

required

string

version

required

number

status

required

string

Allowed values: queued building deploying live failed superseded

createdAt

required

string format: date-time

null

null

requests

required

number

errors

required

number

cpuTime

required

number

bindingCount

required

number

consumes

required

Array<string>

Example

[
  {
    "kind": "site",
    "status": "live",
    "lastDeployment": {
      "status": "queued"
    }
  }
]

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

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

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

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"
  }
}

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"
  }
}