API reference · 1.0.0

Monitors 7 endpoints

List monitors

GET/api/v1/workspaces/{workspaceId}/monitors

Returns monitors in descending creation order with an opaque continuation cursor. targetHost is a privacy-safe projection; the full target and heartbeat URL are never returned.

Required scopemonitors:readAuthentication

Path parameters

workspaceIdintegerrequired

Numeric workspace ID. Use the workspace shown in credential management; credentials cannot cross workspace boundaries.

example 42 · min 1

Query parameters

limitintegeroptional

Maximum items in the page (1–100; default 50). Pages use stable descending order.

example 50 · default 50 · min 1 · max 100

cursorstringoptional

Opaque cursor copied from the previous response's nextCursor. Omit it on the first page; do not construct or edit cursor values.

example "eyJU..." · min length 1

Responses

Select a status to view its fields and example.

Success

Client errors

Server errors

200 OK

A page of monitor projections.

Response fields

valueobject · no additional fields

itemsrequired · array

items[]object · no additional fields

items[].idrequired · string Opaque monitor slug.

items[].namerequired · string

items[].descriptionrequired · string | null · nullable

items[].typerequired · string · one of "http", "keyword", "ping", "port", "heartbeat"

items[].targetHostrequired · string | null · nullable Safe host projection only. The full target URL and heartbeat secret are omitted.

items[].keywordrequired · string | null · nullable Always null in this privacy-filtered read projection.

items[].portrequired · integer | null · nullable

items[].intervalSecondsrequired · integer

items[].timeoutSecondsrequired · integer

items[].failureThresholdrequired · integer

items[].recoveryThresholdrequired · integer

items[].expectedIntervalSecondsrequired · integer | null · nullable

items[].gracePeriodSecondsrequired · integer | null · nullable

items[].isActiverequired · boolean

items[].healthStatusrequired · string · one of "paused", "down", "operational", "unknown"

items[].lastCheckedAtrequired · string | null · date-time · nullable

items[].createdAtrequired · string · date-time

items[].updatedAtrequired · string · date-time

items[].versionrequired · integer · min 1

items[].applicationUrlrequired · string | null · uri · nullable Configured application origin plus the canonical resource path; null when no valid origin is configured.

nextCursorrequired · string | null · nullable

Structured error codes

invalid_page_limit
invalid_page_cursor
resource_not_found
invalid_api_credential
insufficient_scope
workspace_access_denied
customer_membership_ambiguous
rate_limit_exceeded

Request example

Request · cURL

curl --request GET \
  --url "https://app.driftro.se/api/v1/workspaces/$WORKSPACE_ID/monitors" \
  --header "Authorization: Bearer $DRIFTRO_API_TOKEN" \
  --header "Accept: application/json"

Bash / cURL. Set the token and resource variables before running.

Response example

Response status

A page of monitor projections.

Example response · application/json

{
  "items": [
    {
      "id": "abc123monitor",
      "name": "Primary website",
      "description": "Public availability check",
      "type": "http",
      "targetHost": "example.test",
      "keyword": null,
      "port": null,
      "intervalSeconds": 60,
      "timeoutSeconds": 10,
      "failureThreshold": 3,
      "recoveryThreshold": 2,
      "expectedIntervalSeconds": null,
      "gracePeriodSeconds": null,
      "isActive": true,
      "healthStatus": "operational",
      "lastCheckedAt": "2026-10-18T12:00:00Z",
      "createdAt": "2026-10-01T12:00:00Z",
      "updatedAt": "2026-10-18T12:00:00Z",
      "version": 4,
      "applicationUrl": "https://app.example.test/monitors/abc123monitor"
    }
  ],
  "nextCursor": null
}

Invalid pagination, idempotency header, or expected version.

Example response · application/json

{
  "error": {
    "code": "invalid_page_limit",
    "message": "limit must be between 1 and 100.",
    "requestId": "00-00000000000000000000000000000000-0000000000000000-00",
    "details": null
  }
}

Missing, malformed, revoked, expired, or otherwise invalid API credential.

Example response · application/json

{
  "error": {
    "code": "invalid_api_credential",
    "message": "A valid API credential is required.",
    "requestId": "00-00000000000000000000000000000000-0000000000000000-00"
  }
}

Required scope is missing, workspace does not match, or current role/capability denies this operation.

Example response · application/json

{
  "error": {
    "code": "insufficient_scope",
    "message": "The 'monitors:read' scope is required.",
    "requestId": "00-00000000000000000000000000000000-0000000000000000-00"
  }
}

Legacy customer membership state is ambiguous and needs operator resolution.

Example response · application/json

{
  "error": {
    "code": "customer_membership_ambiguous",
    "message": "Contact support to resolve legacy customer memberships.",
    "requestId": "00-00000000000000000000000000000000-00000000000000000000000000000000-00"
  }
}

Read/write rate limit exceeded. Retry after the number of seconds in Retry-After and error.details.retryAfterSeconds.

Example response · application/json

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "The API request limit has been exceeded.",
    "requestId": "00-00000000000000000000000000000000-0000000000000000-00",
    "details": {
      "retryAfterSeconds": 27
    }
  }
}

Unexpected server or stored-response restoration failure. Include requestId when contacting support; do not retry a write with a new key until you have checked its receipt.

Example response · application/json

{
  "error": {
    "code": "receipt_unavailable",
    "message": "The stored response could not be restored.",
    "requestId": "00-00000000000000000000000000000000-0000000000000000-00"
  }
}

Create a monitor

POST/api/v1/workspaces/{workspaceId}/monitors

Creates an HTTP, keyword, ping, or port monitor and returns its privacy-filtered projection. isActive is optional and defaults to true; set it to false to create a paused monitor atomically with no scheduled check. Heartbeat creation is rejected with heartbeat_creation_not_supported; create heartbeat monitors in the browser to display the one-time ping URL safely. The operation writes monitor configuration and an audit record only. Later worker-observed downtime or recovery can create incidents and notifications under the existing routing policy. Requires a UUID Idempotency-Key; the response envelope is retained for 24 hours and the key tombstone for 30 days.

Required scopemonitors:writeAuthentication

Path parameters

workspaceIdintegerrequired

Numeric workspace ID. Use the workspace shown in credential management; credentials cannot cross workspace boundaries.

example 42 · min 1

