---
title: "API Package"
url: "https://nov18-dev.movespot.fyi/apis/konnect-api-catalog-dev-3/versions/b2fc1681-05e8-4b55-9b8c-8bbcc7654d1b/schemas/ApiPackageResponseSchema"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-api-catalog-dev-3/versions/b2fc1681-05e8-4b55-9b8c-8bbcc7654d1b.md

# API Package

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Konnect API Catalog
  version: 3.1.2
servers:
  - url: https://us.api.konghq.com/v3
    description: United-States Production region
  - url: https://eu.api.konghq.com/v3
    description: Europe Production region
  - url: https://au.api.konghq.com/v3
    description: Australia Production region
  - url: https://me.api.konghq.com/v3
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v3
    description: India Production region
  - url: https://sg.api.konghq.com/v3
    description: Singapore Production region
components:
  schemas:
    RateLimitingConfig:
      description: Rate limit configuration that can be applied to an API Package or
        an API Package Operation.
      type: object
      properties:
        limit:
          description: The amount of requests allowed for each operation within the
            specified duration.
          type: integer
          minimum: 0
        duration:
          description: The timeframe to ensure that an application does not exceed the
            request limit.
          type: string
          enum:
            - seconds
            - minutes
            - hours
      additionalProperties: false
      nullable: true
      required:
        - limit
        - duration
      title: Rate Limiting configuration
    Labels:
      description: >
        Labels store metadata of an entity that can be used for filtering an
        entity list or for searching across entity types. 


        Keys must be of length 1-63 characters, and cannot start with "kong",
        "konnect", "mesh", "kic", or "_".
      type: object
      example:
        env: test
      additionalProperties:
        type: string
        pattern: ^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$
        minLength: 1
        maxLength: 63
      maxProperties: 50
      title: Labels
    ApiAttributes:
      description: A set of attributes that describe the API
      type: object
      example:
        env:
          - production
        domains:
          - web
          - mobile
      default: {}
      additionalProperties:
        nullable: true
        description: Set of attributes with unique keys. Each key can include lowercase
          letters, numbers, hyphens, and underscores.
        type: array
        minItems: 1
        maxItems: 20
        items:
          type: string
          minLength: 1
          maxLength: 512
          pattern: ^[^,<>]*$
      nullable: false
      title: API Attributes
    CreatedAt:
      description: An ISO-8601 timestamp representation of entity creation date.
      type: string
      format: date-time
      example: 2022-11-04T20:10:06.927Z
      readOnly: true
    UpdatedAt:
      description: An ISO-8601 timestamp representation of entity update date.
      type: string
      format: date-time
      example: 2022-11-04T20:10:06.927Z
      readOnly: true
    ApiPackageResponseSchema:
      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.
          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.
          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"
        images:
          type: object
          example:
            icon:
              uri: /apis/ebbac5b0-ac89-45c3-9d2e-c4542c657e79/images/icon/raw
          additionalProperties: false
          nullable: true
          properties:
            icon:
              type: object
              additionalProperties: false
              nullable: true
              properties:
                uri:
                  description: The relative API path for retrieving the raw the icon image.
                  type: string
                  format: uri-reference
                  nullable: true
                  pattern: ^/[^\s]+/images/icon/raw$
          readOnly: true
          title: Images
      additionalProperties: false
      required:
        - id
        - name
        - slug
        - version
        - labels
        - attributes
        - created_at
        - updated_at
        - rate_limiting_config
      title: API Package
```
