Skip to content
API-Reference
/
/
Update API key

Guardian API (1.0)

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
Guardian service instance
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

Generic Tokens

Management of generic tokens and their schemas for various use cases.

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
  • Types
    • admin:types:create
    • admin:types:ready
    • admin:types: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
  • Generic Tokens
    • generic:tokens:create
    • generic:tokens:read
    • generic:tokens:delete
Operations

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"
  ]
}

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""admin:webhooks:create""admin:webhooks:read""admin:webhooks:delete""pci:tokens:create""pci:tokens:read""pci:tokens:update"
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""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"
  ]
}

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

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

Types

Management of types on Guardian.

Types can be used as a schema for generic token payloads, which enables futher features likes filters and validations.

Operations
Starfish GmbH & Co. KG © 2025