Header parameters

Idempotency-Keystringrequired

One canonical, non-empty UUID per logical write. Reuse the same key only to retry the exact same request. Successful write response is replayed for 24 hours; expired key tombstone prevents re-use for 30 days.

example "00000000-0000-4000-8000-000000000001" · uuid · pattern ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$

Request body

Request fields

valueobject · no additional fields · Combines 4 schema requirements.

namerequired · string · min length 1 · max length 200

descriptionstring | null · nullable · max length 1000 On update, null clears the current description.

typerequired · string · one of "http", "keyword", "ping", "port", "heartbeat" Create supports http, keyword, ping, and port. Existing heartbeat monitors can be read, updated, paused, and resumed; heartbeat creation returns 422. Updates must provide the type-specific configuration fields.

targetrequired · string | null · nullable · max length 2048 Required and non-null for http, keyword, ping, and port; null is used for heartbeat configuration. HTTP(S) URL for http/keyword; public host for ping/port. It is never returned in monitor projections.

keywordstring | null · nullable · max length 500

portHoststring | null · nullable · max length 255

portinteger | null · nullable · min 1 · max 65535

intervalSecondsrequired · integer · min 1 Must meet the workspace plan minimum.

timeoutSecondsrequired · integer · min 3 Must not exceed the workspace plan maximum.

failureThresholdrequired · integer · min 1 · max 10

recoveryThresholdrequired · integer · min 1 · max 10

expectedIntervalSecondsinteger | null · nullable · min 10 · max 2592000

gracePeriodSecondsinteger | null · nullable · min 0 · max 604800

expectedVersioninteger | null · nullable · min 1 Required for update; omitted for create.

isActiveboolean | null · nullable Create only; omitted defaults to true. On update, use the pause or resume operation instead.

Conditional fieldsWhen type = "keyword" and has type, this shape requires keyword.

Conditional fieldsWhen type = "port" and has type, this shape requires portHost, port.

Conditional fieldsWhen type = "heartbeat" and has type, this shape requires expectedIntervalSeconds, gracePeriodSeconds.

Conditional fieldsWhen not (type = "heartbeat" and has type), this shape requires target.

Responses

Select a status to view its fields and example.

Success

Client errors

Server errors

201 Created

Monitor created. Location points to the created monitor.

Response headers

Location: string · Relative URL of the created monitor.

Response fields

valueobject · no additional fields

datarequired · object · no additional fields

data.idrequired · string Opaque monitor slug.

data.namerequired · string

data.descriptionrequired · string | null · nullable

data.typerequired · string · one of "http", "keyword", "ping", "port", "heartbeat"

data.targetHostrequired · string | null · nullable Safe host projection only. The full target URL and heartbeat secret are omitted.

data.keywordrequired · string | null · nullable Always null in this privacy-filtered read projection.

data.portrequired · integer | null · nullable

data.intervalSecondsrequired · integer

data.timeoutSecondsrequired · integer

data.failureThresholdrequired · integer

data.recoveryThresholdrequired · integer

data.expectedIntervalSecondsrequired · integer | null · nullable

data.gracePeriodSecondsrequired · integer | null · nullable

data.isActiverequired · boolean

data.healthStatusrequired · string · one of "paused", "down", "operational", "unknown"

data.lastCheckedAtrequired · string | null · date-time · nullable

data.createdAtrequired · string · date-time

data.updatedAtrequired · string · date-time

data.versionrequired · integer · min 1

data.applicationUrlrequired · string | null · uri · nullable Configured application origin plus the canonical resource path; null when no valid origin is configured.

receiptrequired · object · no additional fields

receipt.idempotencyKeyrequired · string · uuid

receipt.replayedrequired · boolean

receipt.createdAtrequired · string · date-time

receipt.expiresAtrequired · string · date-time

receipt.statusCoderequired · integer

receipt.resourceTyperequired · string · one of "monitor", "incident", "maintenance"

receipt.resourceIdrequired · string

Structured error codes

incomplete_monitor_configuration
invalid_monitor_name
invalid_monitor_description
invalid_monitor_type
invalid_monitor_interval
invalid_monitor_timeout
invalid_monitor_threshold
invalid_monitor_target
invalid_monitor_keyword
invalid_monitor_port
ping_disabled
unsafe_monitor_target
heartbeat_creation_not_supported
usage_limit_exceeded
workspace_not_found
invalid_request_body
invalid_api_credential
insufficient_scope
workspace_access_denied
customer_membership_ambiguous
rate_limit_exceeded
invalid_idempotency_key
idempotency_key_expired
idempotency_key_reused
receipt_unavailable

Request example

Request · cURL

curl --request POST \
  --url "https://app.driftro.se/api/v1/workspaces/$WORKSPACE_ID/monitors" \
  --header "Authorization: Bearer $DRIFTRO_API_TOKEN" \
  --header "Accept: application/json" \
  --header "Idempotency-Key: $IDEMPOTENCY_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "name": "Primary website",
  "description": "Public availability check",
  "type": "http",
  "target": "https://example.test/health",
  "intervalSeconds": 60,
  "timeoutSeconds": 10,
  "failureThreshold": 3,
  "recoveryThreshold": 2,
  "isActive": false
}'

Bash / cURL. Set the token and resource variables before running. Use a new UUID for each intended write; reuse it only for an identical retry. Adapt the example body to your workspace.

Response example

Response status

Monitor created. Location points to the created monitor.

Example response · application/json

{
  "data": {
    "id": "abc123monitor",
    "name": "Primary website",
    "description": "Public availability check",
    "type": "http",
    "targetHost": "example.test",
    "keyword": null,
    "port": null,
    "intervalSeconds": 60,
    "timeoutSeconds": 10,
    "failureThreshold": 3,
    "recoveryThreshold": 2,
    "expectedIntervalSeconds": null,
    "gracePeriodSeconds": null,
    "isActive": false,
    "healthStatus": "unknown",
    "lastCheckedAt": null,
    "createdAt": "2026-10-18T12:00:00Z",
    "updatedAt": "2026-10-18T12:00:00Z",
    "version": 1,
    "applicationUrl": "https://app.example.test/monitors/abc123monitor"
  },
  "receipt": {
    "idempotencyKey": "00000000-0000-4000-8000-000000000001",
    "replayed": false,
    "createdAt": "2026-10-18T12:00:00Z",
    "expiresAt": "2026-10-19T12:00:00Z",
    "statusCode": 201,
    "resourceType": "monitor",
    "resourceId": "abc123monitor"
  }
}

