3.0.0OAS 3.0

Konnect Organizations API.

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

    Global Base URL

Security
personalAccessToken (http)

The personal access token is meant to be used as an alternative to basic-auth when accessing Konnect via APIs.
You can generate a Personal Access Token (PAT) from the personal access token page in the Konnect dashboard.
The PAT token must be passed in the header of a request, for example:
curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer kpat_xgfT...'

konnectAccessToken (http)

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

serviceAccessToken (http)

The Service access token is meant to be used between internal services.

Additional Information
Contact Kong

Organizations

API related to the management of Konnect Organizations

Set the ip allow list for organization

Sets the ip allow list for an organization.

put
https://global.api.konghq.com/v3/organizations/{organizationId}/ip-allow-list

Path Parameters

organizationIdstring(uuid)requiredread-only

UUID representing an organization.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

Body

application/json

The request schema to set an organization’s ip allow list configuration.

Organization Source IP Restriction

* Additional properties are NOT allowed.
enabledbooleanrequired

Whether ip allow list is enabled for the organization.

Default:false

Example:true

allowed_ipsarray[string]requiredunique-items

The list of allowed ips for the organization.

>= 1 items<= 1000 items

Example:["192.168.1.1","192.168.1.0/22"]

Response

application/json

The organization’s ip allow list configuration.

Organization Source IP Restriction

* Additional properties are NOT allowed.
enabledbooleanrequired

Whether ip allow list is enabled for the organization.

Default:false

Example:true

allowed_ipsarray[string]requiredunique-items

The list of allowed ips for the organization.

>= 1 items<= 1000 items

Example:["192.168.1.1","192.168.1.0/22"]

put/organizations/{organizationId}/ip-allow-list

Body

{ "enabled": true, "allowed_ips": [ "192.168.1.1", "192.168.1.0/22" ] }
 
application/json