v50

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-07-068428533.0 MB

API Products

Update an individual API product

Updates an API product.

patch/v2/api-products/{id}

Request body

namestring nullable

The name for the API product.

descriptionstring nullable

The description of the API product.

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

public_labelsPublicLabelsUpdate

Public labels store information about an entity that can be used for filtering a list of objects.

Public labels are intended to store PUBLIC metadata.

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

portal_idsstring[] required

The list of portal identifiers which this API product should be published to

Example request

{
  "name": "API Product",
  "description": "Text describing the API product",
  "labels": {
    "env": "test"
  },
  "public_labels": {
    "category": "finance"
  },
  "portal_ids": [
    "25a2624c-49fc-4764-99e1-224ed819f200"
  ]
}

Response

API product

idstring uuid required

The API product ID.

namestring required

The name of the API product

descriptionstring nullable required

The description of the API product

portal_idsstring[] required

The list of portal identifiers which this API product is published to. This property is deprecated and will be removed in a future version. Use the portals property instead.

version_countnumber required

The number of product versions attached to this API product

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.

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

public_labelsPublicLabels required

Public labels store information about an entity that can be used for filtering a list of objects.

Public labels are intended to store PUBLIC metadata.

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

Example response

{
  "id": "b9e81174-b5bb-4638-a3c3-8afe61a0abf8",
  "name": "My Name",
  "description": "MyDescription",
  "portal_ids": [
    "25a2624c-49fc-4764-99e1-224ed819f200"
  ],
  "portals": [
    {
      "portal_id": "35a2624c-49fc-4764-99e1-224ed819f200",
      "portal_name": "Developer Portal"
    }
  ],
  "version_count": 10,
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_at": "2022-11-04T20:10:06.927Z",
  "labels": {
    "env": "test"
  },
  "public_labels": {
    "category": "finance"
  }
}