Invalid pagination, idempotency header, or expected version.

Example response · application/json

{
  "error": {
    "code": "invalid_page_limit",
    "message": "limit must be between 1 and 100.",
    "requestId": "00-00000000000000000000000000000000-0000000000000000-00",
    "details": null
  }
}

Missing, malformed, revoked, expired, or otherwise invalid API credential.

Example response · application/json

{
  "error": {
    "code": "invalid_api_credential",
    "message": "A valid API credential is required.",
    "requestId": "00-00000000000000000000000000000000-0000000000000000-00"
  }
}

Required scope is missing, workspace does not match, or current role/capability denies this operation.

Example response · application/json

{
  "error": {
    "code": "insufficient_scope",
    "message": "The 'monitors:read' scope is required.",
    "requestId": "00-00000000000000000000000000000000-0000000000000000-00"
  }
}

Version conflict, quota limit, idempotency-key conflict/expiry, or inactive incident response.

Example response · application/json

{
  "error": {
    "code": "monitor_version_conflict",
    "message": "The monitor version is stale.",
    "requestId": "00-00000000000000000000000000000000-0000000000000000-00",
    "details": {
      "currentVersion": 5
    }
  }
}

Invalid JSON body binding or domain validation failed. Body binding errors include field details.

Invalid JSON request body · application/json

{
  "error": {
    "code": "invalid_request_body",
    "message": "The JSON request body is invalid.",
    "requestId": "00-00000000000000000000000000000000-0000000000000000-00",
    "details": {
      "fields": {
        "expectedVersion": [
          "The value is invalid."
        ]
      }
    }
  }
}

Monitor field validation

fieldValidation · application/json

{
  "error": {
    "code": "invalid_monitor_target",
    "message": "target is required.",
    "requestId": "00-00000000000000000000000000000000-0000000000000000-00"
  }
}

Read/write rate limit exceeded. Retry after the number of seconds in Retry-After and error.details.retryAfterSeconds.

Example response · application/json

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "The API request limit has been exceeded.",
    "requestId": "00-00000000000000000000000000000000-0000000000000000-00",
    "details": {
      "retryAfterSeconds": 27
    }
  }
}

Unexpected server or stored-response restoration failure. Include requestId when contacting support; do not retry a write with a new key until you have checked its receipt.

Example response · application/json

{
  "error": {
    "code": "receipt_unavailable",
    "message": "The stored response could not be restored.",
    "requestId": "00-00000000000000000000000000000000-0000000000000000-00"
  }
}

Get a monitor

GET/api/v1/workspaces/{workspaceId}/monitors/{monitorId}

Returns one monitor by its opaque slug ID. Full targets, secrets, and keyword values are omitted. A heartbeat returns its expected interval and grace period, but not its ping URL.

Required scopemonitors:readAuthentication

Path parameters

workspaceIdintegerrequired

Numeric workspace ID. Use the workspace shown in credential management; credentials cannot cross workspace boundaries.

example 42 · min 1

monitorIdstringrequired

Existing opaque monitor slug ID, such as abc123monitor.

example "abc123monitor" · min length 1

Responses

Select a status to view its fields and example.

Success

Client errors

Server errors

200 OK

Monitor projection.

Response fields

valueobject · no additional fields

idrequired · string Opaque monitor slug.

namerequired · string

descriptionrequired · string | null · nullable

typerequired · string · one of "http", "keyword", "ping", "port", "heartbeat"

targetHostrequired · string | null · nullable Safe host projection only. The full target URL and heartbeat secret are omitted.

keywordrequired · string | null · nullable Always null in this privacy-filtered read projection.

portrequired · integer | null · nullable

intervalSecondsrequired · integer

timeoutSecondsrequired · integer

failureThresholdrequired · integer

recoveryThresholdrequired · integer

expectedIntervalSecondsrequired · integer | null · nullable

gracePeriodSecondsrequired · integer | null · nullable

isActiverequired · boolean

healthStatusrequired · string · one of "paused", "down", "operational", "unknown"

lastCheckedAtrequired · string | null · date-time · nullable

createdAtrequired · string · date-time

updatedAtrequired · string · date-time

versionrequired · integer · min 1

applicationUrlrequired · string | null · uri · nullable Configured application origin plus the canonical resource path; null when no valid origin is configured.

Structured error codes

invalid_page_limit
invalid_page_cursor
resource_not_found
invalid_api_credential
insufficient_scope
workspace_access_denied
customer_membership_ambiguous
rate_limit_exceeded

Request example

Request · cURL

curl --request GET \
  --url "https://app.driftro.se/api/v1/workspaces/$WORKSPACE_ID/monitors/$MONITOR_ID" \
  --header "Authorization: Bearer $DRIFTRO_API_TOKEN" \
  --header "Accept: application/json"

Bash / cURL. Set the token and resource variables before running.

Response example

Response status

Monitor projection.

Example response · application/json

{
  "id": "abc123monitor",
  "name": "Primary website",
  "description": "Public availability check",
  "type": "http",
  "targetHost": "example.test",
  "keyword": null,
  "port": null,
  "intervalSeconds": 60,
  "timeoutSeconds": 10,
  "failureThreshold": 3,
  "recoveryThreshold": 2,
  "expectedIntervalSeconds": null,
  "gracePeriodSeconds": null,
  "isActive": true,
  "healthStatus": "operational",
  "lastCheckedAt": "2026-10-18T12:00:00Z",
  "createdAt": "2026-10-01T12:00:00Z",
  "updatedAt": "2026-10-18T12:00:00Z",
  "version": 4,
  "applicationUrl": "https://app.example.test/monitors/abc123monitor"
}

Missing, malformed, revoked, expired, or otherwise invalid API credential.

Example response · application/json

{
  "error": {
    "code": "invalid_api_credential",
    "message": "A valid API credential is required.",
    "requestId": "00-00000000000000000000000000000000-0000000000000000-00"
  }
}

Required scope is missing, workspace does not match, or current role/capability denies this operation.

Example response · application/json

