Skip to main content
POST
Retry custom-URL health check

Authorizations

X-API-Key
string
header
required

Path Parameters

organization_id
string<shortuuid>
required

UUID of the owning organization. Caller must have CONTRIBUTE.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
custom_url_id
string<shortuuid>
required

URL-safe short_id of the custom-URL entry to re-check.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

Response

OK

A custom-URL catalog entry as read from the API.

id
string<shortuuid>
required

URL-safe 22-character shortuuid encoding of the row's UUID primary key. Stable across the row's lifetime; suitable for sharing in URLs, log lines, and external SDK clients. Accepted on input as either the shortuuid form or the canonical UUID form (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
url
string
required

Destination URL a matching scan redirects to. Must be a valid absolute http(s) URL (max 2048 chars).

status
enum<string>
required

Latest health status from the URL monitor: UNKNOWN (never checked yet), HEALTHY, DEGRADED (intermittent failures, under the failure threshold), or UNREACHABLE (over the threshold). Read-only — set by the monitor, not the client.

Available options:
UNKNOWN,
HEALTHY,
DEGRADED,
UNREACHABLE
organization_id
string<shortuuid>
required

UUID of the organization that owns this custom URL.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
created
string<date-time>
required

ISO-8601 creation timestamp.

modified
string<date-time>
required

ISO-8601 last-modified timestamp.

last_checked_at
string<date-time> | null

ISO-8601 timestamp of the last health check, or null if never checked.