Skip to content
API-Reference
/
/
Get API key details

Guardian API (EAP)

Download OpenAPI description
guardian-openapi.json
guardian-openapi.yaml
Overview
URL

https://hellgate.io/guardian

Starfish GmbH & Co. KG

hello@starfish.team

License

Hellgate API Terms

Languages
Servers
Managed instance of Guardian CPA

https://{cluster_id}.on-hellgate.cloud/

PCI Tokens

Management of card payment credentials under the ruling of PCI/DSS.

Operations

Network Tokens

Management of network tokens, including cryptograms for secure transactions.

Operations

Metadata Inquiries

Inquiries for card metadata based on PAN, PCI tokens, or network tokens.

Operations

Administration

Administrative operations for managing a Guardian instance, such as API keys.

Operations

Create API key

Request

Creates a new API key with the specified scopes and expiration time.

Security
APIKey or AdminToken
Headers
x-idempotency-keystring

Optional idempotency key to prevent duplicate processing

Example: order_12345_retry_001
Bodyapplication/json
expiration_timeinteger[ 1 .. 7776000 ]

Specifies how many seconds after creation the API key will expire automatically.

Example: 3600
scopesArray of stringsnon-emptyrequired

A list of scopes that the API key will have access to.

Items Enum"admin:api-keys:create""admin:api-keys:read""admin:api-keys:update""admin:api-keys:delete""pci:tokens:create""pci:tokens:read""pci:tokens:update""pci:tokens:delete""pci:tokens:forward""network:tokens:create"
curl -i -X POST \
  https://my-cluster-id.on-hellgate.cloud/api/admin/api-keys \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-idempotency-key: order_12345_retry_001' \
  -d '{
    "expiration_time": 3600,
    "scopes": [
      "admin:api-keys:create",
      "admin:api-keys:update"
    ]
  }'

Responses

Success response

Bodyapplication/json
idstring(uuid)required
Example: "123e4567-e89b-12d3-a456-426614174000"
created_atstring(date-time)required
Example: "2023-10-01T10:00:00Z"
expires_atstring(date-time)
Example: "2023-10-01T11:00:00Z"
key_valuestringrequired

The generated API key value. It will only be returned once with this response.

Example: "key_1234567890ABCDEF"
scopesArray of stringsnon-emptyrequired

A list of scopes that the API key will have access to.

Items Enum"admin:api-keys:create""admin:api-keys:read""admin:api-keys:update""admin:api-keys:delete""pci:tokens:create""pci:tokens:read""pci:tokens:update""pci:tokens:delete""pci:tokens:forward""network:tokens:create"
Response
application/json
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2023-10-01T10:00:00Z",
  "expires_at": "2023-10-01T11:00:00Z",
  "key_value": "key_1234567890ABCDEF",
  "scopes": [
    "admin:api-keys:create",
    "admin:api-keys:update"
  ]
}

Get API keys

Request

Retrieves a list of all API keys.

Security
APIKey or AdminToken
Query
afterstring(uuid)

The ID of the API key after which to start listing. This is used for pagination.

limitinteger[ 1 .. 100 ]
Default 20
curl -i -X GET \
  'https://my-cluster-id.on-hellgate.cloud/api/admin/api-keys?after=497f6eca-6276-4993-bfeb-53cbbbba6f08&limit=20' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Success response

Bodyapplication/json
dataArray of itemsrequired
Example: [{"id":"123e4567-e89b-12d3-a456-426614174000","created_at":"2023-10-01T12:00:00Z","masked_key_value":"key_123xxxx","scopes":["admin:api-keys:create","admin:api-keys:update"]}]
data[].​[0]object
Example: {"id":"123e4567-e89b-12d3-a456-426614174000","created_at":"2023-10-01T12:00:00Z","masked_key_value":"key_123xxxx","scopes":["admin:api-keys:create","admin:api-keys:update"]}
linksobjectrequired
Example: {"next":"https://my-cluster-id.on-hellgate.cloud/admin/api-keys?after=123e4567-e89b-12d3-a456-426614174000&limit=20"}
links.​nextstring(uri)required
Example: "https://my-cluster-id.on-hellgate.cloud/admin/api-keys?after=123e4567-e89b-12d3-a456-426614174000&limit=20"
Response
application/json
{
  "data": [
    { … }
  ],
  "links": {
    "next": "https://my-cluster-id.on-hellgate.cloud/admin/api-keys?after=123e4567-e89b-12d3-a456-426614174000&limit=20"
  }
}