{
  "error": {
    "code": "insufficient_scope",
    "message": "The 'monitors:read' scope is required.",
    "requestId": "00-00000000000000000000000000000000-0000000000000000-00"
  }
}

Workspace or resource is not visible in the authenticated workspace.

Example response · application/json

{
  "error": {
    "code": "resource_not_found",
    "message": "The requested resource was not found.",
    "requestId": "00-00000000000000000000000000000000-0000000000000000-00"
  }
}

Legacy customer membership state is ambiguous and needs operator resolution.

Example response · application/json

{
  "error": {
    "code": "customer_membership_ambiguous",
    "message": "Contact support to resolve legacy customer memberships.",
    "requestId": "00-00000000000000000000000000000000-00000000000000000000000000000000-00"
  }
}

Read/write rate limit exceeded. Retry after the number of seconds in Retry-After and error.details.retryAfterSeconds.

Example response · application/json

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "The API request limit has been exceeded.",
    "requestId": "00-00000000000000000000000000000000-0000000000000000-00",
    "details": {
      "retryAfterSeconds": 27
    }
  }
}

Unexpected server or stored-response restoration failure. Include requestId when contacting support; do not retry a write with a new key until you have checked its receipt.

Example response · application/json

{
  "error": {
    "code": "receipt_unavailable",
    "message": "The stored response could not be restored.",
    "requestId": "00-00000000000000000000000000000000-0000000000000000-00"
  }
}

Replace a monitor configuration

PUT/api/v1/workspaces/{workspaceId}/monitors/{monitorId}

Full replacement of the mutable monitor configuration. Include the current expectedVersion; a stale version returns monitor_version_conflict with the current version in error.details. The monitor type is immutable. Existing heartbeat monitors can be updated using expectedIntervalSeconds and gracePeriodSeconds; the one-time heartbeat URL remains hidden. isActive is rejected with monitor_active_state_requires_pause_or_resume; use the dedicated pause or resume operation to change active state. This writes monitor configuration and an audit record only; later worker-observed state changes can create incidents and notifications. Requires a UUID Idempotency-Key.

Required scopemonitors:writeAuthentication

Path parameters

workspaceIdintegerrequired

Numeric workspace ID. Use the workspace shown in credential management; credentials cannot cross workspace boundaries.

example 42 · min 1

monitorIdstringrequired

Existing opaque monitor slug ID, such as abc123monitor.

example "abc123monitor" · min length 1

Header parameters

Idempotency-Keystringrequired

example "00000000-0000-4000-8000-000000000001" · uuid · pattern ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$

Request body

Request fields

valueobject · no additional fields · Combines 4 schema requirements.

namerequired · string · min length 1 · max length 200

descriptionstring | null · nullable · max length 1000 On update, null clears the current description.

keywordstring | null · nullable · max length 500

portHoststring | null · nullable · max length 255

portinteger | null · nullable · min 1 · max 65535

intervalSecondsrequired · integer · min 1 Must meet the workspace plan minimum.

timeoutSecondsrequired · integer · min 3 Must not exceed the workspace plan maximum.

failureThresholdrequired · integer · min 1 · max 10

recoveryThresholdrequired · integer · min 1 · max 10

expectedIntervalSecondsinteger | null · nullable · min 10 · max 2592000

gracePeriodSecondsinteger | null · nullable · min 0 · max 604800

expectedVersionrequired · integer | null · nullable · min 1 Required for update; omitted for create.

isActiveboolean | null · nullable Rejected on update with monitor_active_state_requires_pause_or_resume; use the pause or resume operation instead.

Conditional fieldsWhen type = "keyword" and has type, this shape requires keyword.

Conditional fieldsWhen type = "port" and has type, this shape requires portHost, port.

Conditional fieldsWhen type = "heartbeat" and has type, this shape requires expectedIntervalSeconds, gracePeriodSeconds.

Conditional fieldsWhen not (type = "heartbeat" and has type), this shape requires target.

Responses

Select a status to view its fields and example.

Success

Client errors

Server errors

200 OK

Monitor configuration replaced.

Response fields

valueobject · no additional fields

datarequired · object · no additional fields

data.idrequired · string Opaque monitor slug.

data.namerequired · string

data.descriptionrequired · string | null · nullable

data.typerequired · string · one of "http", "keyword", "ping", "port", "heartbeat"

data.targetHostrequired · string | null · nullable Safe host projection only. The full target URL and heartbeat secret are omitted.

data.keywordrequired · string | null · nullable Always null in this privacy-filtered read projection.

data.portrequired · integer | null · nullable

data.intervalSecondsrequired · integer

data.timeoutSecondsrequired · integer

data.failureThresholdrequired · integer

data.recoveryThresholdrequired · integer

data.expectedIntervalSecondsrequired · integer | null · nullable

data.gracePeriodSecondsrequired · integer | null · nullable

data.isActiverequired · boolean

data.healthStatusrequired · string · one of "paused", "down", "operational", "unknown"

data.lastCheckedAtrequired · string | null · date-time · nullable

data.createdAtrequired · string · date-time

data.updatedAtrequired · string · date-time

data.versionrequired · integer · min 1

data.applicationUrlrequired · string | null · uri · nullable Configured application origin plus the canonical resource path; null when no valid origin is configured.

receiptrequired · object · no additional fields

receipt.idempotencyKeyrequired · string · uuid

receipt.replayedrequired · boolean

receipt.createdAtrequired · string · date-time

receipt.expiresAtrequired · string · date-time

receipt.statusCoderequired · integer

receipt.resourceTyperequired · string · one of "monitor", "incident", "maintenance"

receipt.resourceIdrequired · string

Structured error codes

invalid_monitor_version
monitor_version_conflict
monitor_version_exhausted
monitor_type_immutable
monitor_active_state_requires_pause_or_resume
heartbeat_configuration_missing
invalid_heartbeat_configuration
heartbeat_threshold_unsupported
incomplete_monitor_configuration
invalid_monitor_name
invalid_monitor_description
invalid_monitor_interval
invalid_monitor_timeout
invalid_monitor_threshold
invalid_monitor_target
invalid_monitor_keyword
invalid_monitor_port
ping_disabled
unsafe_monitor_target
workspace_not_found
resource_not_found
invalid_request_body
invalid_api_credential
insufficient_scope
workspace_access_denied
customer_membership_ambiguous
rate_limit_exceeded
invalid_idempotency_key
idempotency_key_expired
idempotency_key_reused
receipt_unavailable

