Skip to main content
POST
/
api
/
admin
/
interceptors
/
{id}
/
activate
Activate interceptor
curl --request POST \
  --url https://{instance}.{env}.on-hellgate.cloud/api/admin/interceptors/{id}/activate \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "context": "<string>",
  "description": "<string>",
  "destination": {
    "timeout_ms": 30000,
    "url": "https://checkout.example.com/payments"
  },
  "discovered_keys": [
    {
      "key": "<string>",
      "type": "<string>"
    }
  ],
  "field_mapping": [
    {}
  ],
  "inserted_at": "2023-11-07T05:31:56Z",
  "ref": "<string>",
  "responses": {},
  "updated_at": "2023-11-07T05:31:56Z",
  "version": 123
}

Authorizations

​
Authorization
string
header
required

HS256-signed JWT bearer token, obtained via the OAuth2 client-credentials grant (see Authentication).

Path Parameters

​
id
string
required

Interceptor ID

Response

Activated interceptor

​
id
string<uuid>
​
context
string
​
description
string | null
​
destination
object
​
discovered_keys
object[]

Typed JSONPath keys observed in intercepted requests. Used for field mapping discovery.

​
field_mapping
object[]
​
inserted_at
string<date-time>
​
ref
string | null

Stable identifier shared across all versions of this interceptor. Used as the path parameter for the runtime execute endpoint.

​
responses
object
​
status
enum<string>
Available options:
DRAFT,
ACTIVE,
INACTIVE
​
updated_at
string<date-time>
​
version
integer