Get API key details

Request

Retrieves detailed information about a specific API key.

Security
APIKey or AdminToken
Path
idstring(uuid)required

The unique identifier of the API key.

curl -i -X GET \
  'https://my-cluster-id.on-hellgate.cloud/api/admin/api-keys/{id}' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Success response

Bodyapplication/json
idstringrequired
Example: "123e4567-e89b-12d3-a456-426614174000"
created_atstring(date-time)required
Example: "2023-10-01T12:00:00Z"
expires_atstring(date-time)
masked_key_valuestringrequired
Example: "key_123xxxx"
scopesArray of stringsnon-emptyrequired

A list of scopes that the API key will have access to.

Items Enum"admin:api-keys:create""admin:api-keys:read""admin:api-keys:update""admin:api-keys:delete""pci:tokens:create""pci:tokens:read""pci:tokens:update""pci:tokens:delete""pci:tokens:forward""network:tokens:create"
Response
application/json
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2023-10-01T12:00:00Z",
  "masked_key_value": "key_123xxxx",
  "scopes": [
    "admin:api-keys:create",
    "admin:api-keys:update"
  ]
}

Update API key

Request

Updates the scopes of an existing API key.

Security
APIKey or AdminToken
Path
idstring(uuid)required

The unique identifier of the API key.

Bodyapplication/json
scopesArray of stringsnon-emptyrequired

A list of scopes that the API key will have access to.

Items Enum"admin:api-keys:create""admin:api-keys:read""admin:api-keys:update""admin:api-keys:delete""pci:tokens:create""pci:tokens:read""pci:tokens:update""pci:tokens:delete""pci:tokens:forward""network:tokens:create"
curl -i -X PATCH \
  'https://my-cluster-id.on-hellgate.cloud/api/admin/api-keys/{id}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "scopes": [
      "admin:api-keys:create",
      "admin:api-keys:update"
    ]
  }'

Responses

Success response

Bodyapplication/json
idstringrequired
Example: "123e4567-e89b-12d3-a456-426614174000"
created_atstring(date-time)required
Example: "2023-10-01T12:00:00Z"
expires_atstring(date-time)
masked_key_valuestringrequired
Example: "key_123xxxx"
scopesArray of stringsnon-emptyrequired

A list of scopes that the API key will have access to.

Items Enum"admin:api-keys:create""admin:api-keys:read""admin:api-keys:update""admin:api-keys:delete""pci:tokens:create""pci:tokens:read""pci:tokens:update""pci:tokens:delete""pci:tokens:forward""network:tokens:create"
Response
application/json
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2023-10-01T12:00:00Z",
  "masked_key_value": "key_123xxxx",
  "scopes": [
    "admin:api-keys:create",
    "admin:api-keys:update"
  ]
}

Delete API key

Request

Deletes a specific API key.

Security
APIKey or AdminToken
Path
idstring(uuid)required

The unique identifier of the API key.

curl -i -X DELETE \
  'https://my-cluster-id.on-hellgate.cloud/api/admin/api-keys/{id}' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Success response (No Content)

Response
No content

Register webhook

Request

Register a new webhook and receive callbacks.

Security
APIKey or AdminToken
Bodyapplication/json
eventsArray of stringsnon-emptyrequired

The list of events to subscribe to.

Items Enum"network.token.updated""pci.token.security-code.expired"
hmac_keystring

The HMAC key to be used to sign the payloads sent to the webhook URL.

