Skip to main content
PATCH
Enable/disable or re-point a destination (alias of PUT)

Authorizations

Authorization
string
header
required

A hpt_… customer portal token, as Authorization: Bearer. Stored hashed; shown once at issue.

Path Parameters

id
string
required

Destination id. Scoped to the token's tenant, portal and customer.

Query Parameters

token
string

Portal access token (hpt_…), as an alternative to the Authorization: Bearer header.

Body

application/json

Identical handler to PUT — PATCH is not a partial-update variant, it is the same code path. Only enabled and url are honoured; name and dataset_filter are ignored. An absent or unparseable body is treated as {}, which sets enabled = 1.

enabled
boolean

Only the literal JSON false disables; anything else (including absence) sets enabled = 1.

url
string<uri>

Applied only when it is a string starting with https:// (case-insensitive); otherwise silently ignored.

Pattern: ^[Hh][Tt][Tt][Pp][Ss]://

Response

Updated.

ok
enum<boolean>
required
Available options:
true