Get type details

GET

api

admin

types

{id}

Get type details

curl --request GET \
  --url https://{cluster_id}.on-hellgate.cloud/api/admin/types/{id} \
  --header 'x-api-key: <api-key>'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "schema": {}
}

x-api-key

string

header

required

string<uuid>

required

The ID of the schema to read.

Success response

string<uuid>

created_at

string<date-time>

name

string

A display name for the type

schema

object

⌘I

Get type details

curl --request GET \
  --url https://{cluster_id}.on-hellgate.cloud/api/admin/types/{id} \
  --header 'x-api-key: <api-key>'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "schema": {}
}