List protocols - Hellgate Cloud Platform

GET

api

admin

protocols

List protocols

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

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "inserted_at": "2023-11-07T05:31:56Z",
      "local_id": "specter-v1",
      "name": "Specter Risk Assessment",
      "url": "https://developer.hellgate.io/protocols/specter/v1",
      "version": "1"
    }
  ],
  "links": {
    "next": "<string>"
  }
}

Authorizations

Authorization

string

header

required

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

Query Parameters

after

string

Pagination cursor

limit

integer

Page size (default 20)

Response

Protocol list

Paginated list of protocols.

data

ProtocolSummary · object[]

required

Show child attributes

links

object

required

Show child attributes

Get protocol documentReturns the full protocol specification document.

⌘I

List protocols

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

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "inserted_at": "2023-11-07T05:31:56Z",
      "local_id": "specter-v1",
      "name": "Specter Risk Assessment",
      "url": "https://developer.hellgate.io/protocols/specter/v1",
      "version": "1"
    }
  ],
  "links": {
    "next": "<string>"
  }
}