Konnect regional consumers admin api (0.0.1)

Download OpenAPI specification:Download

realms

List realms

list realms

Authorizations:

bearerAuth

query Parameters

page[size]	integer Example: page[size]=10 The maximum number of items to include per page. The last page of a collection may include fewer items.
page[before]	string Example: page[before]=ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ Request the next page of data, starting with the item before this parameter.
page[after]	string Example: page[after]=ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ Request the next page of data, starting with the item after this parameter.

Responses

Response samples

200

Content type

application/json

{"data": [{"id": "string",
"name": "string",
"ttl": 0,
"negative_ttl": 0,
"consumer_groups": ["string"
],
"allowed_control_planes": ["string"
],
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z"
}
],
"meta": {"next": "string",
"previous": "string",
"size": 10
}
}

Create a realm

create realm

Authorizations:

bearerAuth

Request Body schema: application/json

name required	string
allowed_control_planes	Array of strings (AllowedControlPlanes) [ items unique ] List of control plane ids that are allowed to use the realm. An entry with '*' makes all control planes able to use the given realm.
ttl	integer >= 5 Default: 10 Time to Live in minutes of the consumer for this realm in the gateway cache.
negative_ttl	integer >= 5 Default: 10 Time to Live in minutes of the negative consumer for this realm in the gateway cache.
consumer_groups	Array of strings (ConsumerGroups) [ items unique ]

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"allowed_control_planes": ["string"
],
"ttl": 10,
"negative_ttl": 10,
"consumer_groups": ["string"
]
}

Response samples

201

Content type

application/json

{"id": "string",
"name": "string",
"ttl": 0,
"negative_ttl": 0,
"consumer_groups": ["string"
],
"allowed_control_planes": ["string"
],
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z"
}

Get a realm

get realm

Authorizations:

bearerAuth

path Parameters

realmId

required

string <uuid>

Id of the realm

Responses

Response samples

200

Content type

application/json

{"id": "string",
"name": "string",
"ttl": 0,
"negative_ttl": 0,
"consumer_groups": ["string"
],
"allowed_control_planes": ["string"
],
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z"
}

Update a realm

update realm

Authorizations:

bearerAuth

path Parameters

realmId

required

string <uuid>

Id of the realm

Request Body schema: application/json

name	string
allowed_control_planes	Array of strings (AllowedControlPlanes) [ items unique ] List of control plane ids that are allowed to use the realm. An entry with '*' makes all control planes able to use the given realm.
consumer_groups	Array of strings (ConsumerGroups) [ items unique ]
ttl	integer >= 5 Time to Live in minutes of the consumer for this realm in the gateway cache.
negative_ttl	integer >= 5 Time to Live in minutes of the negative consumer for this realm in the gateway cache

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"allowed_control_planes": ["string"
],
"consumer_groups": ["string"
],
"ttl": 5,
"negative_ttl": 5
}

Response samples

200

Content type

application/json

{"id": "string",
"name": "string",
"ttl": 0,
"negative_ttl": 0,
"consumer_groups": ["string"
],
"allowed_control_planes": ["string"
],
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z"
}

Delete a realm

delete realm

Authorizations:

bearerAuth

path Parameters

realmId

required

string <uuid>

Id of the realm

query Parameters

force

string

Default: "false"

Enum: "true" "false"

If true, delete specified realm and all underlying entities (consumers/apiKeys). If false, do not allow deletion if there are underlying entities.

Responses

Response samples

400
404

Content type

application/problem+json

{"status": 0,
"title": "string",
"type": "string",
"instance": "string",
"detail": "string",
"invalid_parameters": [{"field": "name",
"rule": "required",
"source": "body",
"reason": "is a required field"
}
]
}

regional-consumers

regional consumers

List realm consumers

list realm consumers

Authorizations:

bearerAuth

query Parameters

