ACLs3

Add-Ons4

AI Gateway Agents4

AI Gateway Auth Strategies4

AI Gateway CA Certificates4

AI Gateway Certificates4

AI Gateway Config Stores8

AI Gateway Consumer Groups6

AI Gateway Consumers7

AI Gateway Custom Policies4

AI Gateway DataPlane Certificates3

AI Gateway MCP Servers4

AI Gateway Model Providers4

AI Gateway Models4

AI Gateway Policies4

AI Gateway SNIs4

AI Gateway Vaults4

AI Gateways4

API4

API Documentation4

API Implementation3

API Product Documentation4

API Product Version Specification4

API Product Versions4

API Products4

API Publication3

API Specification4

API Version4

API-keys3

App Auth Strategies4

Application Registrations4

Applications4

Assets4

Audit Logs7

Auth Server4

Auth Server Claims4

Auth Server Clients8

Auth Server Scopes4

Auth Settings10

Basic-auth credentials3

CA Certificates4

Catalog AI Model Implementations3

Catalog AI Model Specs3

Catalog AI Model Versions4

Catalog AI Models4

Catalog MCP Implementations3

Catalog MCP Versions4

Catalog MCPs4

Catalog Services4

Centrally Managed Consumers4

Centrally Managed Keys3

Certificates4

Cloned Plugins4

CMEK3

Config Store Secrets4

Config Stores4

Consumer Groups6

Consumers4

Control Plane Groups2

Control Planes6

Custom Domains3

Custom Plugin Schemas4

CustomPlugins4

Data-Plane Group Configurations2

DCR Providers4

DP Certificates4

Event Gateway Backend Clusters4

Event Gateway DataPlane Certificates4

Event Gateway Listener Policies8

Event Gateway Listeners4

Event Gateway Schema Registries4

Event Gateway Static Keys3

Event Gateway TLS Trust Bundles4

Event Gateway Virtual Cluster Consume Policies20

Event Gateway Virtual Cluster Policies4

Event Gateway Virtual Cluster Produce Policies16

Event Gateway Virtual Clusters4

Event Gateways4

GraphQL Cost Decorations1

HMAC-auth credentials3

Integration Instance Auth Config3

Integration Instance Auth Credentials3

Integration Instances4

JWTs3

Keys4

KeySets4

Mesh5

MTLS-auth credentials3

Networks5

Pages4

Partials4

Personal Access Tokens2

Platform IPs1

Platform Regions1

Plugins453

Portal Appearance2

Portal Audit Logs3

Portal Auth Settings9

Portal Custom Domains4

Portal Customization2

Portal Developers4

Portal Product Versions3

Portal Team Membership2

Portal Team Roles2

Portal Teams4

Portals10

Portals IP Allow List4

Private DNS3

Provider Accounts1

Realms4

Roles6

Routes8

Serverless Cloud Gateways3

Services4

Snippets4

SNIs4

System Accounts5

System Accounts - Access Tokens4

System Accounts - Roles3

System Accounts - Team Membership2

Targets3

Team Membership2

Teams5

Transit Gateways4

Upstreams4

Vaults4

patch/v3/authentication-settings#deleteReset Auth Settings

API

Update API

Changed on Sep 30, 2026

Updates an API.

patch/v3/apis/{apiId}

Request

Base URL: https://global.api.konghq.com
URL: https://global.api.konghq.com/v3/apis/{apiId}
Auth: one of:
- HTTP bearer
- HTTP bearer
- HTTP bearer
- HTTP bearer

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"
    },
    "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"
    },
    "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"
}

Changes

Sep 30, 2026f530bf400198 Revision 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
- warning
  added the new 404.00 enum value to the response property for the response status
- warning
  added the new 409.00 enum value to the response property for the response status
Sep 25, 20264a02153f2e60 Revision changes
- breaking
  the response's body type changed from no type to object for status
- breaking
  the response's body type changed from no type to object for status
- breaking
  the response's body type changed from no type to object for status
- breaking
  the response's body type changed from no type to object for status
- breaking
  the response's body type changed from no type to object for status
- breaking
  the response's body type changed from no type to object for status
- info
  removed subschema #2 from the response body allOf list for the response status
- info
  removed subschema #2 from the response body allOf list for the response status
- info
  removed subschema #2 from the response body allOf list for the response status
- info
  removed subschema #2 from the response body allOf list for the response status
- info
  removed subschema #2 from the response body allOf list for the response status
- info
  removed subschema #2 from the response body allOf list for the response status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status

Operation history (8 revisions)