Request example

Request · cURL

curl --request PUT \
  --url "https://app.driftro.se/api/v1/workspaces/$WORKSPACE_ID/monitors/$MONITOR_ID" \
  --header "Authorization: Bearer $DRIFTRO_API_TOKEN" \
  --header "Accept: application/json" \
  --header "Idempotency-Key: $IDEMPOTENCY_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "name": "Primary website",
  "description": "Public availability check",
  "type": "http",
  "target": "https://example.test/health",
  "intervalSeconds": 60,
  "timeoutSeconds": 10,
  "failureThreshold": 3,
  "recoveryThreshold": 2,
  "expectedVersion": 4
}'

Bash / cURL. Set the token and resource variables before running. Use a new UUID for each intended write; reuse it only for an identical retry. Adapt the example body to your workspace.

Response example

Response status

Monitor configuration replaced.

Example response · application/json

{
  "data": {
    "id": "abc123monitor",
    "name": "Primary website",
    "description": "Public availability check",
    "type": "http",
    "targetHost": "example.test",
    "keyword": null,
    "port": null,
    "intervalSeconds": 60,
    "timeoutSeconds": 10,
    "failureThreshold": 3,
    "recoveryThreshold": 2,
    "expectedIntervalSeconds": null,
    "gracePeriodSeconds": null,
    "isActive": true,
    "healthStatus": "operational",
    "lastCheckedAt": "2026-10-18T12:00:00Z",
    "createdAt": "2026-10-01T12:00:00Z",
    "updatedAt": "2026-10-18T12:01:00Z",
    "version": 5,
    "applicationUrl": "https://app.example.test/monitors/abc123monitor"
  },
  "receipt": {
    "idempotencyKey": "00000000-0000-4000-8000-000000000001",
    "replayed": false,
    "createdAt": "2026-10-18T12:01:00Z",
    "expiresAt": "2026-10-19T12:01:00Z",
    "statusCode": 200,
    "resourceType": "monitor",
    "resourceId": "abc123monitor"
  }
}

Invalid pagination, idempotency header, or expected version.

Example response · application/json

{
  "error": {
    "code": "invalid_page_limit",
    "message": "limit must be between 1 and 100.",
    "requestId": "00-00000000000000000000000000000000-0000000000000000-00",
    "details": null
  }
}

Missing, malformed, revoked, expired, or otherwise invalid API credential.

Example response · application/json

{
  "error": {
    "code": "invalid_api_credential",
    "message": "A valid API credential is required.",
    "requestId": "00-00000000000000000000000000000000-0000000000000000-00"
  }
}

Required scope is missing, workspace does not match, or current role/capability denies this operation.

Example response · application/json

{
  "error": {
    "code": "insufficient_scope",
    "message": "The 'monitors:read' scope is required.",
    "requestId": "00-00000000000000000000000000000000-0000000000000000-00"
  }
}

Workspace or resource is not visible in the authenticated workspace.

Example response · application/json

{
  "error": {
    "code": "resource_not_found",
    "message": "The requested resource was not found.",
    "requestId": "00-00000000000000000000000000000000-0000000000000000-00"
  }
}

Version conflict, quota limit, idempotency-key conflict/expiry, or inactive incident response.

Example response · application/json

{
  "error": {
    "code": "monitor_version_conflict",
    "message": "The monitor version is stale.",
    "requestId": "00-00000000000000000000000000000000-0000000000000000-00",
    "details": {
      "currentVersion": 5
    }
  }
}

Invalid JSON body binding or domain validation failed. Body binding errors include field details.

Invalid JSON request body · application/json

{
  "error": {
    "code": "invalid_request_body",
    "message": "The JSON request body is invalid.",
    "requestId": "00-00000000000000000000000000000000-0000000000000000-00",
    "details": {
      "fields": {
        "expectedVersion": [
          "The value is invalid."
        ]
      }
    }
  }
}

Monitor field validation

fieldValidation · application/json

{
  "error": {
    "code": "invalid_monitor_target",
    "message": "target is required.",
    "requestId": "00-00000000000000000000000000000000-0000000000000000-00"
  }
}

Read/write rate limit exceeded. Retry after the number of seconds in Retry-After and error.details.retryAfterSeconds.

Example response · application/json

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "The API request limit has been exceeded.",
    "requestId": "00-00000000000000000000000000000000-0000000000000000-00",
    "details": {
      "retryAfterSeconds": 27
    }
  }
}

Unexpected server or stored-response restoration failure. Include requestId when contacting support; do not retry a write with a new key until you have checked its receipt.

Example response · application/json

{
  "error": {
    "code": "receipt_unavailable",
    "message": "The stored response could not be restored.",
    "requestId": "00-00000000000000000000000000000000-0000000000000000-00"
  }
}

List monitor results

GET/api/v1/workspaces/{workspaceId}/monitors/{monitorId}/results

Returns check history in descending check time order with an opaque continuation cursor.

Required scopemonitors:readAuthentication

Path parameters

workspaceIdintegerrequired

Numeric workspace ID. Use the workspace shown in credential management; credentials cannot cross workspace boundaries.

example 42 · min 1

monitorIdstringrequired

Existing opaque monitor slug ID, such as abc123monitor.

example "abc123monitor" · min length 1

Query parameters

limitintegeroptional

Maximum items in the page (1–100; default 50). Pages use stable descending order.

example 50 · default 50 · min 1 · max 100

cursorstringoptional

Opaque cursor copied from the previous response's nextCursor. Omit it on the first page; do not construct or edit cursor values.

example "eyJU..." · min length 1

Responses

Select a status to view its fields and example.

Success

Client errors

Server errors

200 OK

A page of check results.

Response fields

valueobject

itemsrequired · array

items[]object

items[].idrequired · integer · int64

items[].isSuccessrequired · boolean

items[].statusCoderequired · integer | null · nullable

items[].responseTimeMsrequired · integer | null · nullable

items[].errorTyperequired · string | null · nullable

items[].checkedAtrequired · string · date-time

nextCursorrequired · string | null · nullable

Structured error codes

invalid_page_limit
invalid_page_cursor
resource_not_found
invalid_api_credential
insufficient_scope
workspace_access_denied
customer_membership_ambiguous
rate_limit_exceeded

