Delete System Account

Deletes the specified system account. Returns 404 if the requested account was not found.

delete
https://global.api.konghq.com/v3/system-accounts/{accountId}

Path Parameters

accountIdstringrequired

ID of the system account.

Response

No Content

delete/system-accounts/{accountId}
 

System Accounts - Access Tokens

List System Account Access Tokens

Returns the access tokens for the specified system account. Returns 400 if any filter parameters are invalid.

get
https://global.api.konghq.com/v3/system-accounts/{accountId}/access-tokens

Query Parameters

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[number]integer

Determines which page of the entities to retrieve.

Example:1

filterobject

Filter access tokens returned in the response.

Show Child Parameters

Path Parameters

accountIdstringrequired

ID of the system account.

Response

application/json

A paginated list response for a collection of system accounts access tokens.

System Account Access Token Collection Reponse

metaobject

returns the pagination information

Show Child Parameters
dataarray[object]

Schema of the system account access token.

Example:{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","name":"Sample Access Token","created_at":"2022-08-01T14:16:09Z","updated_at":"2022-08-02T08:35:49Z","expires_at":"2022-12-31T12:52:23Z","last_used_at":"2022-10-24T13:05:42Z"}

Show Child Parameters
get/system-accounts/{accountId}/access-tokens
 
application/json

Create System Account Access Token

Creates an access token for the specified system account (SA). The access token can be used for authenticating API and CLI requests. The token will only be displayed once on creation. Returns a 409 if the system account already has a token with the same name.

post
https://global.api.konghq.com/v3/system-accounts/{accountId}/access-tokens

Path Parameters

accountIdstringrequired

ID of the system account.

Body

application/json

The request body to create a system account access token.

namestringrequired
expires_atstring(date-time)required

Response

application/json

A response including a single system account access token with the token.

System Account Access Token Created Response

idstring(uuid)read-only

ID of the system account access token.

namestring

Name of the system account access token.

created_atstring(date-time)read-only

Timestamp of when the system account access token was created.

updated_atstring(date-time)read-only

Timestamp of when the system account access token was last updated.

expires_atstring(date-time)read-only

Timestamp of when the system account access token will expire.

last_used_atstring(date-time)read-only

Timestamp of when the system account access token was last used.

tokenstringread-only

The token of the system account access token.

post/system-accounts/{accountId}/access-tokens

Body

{ "name": "Sample Access Token", "expires_at": "2019-08-24T14:15:22Z" }
 
application/json

Get a System Account Access Token

Returns the system account (SA) access token for the SA Access Token ID specified as a path parameter.

get
https://global.api.konghq.com/v3/system-accounts/{accountId}/access-tokens/{tokenId}

Path Parameters

accountIdstringrequired

ID of the system account.

tokenIdstringrequired

ID of the system account access token.

Response

application/json

A response including a single system account access token.

System Account Access Token

Schema of the system account access token.

idstring(uuid)read-only

ID of the system account access token.

namestring

Name of the system account access token.

created_atstring(date-time)read-only

Timestamp of when the system account access token was created.

updated_atstring(date-time)read-only

Timestamp of when the system account access token was last updated.

expires_atstring(date-time)

Timestamp of when the system account access token will expire.

last_used_atstring(date-time)read-only

Timestamp of when the system account access token was last used.

get/system-accounts/{accountId}/access-tokens/{tokenId}
 
application/json