API Packages

Patch API Package

Changed on

Updates an existing API package. You can modify the name, description and version of the API Package.

patch/v3/api-packages/{packageId}

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v3/api-packages/{packageId}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Request body

idstring uuid

The API Package identifier.

namestring

The name of your API Package. The name + version combination must be unique for each API Package you publish.

descriptionstring nullable

A description of your API Package. Will be visible on your live Portal.

slugstring nullable

The unique slug for your API Package, It should be unique across all APIs and API Packages.

versionstring nullable

An optional version for your API Package. Leave this empty if your API Package is unversioned.

labelsLabelsUpdate nullable

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Labels are intended to store INTERNAL metadata.

Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".

attributesApiAttributes

A set of attributes that describe the API

created_atstring date-time

An ISO-8601 timestamp representation of entity creation date.

updated_atstring date-time

An ISO-8601 timestamp representation of entity update date.

Example request

{
  "id": "9f5061ce-78f6-4452-9108-ad7c02821fd5",
  "name": "MyAPIPackage",
  "slug": "my-api-package-v1",
  "labels": {
    "env": "test"
  },
  "attributes": {
    "env": [
      "production"
    ],
    "domains": [
      "web",
      "mobile"
    ]
  },
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_at": "2022-11-04T20:10:06.927Z"
}

Response

API Package

idstring uuid required

The API Package identifier.

namestring required

The name of your API Package. The name + version combination must be unique for each API Package you publish.

descriptionstring nullable

A description of your API Package. Will be visible on your live Portal.

slugstring nullable required

The unique slug for your API Package, It should be unique across all APIs and API Packages.

versionstring nullable required

An optional version for your API Package. Leave this empty if your API Package is unversioned.

labelsLabels required

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 "_".

attributesApiAttributes required

A set of attributes that describe the API

created_atstring date-time required

An ISO-8601 timestamp representation of entity creation date.

updated_atstring date-time required

An ISO-8601 timestamp representation of entity update date.

Example response

{
  "id": "9f5061ce-78f6-4452-9108-ad7c02821fd5",
  "name": "MyAPIPackage",
  "slug": "my-api-package-v1",
  "labels": {
    "env": "test"
  },
  "attributes": {
    "env": [
      "production"
    ],
    "domains": [
      "web",
      "mobile"
    ]
  },
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_at": "2022-11-04T20:10:06.927Z"
}

Changes

  • 7aab863a6daaRevision changes
    • breaking

      added to the / response property oneOf list for the response status

    • warning

      added the new key_invalid enum value to the ////// response property for the response status

    • warning

      added the new unique enum value to the ////// response property for the response status

  • 68d43091b84dRevision changes
    • warning

      added the new 400.00 enum value to the response property for the response status

    • warning

      added the new 401.00 enum value to the response property for the response status

    • warning

      added the new 403.00 enum value to the response property for the response status