Update a callback endpoint

Replaces an endpoint's destination after applying the complete URL and DNS policy, and renames it when a name is given. Optional headers patch endpoint defaults with set, keep, or remove; omitted headers preserve them. A secret value can be retained, replaced (including an empty string), or removed, but cannot be revealed. Header and destination edits apply to newly admitted attempts, including retries; recovery of the same admitted attempt keeps its snapshot. Disabled endpoints cannot be updated. Send If-Match with the version the endpoint was read at to be refused rather than overwrite a destination somebody else changed in the meantime.

put/v1/endpoints/{endpointId}

Request

  • Base URL: https://docs.greatwait.dev (the document declares no server; this is the origin it was published from)
  • URL: https://docs.greatwait.dev/v1/endpoints/{endpointId}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer and API key in header Greatwait-Environment and API key in header Greatwait-Project

Path parameters

endpointIdstring required

Headers

If-Matchstring

Request body

namestring
urlstring uri required

Response

Update a callback endpoint

createdAtstring required
disabledAtstring
environmentKind'test' | 'live' required
idstring required
namestring
projectstring required
status'active' | 'disabled' required
updatedAtstring required
urlstring uri required
versioninteger required

Changes

No recorded changes to this operation across all 1 revision of this API.