Request example

Request · cURL

curl --request GET \
  --url "https://app.driftro.se/api/v1/workspaces/$WORKSPACE_ID/monitors/$MONITOR_ID/results" \
  --header "Authorization: Bearer $DRIFTRO_API_TOKEN" \
  --header "Accept: application/json"

Bash / cURL. Set the token and resource variables before running.

Response example

Response status

A page of check results.

Example response · application/json

{
  "items": [
    {
      "id": 987654,
      "isSuccess": true,
      "statusCode": 200,
      "responseTimeMs": 184,
      "errorType": null,
      "checkedAt": "2026-10-18T12:00:00Z"
    }
  ],
  "nextCursor": null
}

Invalid pagination, idempotency header, or expected version.

Example response · application/json

{
  "error": {
    "code": "invalid_page_limit",
    "message": "limit must be between 1 and 100.",
    "requestId": "00-00000000000000000000000000000000-0000000000000000-00",
    "details": null
  }
}

Missing, malformed, revoked, expired, or otherwise invalid API credential.

Example response · application/json

{
  "error": {
    "code": "invalid_api_credential",
    "message": "A valid API credential is required.",
    "requestId": "00-00000000000000000000000000000000-0000000000000000-00"
  }
}

Required scope is missing, workspace does not match, or current role/capability denies this operation.

Example response · application/json

{
  "error": {
    "code": "insufficient_scope",
    "message": "The 'monitors:read' scope is required.",
    "requestId": "00-00000000000000000000000000000000-0000000000000000-00"
  }
}

Workspace or resource is not visible in the authenticated workspace.

Example response · application/json

{
  "error": {
    "code": "resource_not_found",
    "message": "The requested resource was not found.",
    "requestId": "00-00000000000000000000000000000000-0000000000000000-00"
  }
}

Legacy customer membership state is ambiguous and needs operator resolution.

Example response · application/json

{
  "error": {
    "code": "customer_membership_ambiguous",
    "message": "Contact support to resolve legacy customer memberships.",
    "requestId": "00-00000000000000000000000000000000-00000000000000000000000000000000-00"
  }
}

Read/write rate limit exceeded. Retry after the number of seconds in Retry-After and error.details.retryAfterSeconds.

Example response · application/json

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "The API request limit has been exceeded.",
    "requestId": "00-00000000000000000000000000000000-0000000000000000-00",
    "details": {
      "retryAfterSeconds": 27
    }
  }
}

Unexpected server or stored-response restoration failure. Include requestId when contacting support; do not retry a write with a new key until you have checked its receipt.

Example response · application/json

{
  "error": {
    "code": "receipt_unavailable",
    "message": "The stored response could not be restored.",
    "requestId": "00-00000000000000000000000000000000-0000000000000000-00"
  }
}

Pause a monitor

POST/api/v1/workspaces/{workspaceId}/monitors/{monitorId}/pause

Pauses checks when expectedVersion matches the current monitor version. Writes monitor configuration and audit only. Requires a UUID Idempotency-Key.

Required scopemonitors:writeAuthentication

Path parameters

workspaceIdintegerrequired

Numeric workspace ID. Use the workspace shown in credential management; credentials cannot cross workspace boundaries.

example 42 · min 1

monitorIdstringrequired

Existing opaque monitor slug ID, such as abc123monitor.

example "abc123monitor" · min length 1

Header parameters

Idempotency-Keystringrequired

example "00000000-0000-4000-8000-000000000001" · uuid · pattern ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$

Request body

Request fields

valueobject · no additional fields

expectedVersionrequired · integer · min 1

Responses

Select a status to view its fields and example.

Success

Client errors

Server errors

200 OK

Monitor paused.

Response fields

valueobject · no additional fields

datarequired · object · no additional fields

data.idrequired · string Opaque monitor slug.

data.namerequired · string

data.descriptionrequired · string | null · nullable

data.typerequired · string · one of "http", "keyword", "ping", "port", "heartbeat"

data.targetHostrequired · string | null · nullable Safe host projection only. The full target URL and heartbeat secret are omitted.

data.keywordrequired · string | null · nullable Always null in this privacy-filtered read projection.

data.portrequired · integer | null · nullable

data.intervalSecondsrequired · integer

data.timeoutSecondsrequired · integer

data.failureThresholdrequired · integer

data.recoveryThresholdrequired · integer

data.expectedIntervalSecondsrequired · integer | null · nullable

data.gracePeriodSecondsrequired · integer | null · nullable

data.isActiverequired · boolean

data.healthStatusrequired · string · one of "paused", "down", "operational", "unknown"

data.lastCheckedAtrequired · string | null · date-time · nullable

data.createdAtrequired · string · date-time

data.updatedAtrequired · string · date-time

data.versionrequired · integer · min 1

data.applicationUrlrequired · string | null · uri · nullable Configured application origin plus the canonical resource path; null when no valid origin is configured.

receiptrequired · object · no additional fields

receipt.idempotencyKeyrequired · string · uuid

receipt.replayedrequired · boolean

receipt.createdAtrequired · string · date-time

receipt.expiresAtrequired · string · date-time

receipt.statusCoderequired · integer

receipt.resourceTyperequired · string · one of "monitor", "incident", "maintenance"

receipt.resourceIdrequired · string

Structured error codes

invalid_monitor_version
monitor_version_conflict
monitor_version_exhausted
usage_limit_exceeded
workspace_not_found
resource_not_found
invalid_request_body
invalid_api_credential
insufficient_scope
workspace_access_denied
customer_membership_ambiguous
rate_limit_exceeded
invalid_idempotency_key
idempotency_key_expired
idempotency_key_reused
receipt_unavailable

Request example

Request · cURL

curl --request POST \
  --url "https://app.driftro.se/api/v1/workspaces/$WORKSPACE_ID/monitors/$MONITOR_ID/pause" \
  --header "Authorization: Bearer $DRIFTRO_API_TOKEN" \
  --header "Accept: application/json" \
  --header "Idempotency-Key: $IDEMPOTENCY_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "expectedVersion": 4
}'

Bash / cURL. Set the token and resource variables before running. Use a new UUID for each intended write; reuse it only for an identical retry. Adapt the example body to your workspace.

Response example

Response status

Monitor paused.

Example response · application/json

