Skip to content
Kong Docs are moving soon! Our docs are migrating to a new home. You'll be automatically redirected to the new site in the future. In the meantime, view this page on the new site!
|

DNS Status

Retrieve DNS worker and stats information. If the legacy DNS client is in use, it returns a 501 status with a message.

get
{protocol}://{hostname}:{port}{path}/status/dns

Response

application/json

DNS worker and stats information

workerobject

Worker information.

Show Child Parameters
statsobject

DNS stats information (specific details depend on the Kong instance).

get/status/dns
 
application/json

Retrieve Vault Schema

Retrieve the schema of a vault.

get
{protocol}://{hostname}:{port}{path}/schemas/vaults/{vault_name}

Path Parameters

vault_namestringrequired

The vault schema to be returned

Response

application/json

OK

Vault

Vault entities are used to configure different Vault connectors. Examples of Vaults are Environment Variables, HashiCorp Vault and AWS Secrets Manager. Configuring a Vault allows referencing the secrets with other entities. For example a certificate entity can store a reference to a certificate and key, stored in a vault, instead of storing the certificate and key within the entity. This allows a proper separation of secrets and configuration and prevents secret sprawl.

* Additional properties are NOT allowed.
configobjectrequired

The configuration properties for the Vault which can be found on the vaults’ documentation page.

* Additional properties are allowed.
created_atintegerread-only

Unix epoch when the resource was created.

descriptionstring | null

The description of the Vault entity.

idstring | null
namestringrequired

The name of the Vault that’s going to be added. Currently, the Vault implementation must be installed in every Kong instance.

prefixstringrequired

The unique prefix (or identifier) for this Vault configuration. The prefix is used to load the right Vault configuration and implementation when referencing secrets with the other entities.

tagsarray[string]

An optional set of strings associated with the Vault for grouping and filtering.

updated_atintegerread-only

Unix epoch when the resource was last updated.

get/schemas/vaults/{vault_name}
 
application/json

List Admins

Returns a list of admins. To query all admins, add a parameter all_workspaces=true to the /admins endpoint. The status field in the response indicates the state of the admins invitation. 0= Approved, 1= Pending, 2= Rejected, 3= Revoked, 4 = Invited, 5= Unverified.

get
{protocol}://{hostname}:{port}{path}/admins

Response

application/json

Example response

dataarray[object]
Show Child Parameters
next
get/admins
 
application/json

Invite an Admin

Invite an admin to your organization.

post
{protocol}://{hostname}:{port}{path}/admins

Body

application/json
emailstring

The admin’s email address.

Example:email@example.com

usernamestring

The admin’s username

Example:myusername

custom_idstring

The admin’s custom ID

rbac_token_enabledboolean

Allows the admin to use and reset their RBAC token.

Default:true

Response

application/json

OK

adminobject
Show Child Parameters
post/admins

Body

{
"username": "test-case-3",
"email": "test3@test.com",
"custom_id": "customId",
"rbac_token_enabled": true
}
 
application/json

Register an Admin’s Credentials

Register an Admin’s Credentials

post
{protocol}://{hostname}:{port}{path}/admins/register

Body

application/json
tokenstring
usernamestring
emailstring(email)
passwordstring(password)

Response

Created

post/admins/register

Body

{
"token": "string",
"username": "string",
"email": "user@example.com",
"password": "pa$$word"
}