1.0.1OAS 3.0

API for managing entitlements for an organization.

API Base URL
  • Server 1:https://global.api.konghq.com/v1

    Global Base URL

Security
konnectAccessToken (http)

The Konnect access token is meant to be used by the Konnect dashboard and the decK CLI authenticate with.

Additional Information
Contact Kong

Entitlements

Manage entitlements for an organization

Get all entitlements for an organization

Get all entitlements for an organization

get
https://global.api.konghq.com/v1/entitlements

Response

application/json

A list of entitlements for the organization

OrganizationEntitlements

default_regionsarray[string]requiredread-onlyunique-items

A region that is always enabled

Allowed values:useuaumein

opted_in_regionsarray[string]requiredunique-items

A region that can be optionally enabled

Allowed values:sg

>= 1 items

featuresobjectrequired

Map of feature names to their settings

Show Child Parameters
get/entitlements
 
application/json

Update entitlements for an organization

Update entitlements for an organization

patch
https://global.api.konghq.com/v1/entitlements

Body

application/json

Request body for updating entitlements

opted_in_regionsarray[string]unique-items

A region that can be optionally enabled

Allowed values:sg

>= 1 items

featuresobject

Feature request body for updating user features

Show Child Parameters

Response

application/json

A list of entitlements for the organization

OrganizationEntitlements

default_regionsarray[string]requiredread-onlyunique-items

A region that is always enabled

Allowed values:useuaumein

opted_in_regionsarray[string]requiredunique-items

A region that can be optionally enabled

Allowed values:sg

>= 1 items

featuresobjectrequired

Map of feature names to their settings

Show Child Parameters
patch/entitlements

Body

{ "opted_in_regions": [ "sg" ], "features": { "ai": { "enabled": { "value": false } }, "mcp": { "enabled": { "value": false } } } }
 
application/json

DefaultRegion

string

A region that is always enabled

Allowed values:useuaumein