Kong · Schema

API

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

Properties

Name	Type	Description
id	string	The API identifier.
name	string	The name of your API. The `name + version` combination must be unique for each API you publish.
description	string	A description of your API. Will be visible on your live Portal.
version	string	An optional version for your API. Leave this empty if your API is unversioned.
current_version_summary	object
slug	string	The `slug` is used in generated URLs to provide human readable paths. Defaults to `slugify(name + version)`
api_spec_ids	array	The list of API specification ids for the API.
portals	array	The list of portals which this API is published to.
labels	object
implementation_mode	string	the implementations that are associated with this api either gateway_entity_binding or access_control_enforcement
attributes	object
created_at	object
updated_at	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ApiResponseSchema",
  "title": "API",
  "type": "object",
  "properties": {
    "id": {
      "description": "The API identifier.",
      "type": "string",
      "format": "uuid",
      "example": "9f5061ce-78f6-4452-9108-ad7c02821fd5",
      "readOnly": true
    },
    "name": {
      "description": "The name of your API. The `name + version` combination must be unique for each API you publish.\n",
      "type": "string",
      "example": "MyAPI",
      "maxLength": 255,
      "minLength": 1
    },
    "description": {
      "description": "A description of your API. Will be visible on your live Portal.",
      "type": "string",
      "nullable": true
    },
    "version": {
      "description": "An optional version for your API. Leave this empty if your API is unversioned.",
      "type": "string",
      "maxLength": 255,
      "minLength": 1,
      "nullable": true,
      "x-speakeasy-param-computed": true
    },
    "current_version_summary": {
      "$ref": "#/components/schemas/ApiVersionSummary"
    },
    "slug": {
      "description": "The `slug` is used in generated URLs to provide human readable paths.\n\nDefaults to `slugify(name + version)`\n",
      "type": "string",
      "example": "my-api-v1",
      "nullable": true,
      "pattern": "^[\\w-]+$",
      "x-speakeasy-param-computed": true
    },
    "api_spec_ids": {
      "description": "The list of API specification ids for the API.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid",
        "description": "The id of the API specification.",
        "example": "123e4567-e89b-12d3-a456-426614174000"
      },
      "deprecated": true,
      "readOnly": true
    },
    "portals": {
      "description": "The list of portals which this API is published to.",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "id",
          "name",
          "display_name"
        ],
        "properties": {
          "id": {
            "description": "The portal identifier.",
            "type": "string",
            "format": "uuid",
            "example": "25a2624c-49fc-4764-99e1-224ed819f200"
          },
          "name": {
            "description": "The name of the portal, used to distinguish it from other portals.",
            "type": "string",
            "example": "My Portal"
          },
          "display_name": {
            "description": "The display name of the portal. This value will be the portal's `name` in Portal API.",
            "type": "string",
            "example": "My Portal"
          }
        }
      },
      "nullable": false,
      "readOnly": true,
      "uniqueItems": true
    },
    "labels": {
      "$ref": "#/components/schemas/Labels"
    },
    "implementation_mode": {
      "description": "the implementations that are associated with this api either gateway_entity_binding or access_control_enforcement",
      "type": "string",
      "nullable": true,
      "readOnly": true
    },
    "attributes": {
      "$ref": "#/components/schemas/ApiAttributes"
    },
    "created_at": {
      "$ref": "#/components/schemas/CreatedAt"
    },
    "updated_at": {
      "$ref": "#/components/schemas/UpdatedAt"
    }
  },
  "additionalProperties": false,
  "required": [
    "id",
    "name",
    "version",
    "labels",
    "created_at",
    "updated_at",
    "slug",
    "portals",
    "api_spec_ids",
    "current_version_summary"
  ]
}