Sign in

v28

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-263064641.4 MB
API

Update API

Updates an API.

patch/v3/apis/{apiId}

Query parameters

force'true' | 'false'

If true, allows operations to be removed from the current version when using access control enforcement. If false, operations removal will be rejected with a 409 error. Omitting the value means true.

Request body

idstring uuid

The API identifier.

namestring nullable

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

descriptionstring nullable

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

versionstring nullable

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

slugstring nullable

The slug is used in generated URLs to provide human readable paths.

Defaults to slugify(name + version)

api_spec_idsstring[]

The list of API specification ids for the API.

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

implementation_modestring nullable

the implementations that are associated with this api either gateway_entity_binding or access_control_enforcement

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": "MyAPI",
  "current_version_summary": {
    "id": "7710d5c4-d902-410b-992f-18b814155b53",
    "spec": {
      "type": "oas3",
      "provider": {
        "config": {
          "url": "https://api.petstore.com/v3/openapi.json"
        }
      }
    },
    "created_at": "2022-11-04T20:10:06.927Z",
    "updated_at": "2022-11-04T20:10:06.927Z"
  },
  "slug": "my-api-v1",
  "api_spec_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "portals": [
    {
      "id": "25a2624c-49fc-4764-99e1-224ed819f200",
      "name": "My Portal",
      "display_name": "My Portal"
    }
  ],
  "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

idstring uuid required

The API identifier.

namestring required

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

descriptionstring nullable

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

versionstring nullable required

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

slugstring nullable required

The slug is used in generated URLs to provide human readable paths.

Defaults to slugify(name + version)

api_spec_idsstring[] required

The list of API specification ids for the API.

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

implementation_modestring nullable

the implementations that are associated with this api either gateway_entity_binding or access_control_enforcement

attributesApiAttributes

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": "MyAPI",
  "current_version_summary": {
    "id": "7710d5c4-d902-410b-992f-18b814155b53",
    "spec": {
      "type": "oas3",
      "provider": {
        "config": {
          "url": "https://api.petstore.com/v3/openapi.json"
        }
      }
    },
    "created_at": "2022-11-04T20:10:06.927Z",
    "updated_at": "2022-11-04T20:10:06.927Z"
  },
  "slug": "my-api-v1",
  "api_spec_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "portals": [
    {
      "id": "25a2624c-49fc-4764-99e1-224ed819f200",
      "name": "My Portal",
      "display_name": "My Portal"
    }
  ],
  "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",
  "images": {
    "icon": {
      "uri": "/apis/ebbac5b0-ac89-45c3-9d2e-c4542c657e79/images/icon/raw"
    }
  }
}