page[size]	integer Example: page[size]=10 The maximum number of items to include per page. The last page of a collection may include fewer items.
page[before]	string Example: page[before]=ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ Request the next page of data, starting with the item before this parameter.
page[after]	string Example: page[after]=ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ Request the next page of data, starting with the item after this parameter.
	object (RealmConsumerFilterParameters) Filters Consumers in the response.

Responses

Response samples

200

Content type

application/json

{"data": [{"id": "b9e81174-b5bb-4638-a3c3-8afe61a0abf8",
"username": "string",
"custom_id": "string",
"type": "string",
"tags": ["string"
],
"consumer_groups": ["string"
],
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z",
"realm_id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7"
}
],
"meta": {"next": "string",
"previous": "string",
"size": 10
}
}

List consumers

list consumers

Authorizations:

bearerAuth

path Parameters

realmId

required

string <uuid>

Id of the realm

query Parameters

page[size]	integer Example: page[size]=10 The maximum number of items to include per page. The last page of a collection may include fewer items.
page[before]	string Example: page[before]=ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ Request the next page of data, starting with the item before this parameter.
page[after]	string Example: page[after]=ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ Request the next page of data, starting with the item after this parameter.
	object (ConsumerFilterParameters) Filters Consumers in the response.

Responses

United-States Production region

https://us.api.konghq.com/v1/realms/{realmId}/consumers

Europe Production region

https://eu.api.konghq.com/v1/realms/{realmId}/consumers

Australia Production region

https://au.api.konghq.com/v1/realms/{realmId}/consumers

Middle-East Production region

https://me.api.konghq.com/v1/realms/{realmId}/consumers

India Production region

https://in.api.konghq.com/v1/realms/{realmId}/consumers

Response samples

200
404

Content type

application/json

{"data": [{"id": "b9e81174-b5bb-4638-a3c3-8afe61a0abf8",
"username": "string",
"custom_id": "string",
"type": "string",
"tags": ["string"
],
"consumer_groups": ["string"
],
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z"
}
],
"meta": {"next": "string",
"previous": "string",
"size": 10
}
}

Create a consumer

create consumer

Authorizations:

bearerAuth

path Parameters

realmId

required

string <uuid>

Id of the realm

Request Body schema: application/json

username required	string
consumer_groups	Array of strings (ConsumerGroups) [ items unique ]
custom_id	string
type	string
tags	Array of strings (Tags) unique

Responses

United-States Production region

https://us.api.konghq.com/v1/realms/{realmId}/consumers

Europe Production region

https://eu.api.konghq.com/v1/realms/{realmId}/consumers

Australia Production region

https://au.api.konghq.com/v1/realms/{realmId}/consumers

Middle-East Production region

https://me.api.konghq.com/v1/realms/{realmId}/consumers

India Production region

https://in.api.konghq.com/v1/realms/{realmId}/consumers

Request samples

Payload

Content type

application/json

{"username": "string",
"consumer_groups": ["string"
],
"custom_id": "string",
"type": "string",
"tags": ["string"
]
}

Response samples

201
400
404

Content type

application/json

{"id": "b9e81174-b5bb-4638-a3c3-8afe61a0abf8",
"username": "string",
"custom_id": "string",
"type": "string",
"tags": ["string"
],
"consumer_groups": ["string"
],
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z"
}

Get a consumer

get consumer

Authorizations:

bearerAuth

path Parameters

realmId required	string <uuid> Id of the realm
consumerId required	string Id of the of the consumer

Responses

United-States Production region

https://us.api.konghq.com/v1/realms/{realmId}/consumers/{consumerId}

Europe Production region

https://eu.api.konghq.com/v1/realms/{realmId}/consumers/{consumerId}

Australia Production region

https://au.api.konghq.com/v1/realms/{realmId}/consumers/{consumerId}

Middle-East Production region

https://me.api.konghq.com/v1/realms/{realmId}/consumers/{consumerId}

India Production region