{
  "data": {
    "id": "abc123monitor",
    "name": "Primary website",
    "description": "Public availability check",
    "type": "http",
    "targetHost": "example.test",
    "keyword": null,
    "port": null,
    "intervalSeconds": 60,
    "timeoutSeconds": 10,
    "failureThreshold": 3,
    "recoveryThreshold": 2,
    "expectedIntervalSeconds": null,
    "gracePeriodSeconds": null,
    "isActive": false,
    "healthStatus": "paused",
    "lastCheckedAt": "2026-10-18T12:00:00Z",
    "createdAt": "2026-10-01T12:00:00Z",
    "updatedAt": "2026-10-18T12:01:00Z",
    "version": 5,
    "applicationUrl": "https://app.example.test/monitors/abc123monitor"
  },
  "receipt": {
    "idempotencyKey": "00000000-0000-4000-8000-000000000002",
    "replayed": false,
    "createdAt": "2026-10-18T12:01:00Z",
    "expiresAt": "2026-10-19T12:01:00Z",
    "statusCode": 200,
    "resourceType": "monitor",
    "resourceId": "abc123monitor"
  }
}

Invalid pagination, idempotency header, or expected version.

Example response · application/json

{
  "error": {
    "code": "invalid_page_limit",
    "message": "limit must be between 1 and 100.",
    "requestId": "00-00000000000000000000000000000000-0000000000000000-00",
    "details": null
  }
}

Missing, malformed, revoked, expired, or otherwise invalid API credential.

Example response · application/json

{
  "error": {
    "code": "invalid_api_credential",
    "message": "A valid API credential is required.",
    "requestId": "00-00000000000000000000000000000000-0000000000000000-00"
  }
}

Required scope is missing, workspace does not match, or current role/capability denies this operation.

Example response · application/json

{
  "error": {
    "code": "insufficient_scope",
    "message": "The 'monitors:read' scope is required.",
    "requestId": "00-00000000000000000000000000000000-0000000000000000-00"
  }
}

Workspace or resource is not visible in the authenticated workspace.

Example response · application/json

{
  "error": {
    "code": "resource_not_found",
    "message": "The requested resource was not found.",
    "requestId": "00-00000000000000000000000000000000-0000000000000000-00"
  }
}

Version conflict, quota limit, idempotency-key conflict/expiry, or inactive incident response.

Example response · application/json

{
  "error": {
    "code": "monitor_version_conflict",
    "message": "The monitor version is stale.",
    "requestId": "00-00000000000000000000000000000000-0000000000000000-00",
    "details": {
      "currentVersion": 5
    }
  }
}

Invalid JSON body binding or domain validation failed. Body binding errors include field details.

Invalid JSON request body · application/json

{
  "error": {
    "code": "invalid_request_body",
    "message": "The JSON request body is invalid.",
    "requestId": "00-00000000000000000000000000000000-0000000000000000-00",
    "details": {
      "fields": {
        "expectedVersion": [
          "The value is invalid."
        ]
      }
    }
  }
}

Monitor field validation

fieldValidation · application/json

{
  "error": {
    "code": "invalid_monitor_target",
    "message": "target is required.",
    "requestId": "00-00000000000000000000000000000000-0000000000000000-00"
  }
}

Read/write rate limit exceeded. Retry after the number of seconds in Retry-After and error.details.retryAfterSeconds.

Example response · application/json

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "The API request limit has been exceeded.",
    "requestId": "00-00000000000000000000000000000000-0000000000000000-00",
    "details": {
      "retryAfterSeconds": 27
    }
  }
}

Unexpected server or stored-response restoration failure. Include requestId when contacting support; do not retry a write with a new key until you have checked its receipt.

Example response · application/json

{
  "error": {
    "code": "receipt_unavailable",
    "message": "The stored response could not be restored.",
    "requestId": "00-00000000000000000000000000000000-0000000000000000-00"
  }
}

Resume a monitor

POST/api/v1/workspaces/{workspaceId}/monitors/{monitorId}/resume

Resumes checks when expectedVersion matches the current monitor version. Writes monitor configuration and audit only; later worker-observed downtime or recovery can create incidents and notifications. Requires a UUID Idempotency-Key.

Required scopemonitors:writeAuthentication

Path parameters

workspaceIdintegerrequired

Numeric workspace ID. Use the workspace shown in credential management; credentials cannot cross workspace boundaries.

example 42 · min 1

monitorIdstringrequired

Existing opaque monitor slug ID, such as abc123monitor.

example "abc123monitor" · min length 1

Header parameters

Idempotency-Keystringrequired

example "00000000-0000-4000-8000-000000000001" · uuid · pattern ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$

Request body

Request fields

valueobject · no additional fields

expectedVersionrequired · integer · min 1

Responses

Select a status to view its fields and example.

Success

Client errors

Server errors

200 OK

Monitor resumed.

Response fields

valueobject · no additional fields

datarequired · object · no additional fields

data.idrequired · string Opaque monitor slug.

data.namerequired · string

data.descriptionrequired · string | null · nullable

data.typerequired · string · one of "http", "keyword", "ping", "port", "heartbeat"

data.targetHostrequired · string | null · nullable Safe host projection only. The full target URL and heartbeat secret are omitted.

data.keywordrequired · string | null · nullable Always null in this privacy-filtered read projection.

data.portrequired · integer | null · nullable

data.intervalSecondsrequired · integer

data.timeoutSecondsrequired · integer

data.failureThresholdrequired · integer

data.recoveryThresholdrequired · integer

data.expectedIntervalSecondsrequired · integer | null · nullable

data.gracePeriodSecondsrequired · integer | null · nullable

data.isActiverequired · boolean

data.healthStatusrequired · string · one of "paused", "down", "operational", "unknown"

data.lastCheckedAtrequired · string | null · date-time · nullable

data.createdAtrequired · string · date-time

data.updatedAtrequired · string · date-time

data.versionrequired · integer · min 1

data.applicationUrlrequired · string | null · uri · nullable Configured application origin plus the canonical resource path; null when no valid origin is configured.

receiptrequired · object · no additional fields

receipt.idempotencyKeyrequired · string · uuid

receipt.replayedrequired · boolean

receipt.createdAtrequired · string · date-time

receipt.expiresAtrequired · string · date-time

receipt.statusCoderequired · integer

