Skip to content
/API Keys

Guardian API (EAP)

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

https://hellgate.io/cpa/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

API Keys

Management of API keys for service access.

The capabilities an API keys has access to can be scoped to these areas:

  • API Keys
    • admin:api-keys:create
    • admin:api-keys:read
    • admin:api-keys:update
    • admin:api-keys:delete
  • Webhooks
    • admin:webhooks:create
    • admin:webhooks:read
    • admin:webhooks:delete
  • PCI Tokens
    • pci:tokens:create
    • pci:tokens:read
    • pci:tokens:update
    • pci:tokens:delete
    • pci:tokens:forward
  • Network Tokens
    • network:tokens:create
    • network:tokens:read
    • network:tokens:delete
    • network:tokens:use
  • Metadata Inquiries
    • metadata:inquiry:create
Operations

Create API key

Request

Creates a new API key with the specified scopes and expiry defined via expires_in (seconds).

Security
APIKey or AdminToken
Headers
x-idempotency-keystring

Optional idempotency key to prevent duplicate processing

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

How many seconds after creation the API key expires 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""admin:webhooks:create""admin:webhooks:read""admin:webhooks:delete""pci:tokens:create""pci:tokens:read""pci:tokens:update"
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 '{
    "expires_in": 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""admin:webhooks:create""admin:webhooks:read""admin:webhooks:delete""pci:tokens:create""pci:tokens:read""pci:tokens:update"
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""admin:webhooks:create""admin:webhooks:read""admin:webhooks:delete""pci:tokens:create""pci:tokens:read""pci:tokens:update"
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"
  ]
}

Webhooks

Management of webhooks for event notifications.

Guardian uses tiny events as notification payload. They give you the context of what happened and you can use this information to fetch more details via our API.

Please find the documentation about the callback on the endpoint that registers the webhook.

Operations
Starfish GmbH & Co. KG © 2025