Skip to main content
POST
/
api
/
admin
/
types
Create type
curl --request POST \
  --url https://{cluster_id}.on-hellgate.cloud/api/admin/types \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "Simple SEPA Schema",
  "schema": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "required": [
      "iban",
      "bic"
    ],
    "properties": {
      "iban": {
        "type": "string",
        "description": "International Bank Account Number (IBAN)"
      },
      "bic": {
        "type": "string",
        "description": "Bank Identifier Code (BIC / SWIFT)"
      }
    },
    "additionalProperties": false
  }
}
'
{
  "id": "c3b51d3b-1b39-4789-8c9b-842e4bbff7db",
  "created_at": "2026-01-19T15:32:45+01:00",
  "name": "Simple SEPA Schema",
  "schema": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "required": [
      "iban",
      "bic"
    ],
    "properties": {
      "iban": {
        "type": "string",
        "description": "International Bank Account Number (IBAN)"
      },
      "bic": {
        "type": "string",
        "description": "Bank Identifier Code (BIC / SWIFT)"
      }
    },
    "additionalProperties": false
  }
}

Authorizations

x-api-key
string
header
required

Body

application/json
name
string
required

A display name for the type

schema
object
required

JSON Schema definition according to https://json-schema.org/draft/2020-12/schema

Response

Success response

id
string<uuid>
created_at
string<date-time>
name
string

A display name for the type

schema
object

JSON Schema definition according to https://json-schema.org/draft/2020-12/schema