receipt.resourceTyperequired · string · one of "monitor", "incident", "maintenance"

receipt.resourceIdrequired · string

Structured error codes

invalid_monitor_version
monitor_version_conflict
monitor_version_exhausted
usage_limit_exceeded
workspace_not_found
resource_not_found
invalid_request_body
invalid_api_credential
insufficient_scope
workspace_access_denied
customer_membership_ambiguous
rate_limit_exceeded
invalid_idempotency_key
idempotency_key_expired
idempotency_key_reused
receipt_unavailable

Request example

Request · cURL

curl --request POST \
  --url "https://app.driftro.se/api/v1/workspaces/$WORKSPACE_ID/monitors/$MONITOR_ID/resume" \
  --header "Authorization: Bearer $DRIFTRO_API_TOKEN" \
  --header "Accept: application/json" \
  --header "Idempotency-Key: $IDEMPOTENCY_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "expectedVersion": 4
}'

Bash / cURL. Set the token and resource variables before running. Use a new UUID for each intended write; reuse it only for an identical retry. Adapt the example body to your workspace.

Response example

Response status

Monitor resumed.

Example response · application/json

{
  "data": {
    "id": "abc123monitor",
    "name": "Primary website",
    "description": "Public availability check",
    "type": "http",
    "targetHost": "example.test",
    "keyword": null,
    "port": null,
    "intervalSeconds": 60,
    "timeoutSeconds": 10,
    "failureThreshold": 3,
    "recoveryThreshold": 2,
    "expectedIntervalSeconds": null,
    "gracePeriodSeconds": null,
    "isActive": true,
    "healthStatus": "operational",
    "lastCheckedAt": "2026-10-18T12:00:00Z",
    "createdAt": "2026-10-01T12:00:00Z",
    "updatedAt": "2026-10-18T12:01:00Z",
    "version": 5,
    "applicationUrl": "https://app.example.test/monitors/abc123monitor"
  },
  "receipt": {
    "idempotencyKey": "00000000-0000-4000-8000-000000000003",
    "replayed": false,
    "createdAt": "2026-10-18T12:01:00Z",
    "expiresAt": "2026-10-19T12:01:00Z",
    "statusCode": 200,
    "resourceType": "monitor",
    "resourceId": "abc123monitor"
  }
}

Invalid pagination, idempotency header, or expected version.

Example response · application/json

{
  "error": {
    "code": "invalid_page_limit",
    "message": "limit must be between 1 and 100.",
    "requestId": "00-00000000000000000000000000000000-0000000000000000-00",
    "details": null
  }
}

Missing, malformed, revoked, expired, or otherwise invalid API credential.

Example response · application/json

{
  "error": {
    "code": "invalid_api_credential",
    "message": "A valid API credential is required.",
    "requestId": "00-00000000000000000000000000000000-0000000000000000-00"
  }
}

Required scope is missing, workspace does not match, or current role/capability denies this operation.

Example response · application/json

{
  "error": {
    "code": "insufficient_scope",
    "message": "The 'monitors:read' scope is required.",
    "requestId": "00-00000000000000000000000000000000-0000000000000000-00"
  }
}

Workspace or resource is not visible in the authenticated workspace.

Example response · application/json

{
  "error": {
    "code": "resource_not_found",
    "message": "The requested resource was not found.",
    "requestId": "00-00000000000000000000000000000000-0000000000000000-00"
  }
}

Version conflict, quota limit, idempotency-key conflict/expiry, or inactive incident response.

Example response · application/json

{
  "error": {
    "code": "monitor_version_conflict",
    "message": "The monitor version is stale.",
    "requestId": "00-00000000000000000000000000000000-0000000000000000-00",
    "details": {
      "currentVersion": 5
    }
  }
}

Invalid JSON body binding or domain validation failed. Body binding errors include field details.

Invalid JSON request body · application/json

{
  "error": {
    "code": "invalid_request_body",
    "message": "The JSON request body is invalid.",
    "requestId": "00-00000000000000000000000000000000-0000000000000000-00",
    "details": {
      "fields": {
        "expectedVersion": [
          "The value is invalid."
        ]
      }
    }
  }
}

Monitor field validation

fieldValidation · application/json

{
  "error": {
    "code": "invalid_monitor_target",
    "message": "target is required.",
    "requestId": "00-00000000000000000000000000000000-0000000000000000-00"
  }
}

Read/write rate limit exceeded. Retry after the number of seconds in Retry-After and error.details.retryAfterSeconds.

Example response · application/json

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "The API request limit has been exceeded.",
    "requestId": "00-00000000000000000000000000000000-0000000000000000-00",
    "details": {
      "retryAfterSeconds": 27
    }
  }
}

Unexpected server or stored-response restoration failure. Include requestId when contacting support; do not retry a write with a new key until you have checked its receipt.

Example response · application/json

{
  "error": {
    "code": "receipt_unavailable",
    "message": "The stored response could not be restored.",
    "requestId": "00-00000000000000000000000000000000-0000000000000000-00"
  }
}

Path parameters

Query parameters

Responses

Success

Client errors

Server errors

200 OK

400 Bad Request

401 Unauthorized

403 Forbidden

409 Conflict

429 Too Many Requests

Response headers

500 Internal Server Error

Path parameters

Header parameters

Request body

Responses

Success

Client errors

Server errors

201 Created

Response headers

400 Bad Request

401 Unauthorized

403 Forbidden

409 Conflict

422 Unprocessable Content

429 Too Many Requests

Response headers

500 Internal Server Error

Path parameters

Responses

Success

Client errors

Server errors

200 OK

401 Unauthorized

403 Forbidden

404 Not Found

409 Conflict

429 Too Many Requests

Response headers

500 Internal Server Error

Path parameters

Header parameters

Request body

Responses

Success

Client errors

Server errors

200 OK

400 Bad Request

401 Unauthorized

403 Forbidden

404 Not Found

409 Conflict

422 Unprocessable Content

429 Too Many Requests

Response headers

500 Internal Server Error

Path parameters

Query parameters

Responses

Success

Client errors

Server errors

200 OK

400 Bad Request

401 Unauthorized

403 Forbidden

404 Not Found

409 Conflict

429 Too Many Requests

Response headers

500 Internal Server Error

Path parameters

Header parameters

Request body

Responses