Skip to main content
POST
/
api
/
invoke
/
{protocol}
/
{action}
Invoke protocol action
curl --request POST \
  --url https://{instance}.{env}.on-hellgate.cloud/api/invoke/{protocol}/{action} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'
{}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
protocol
string
required

Protocol local ID

​
action
string
required

Action name

Query Parameters

​
backend
string

Backend ID (required when multiple backends match)

Body

application/json

Action input. The shape is defined by the invoked protocol.

The body is of type object.

Response

Protocol-defined outcome. The shape is declared by the invoked protocol; Link returns the protocol-mapped result.

The response is of type object.