Get protocol document - Hellgate Cloud Platform

GET

api

admin

protocols

{id}

Get protocol document

curl --request GET \
  --url https://{instance}.{env}.on-hellgate.cloud/api/admin/protocols/{id} \
  --header 'Authorization: Bearer <token>'

{
  "$id": "<string>",
  "$schema": "<string>",
  "actions": {},
  "components": {},
  "name": "<string>",
  "version": "<string>"
}

Authorization

string

header

required

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

string

required

Protocol local ID

Protocol document

Full protocol specification document.

$id

string

$schema

string

actions

object

components

object

name

string

version

string

⌘I

Get protocol document

curl --request GET \
  --url https://{instance}.{env}.on-hellgate.cloud/api/admin/protocols/{id} \
  --header 'Authorization: Bearer <token>'

{
  "$id": "<string>",
  "$schema": "<string>",
  "actions": {},
  "components": {},
  "name": "<string>",
  "version": "<string>"
}