https://in.api.konghq.com/v1/realms/{realmId}/consumers/{consumerId}

Response samples

200
404

Content type

application/json

{"id": "b9e81174-b5bb-4638-a3c3-8afe61a0abf8",
"username": "string",
"custom_id": "string",
"type": "string",
"tags": ["string"
],
"consumer_groups": ["string"
],
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z"
}

Update a consumer

update consumer

Authorizations:

bearerAuth

path Parameters

realmId required	string <uuid> Id of the realm
consumerId required	string Id of the of the consumer

Request Body schema: application/json

custom_id	string
username	string
type	string
tags	Array of strings (Tags) unique
consumer_groups	Array of strings (ConsumerGroups) [ items unique ]

Responses

United-States Production region

https://us.api.konghq.com/v1/realms/{realmId}/consumers/{consumerId}

Europe Production region

https://eu.api.konghq.com/v1/realms/{realmId}/consumers/{consumerId}

Australia Production region

https://au.api.konghq.com/v1/realms/{realmId}/consumers/{consumerId}

Middle-East Production region

https://me.api.konghq.com/v1/realms/{realmId}/consumers/{consumerId}

India Production region

https://in.api.konghq.com/v1/realms/{realmId}/consumers/{consumerId}

Request samples

Payload

Content type

application/json

{"custom_id": "string",
"username": "string",
"type": "string",
"tags": ["string"
],
"consumer_groups": ["string"
]
}

Response samples

200
400
404

Content type

application/json

{"id": "b9e81174-b5bb-4638-a3c3-8afe61a0abf8",
"username": "string",
"custom_id": "string",
"type": "string",
"tags": ["string"
],
"consumer_groups": ["string"
],
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z"
}

Delete a consumer

delete consumer

Authorizations:

bearerAuth

path Parameters

realmId required	string <uuid> Id of the realm
consumerId required	string Id of the of the consumer

Responses

United-States Production region

https://us.api.konghq.com/v1/realms/{realmId}/consumers/{consumerId}

Europe Production region

https://eu.api.konghq.com/v1/realms/{realmId}/consumers/{consumerId}

Australia Production region

https://au.api.konghq.com/v1/realms/{realmId}/consumers/{consumerId}

Middle-East Production region

https://me.api.konghq.com/v1/realms/{realmId}/consumers/{consumerId}

India Production region

https://in.api.konghq.com/v1/realms/{realmId}/consumers/{consumerId}

Change the realm of a consumer

move consumer

Authorizations:

bearerAuth

path Parameters

realmId required	string <uuid> Id of the realm
consumerId required	string Id of the of the consumer

Request Body schema: application/json

target_realm_id

required

string

Responses

United-States Production region

https://us.api.konghq.com/v1/realms/{realmId}/consumers/{consumerId}/move

Europe Production region

https://eu.api.konghq.com/v1/realms/{realmId}/consumers/{consumerId}/move

Australia Production region

https://au.api.konghq.com/v1/realms/{realmId}/consumers/{consumerId}/move

Middle-East Production region

https://me.api.konghq.com/v1/realms/{realmId}/consumers/{consumerId}/move

India Production region

https://in.api.konghq.com/v1/realms/{realmId}/consumers/{consumerId}/move

Request samples

Payload

Content type

application/json

{"target_realm_id": "string"
}

Response samples

201
400
404

Content type

application/json

{"realm_id": "string"
}

keys

List keys

list keys

Authorizations:

bearerAuth

path Parameters

realmId required	string <uuid> Id of the realm
consumerId required	string Id of the of the consumer

query Parameters

page[size]	integer Example: page[size]=10 The maximum number of items to include per page. The last page of a collection may include fewer items.
page[before]	string Example: page[before]=ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ Request the next page of data, starting with the item before this parameter.
page[after]	string Example: page[after]=ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ Request the next page of data, starting with the item after this parameter.