urlstring(uri)required

The URL to which the webhook will send event notifications.

curl -i -X POST \
  https://my-cluster-id.on-hellgate.cloud/api/admin/webhooks \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "events": [
      "network.token.updated"
    ],
    "url": "http://example.com"
  }'

Responses

Success response

Bodyapplication/json
idstring(uuid)required

The unique identifier for the webhook.

created_atstring(date-time)required

The timestamp when the webhook was created.

eventsArray of stringsnon-emptyrequired

The list of events the webhook is subscribed to.

Items Enum"network.token.updated""pci.token.security-code.expired"
masekd_hmac_keystring

The masked HMAC key used to sign the payloads sent to the webhook URL.

Example: "123xxxx"
urlstring(uri)required

The URL to which the webhook sends event notifications.

Response
application/json
{
  "id": "5d6b2c9a-9b0b-4b0c-8c7d-9e9d5d7e9d5d",
  "created_at": "2023-10-05T14:48:00.000Z",
  "url": "https://my-webhook-endpoint.com/webhooks",
  "events": [
    "network.token.updated",
    "pci.token.security-code.expired"
  ],
  "masekd_hmac_key": "123xxxx"
}

Callbacks

Event notification callback
post

Get webhooks

Request

List all webhooks known to the system.

Security
APIKey or AdminToken
Query
limitinteger[ 1 .. 100 ]

The limit parameter defines the maximum number of rows returned in a single call and enables consecutive pagination using the next link provided in the response payload.

Default 20
curl -i -X GET \
  'https://my-cluster-id.on-hellgate.cloud/api/admin/webhooks?limit=20' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Success response

Bodyapplication/json
dataArray of itemsrequired
Example: [{"id":"123e4567-e89b-12d3-a456-426614174000","created_at":"2023-10-01T12:00:00Z","masked_hmac_key":"123xxxx","events":["network.token.updated"],"url":"https://example.com/webhook"}]
data[].​[0]object
linksobjectrequired
Example: {"next":"https://my-cluster-id.on-hellgate.cloud/admin/webhooks?after=123e4567-e89b-12d3-a456-426614174000&limit=20"}
links.​nextstring(uri)required
Example: "https://my-cluster-id.on-hellgate.cloud/admin/webhooks?after=123e4567-e89b-12d3-a456-426614174000&limit=20"
Response
application/json
{
  "data": [
    { … }
  ],
  "links": {
    "next": "https://my-cluster-id.on-hellgate.cloud/admin/webhooks?after=123e4567-e89b-12d3-a456-426614174000&limit=20"
  }
}

Get webhook details

Request

Retrieves detailed information about a specific webhook.

Security
APIKey or AdminToken
Path
idstring(uuid)required

The unique identifier of the webhook.

curl -i -X GET \
  'https://my-cluster-id.on-hellgate.cloud/api/admin/webhooks/{id}' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Success response

Bodyapplication/json
idstring(uuid)required

The unique identifier for the webhook.

created_atstring(date-time)required

The timestamp when the webhook was created.

eventsArray of stringsnon-emptyrequired

The list of events the webhook is subscribed to.

Items Enum"network.token.updated""pci.token.security-code.expired"
masekd_hmac_keystring

The masked HMAC key used to sign the payloads sent to the webhook URL.

Example: "123xxxx"
urlstring(uri)required

The URL to which the webhook sends event notifications.

Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created_at": "2019-08-24T14:15:22Z",
  "events": [
    "network.token.updated"
  ],
  "masekd_hmac_key": "123xxxx",
  "url": "http://example.com"
}

Delete webhook

Request

Deletes a specific webhook.

Security
APIKey or AdminToken
Path
idstring(uuid)required

The unique identifier of the webhook.

curl -i -X DELETE \
  'https://my-cluster-id.on-hellgate.cloud/api/admin/webhooks/{id}' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Success response (No Content)

Response
No content
Starfish GmbH & Co. KG © 2025