Skip to main content
POST
/
api
/
admin
/
protocols
Import by spec
curl --request POST \
  --url https://{instance}.{env}.on-hellgate.cloud/api/admin/protocols \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "$id": "<string>",
  "$schema": "<string>",
  "actions": {},
  "components": {},
  "name": "<string>",
  "version": "<string>"
}
'
{
  "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"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

Protocol document

Full protocol specification document.

​
$id
string
​
$schema
string
​
actions
object
​
components
object
​
name
string
​
version
string

Response

Protocol created

Summary of an imported or created protocol.

​
id
string<uuid>
required
​
inserted_at
string<date-time>
required
​
local_id
string
required
Example:

"specter-v1"

​
name
string
required
Example:

"Specter Risk Assessment"

​
url
string
required
Example:

"https://developer.hellgate.io/protocols/specter/v1"

​
version
string
required
Example:

"1"