Skip to main content
POST
Disable Destination
Turns a destination off without removing it — the record and its audit history are kept, but the forward proxy rejects it with 403 DESTINATION_NOT_ALLOWED until it is enabled again. Useful for temporarily suspending a destination without losing its configuration. See the Destination Allowlist guide.

Authorizations

public-api-key
string
header
default:<Your public-api-key>
required
private-secret-key
string
header
default:<Your private-secret-key>
required

Path Parameters

id
string<uuid>
required

The id (UUID) of the destination to disable.

Example:

"d7e8f9a0-1234-4b5c-8d6e-7f8091a2b3c4"

Response

The destination was disabled; the updated object is returned.

id
string<uuid>

Unique identifier of the destination. Use it to remove the destination.

Example:

"d7e8f9a0-1234-4b5c-8d6e-7f8091a2b3c4"

account_id
string | null

The account this destination is scoped to, or null when it applies to the whole organization.

Example:

null

hostname
string

The registered hostname.

Example:

"api.example-processor.com"

status
enum<string>

Whether the destination is active. Only ENABLED destinations are used by the forward path.

Available options:
ENABLED,
DISABLED
Example:

"ENABLED"

purpose
string

The label you provided when registering the destination.

Example:

"Direct acquiring — Processor X"

created_at
string<date-time>

When the destination was registered.

Example:

"2026-07-09T13:05:36Z"

updated_at
string<date-time>

When the destination was last changed.

Example:

"2026-07-09T13:05:36Z"