Kong · Schema

API Package

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

Properties

Name	Type	Description
id	string	The API Package identifier.
name	string	The name of your API Package. The `name + version` combination must be unique for each API Package you publish.
description	string	A description of your API Package. Will be visible on your live Portal.
slug	string	The unique slug for your API Package, It should be unique across all APIs and API Packages.
version	string	An optional version for your API Package. Leave this empty if your API Package is unversioned.
rate_limiting_config	object
labels	object
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/ApiPackageResponseSchema",
  "title": "API Package",
  "type": "object",
  "properties": {
    "id": {
      "description": "The API Package identifier.",
      "type": "string",
      "format": "uuid",
      "example": "9f5061ce-78f6-4452-9108-ad7c02821fd5",
      "readOnly": true
    },
    "name": {
      "description": "The name of your API Package. The `name + version` combination must be unique for each API Package you publish.\n",
      "type": "string",
      "example": "MyAPIPackage",
      "maxLength": 255,
      "minLength": 1
    },
    "description": {
      "description": "A description of your API Package. Will be visible on your live Portal.",
      "type": "string",
      "nullable": true
    },
    "slug": {
      "description": "The unique slug for your API Package, It should be unique across all APIs and API Packages.\n",
      "type": "string",
      "example": "my-api-package-v1",
      "nullable": true,
      "pattern": "^[\\w-]+$"
    },
    "version": {
      "description": "An optional version for your API Package. Leave this empty if your API Package is unversioned.",
      "type": "string",
      "maxLength": 255,
      "minLength": 1,
      "nullable": true
    },
    "rate_limiting_config": {
      "$ref": "#/components/schemas/RateLimitingConfig"
    },
    "labels": {
      "$ref": "#/components/schemas/Labels"
    },
    "attributes": {
      "$ref": "#/components/schemas/ApiAttributes"
    },
    "created_at": {
      "$ref": "#/components/schemas/CreatedAt"
    },
    "updated_at": {
      "$ref": "#/components/schemas/UpdatedAt"
    }
  },
  "additionalProperties": false,
  "required": [
    "id",
    "name",
    "slug",
    "version",
    "labels",
    "attributes",
    "created_at",
    "updated_at",
    "rate_limiting_config"
  ]
}