Responses

United-States Production region

https://us.api.konghq.com/v1/realms/{realmId}/consumers/{consumerId}/keys

Europe Production region

https://eu.api.konghq.com/v1/realms/{realmId}/consumers/{consumerId}/keys

Australia Production region

https://au.api.konghq.com/v1/realms/{realmId}/consumers/{consumerId}/keys

Middle-East Production region

https://me.api.konghq.com/v1/realms/{realmId}/consumers/{consumerId}/keys

India Production region

https://in.api.konghq.com/v1/realms/{realmId}/consumers/{consumerId}/keys

Response samples

200
404

Content type

application/json

{"data": [{"id": "string",
"created_at": "2022-11-04T20:10:06.927Z",
"tags": ["string"
],
"type": "legacy"
}
],
"meta": {"next": "string",
"previous": "string",
"size": 10
}
}

Create a key

create key

Authorizations:

bearerAuth

path Parameters

realmId required	string <uuid> Id of the realm
consumerId required	string Id of the of the consumer

Request Body schema: application/json

One of

type	string Default: "new" Value: "new"
tags	Array of strings (Tags) unique

Responses

United-States Production region

https://us.api.konghq.com/v1/realms/{realmId}/consumers/{consumerId}/keys

Europe Production region

https://eu.api.konghq.com/v1/realms/{realmId}/consumers/{consumerId}/keys

Australia Production region

https://au.api.konghq.com/v1/realms/{realmId}/consumers/{consumerId}/keys

Middle-East Production region

https://me.api.konghq.com/v1/realms/{realmId}/consumers/{consumerId}/keys

India Production region

https://in.api.konghq.com/v1/realms/{realmId}/consumers/{consumerId}/keys

Request samples

Payload

Content type

application/json

Example

CreateApiKeyPayloadNew

{"type": "new",
"tags": ["string"
]
}

Response samples

201
400
404

Content type

application/json

{"id": "string",
"type": "legacy",
"secret": "string",
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z",
"tags": ["string"
]
}

Get a key

get key

Authorizations:

bearerAuth

path Parameters

realmId required	string <uuid> Id of the realm
consumerId required	string Id of the of the consumer
keyId required	string Id of the key

Responses

United-States Production region

https://us.api.konghq.com/v1/realms/{realmId}/consumers/{consumerId}/keys/{keyId}

Europe Production region

https://eu.api.konghq.com/v1/realms/{realmId}/consumers/{consumerId}/keys/{keyId}

Australia Production region

https://au.api.konghq.com/v1/realms/{realmId}/consumers/{consumerId}/keys/{keyId}

Middle-East Production region

https://me.api.konghq.com/v1/realms/{realmId}/consumers/{consumerId}/keys/{keyId}

India Production region

https://in.api.konghq.com/v1/realms/{realmId}/consumers/{consumerId}/keys/{keyId}

Response samples

200
404

Content type

application/json

{"id": "string",
"created_at": "2022-11-04T20:10:06.927Z",
"tags": ["string"
],
"type": "legacy"
}

Delete a key

delete key

Authorizations:

bearerAuth

path Parameters

realmId required	string <uuid> Id of the realm
consumerId required	string Id of the of the consumer
keyId required	string Id of the key

Responses

United-States Production region

https://us.api.konghq.com/v1/realms/{realmId}/consumers/{consumerId}/keys/{keyId}

Europe Production region

https://eu.api.konghq.com/v1/realms/{realmId}/consumers/{consumerId}/keys/{keyId}

Australia Production region

https://au.api.konghq.com/v1/realms/{realmId}/consumers/{consumerId}/keys/{keyId}

Middle-East Production region

https://me.api.konghq.com/v1/realms/{realmId}/consumers/{consumerId}/keys/{keyId}

India Production region

https://in.api.konghq.com/v1/realms/{realmId}/consumers/{consumerId}/keys/{keyId}