Create System Account

Creates a system account. Returns a 409 if a system account with the same name already exists.

post
https://global.api.konghq.com/v3/system-accounts

Body

application/json

The request schema to create a system account.

namestringrequired

Name of the system account.

descriptionstringrequired

Description of the system account. Useful when the system account name is not sufficient to differentiate one system account from another.

konnect_managedboolean

The system account is managed by Konnect (true/false).

Response

application/json

A response including a single system account.

System Account

Schema of the system account.

idstring(uuid)read-only

ID of the system account.

namestring

Name of the system account.

descriptionstring

Description of the system account.

created_atstring(date-time)read-only

Timestamp of when the system account was created.

updated_atstring(date-time)read-only

Timestamp of when the system account was last updated.

konnect_managedboolean

The system account is managed by Konnect (true/false).

post/system-accounts

Body

{ "name": "Sample System Account", "description": "This is a sample system account description.", "konnect_managed": false }
 
application/json

Get a System Account

Returns the system account (SA) for the SA ID specified as a path parameter.

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

Path Parameters

accountIdstringrequired

ID of the system account.

Response

application/json

A response including a single system account.

System Account

Schema of the system account.

idstring(uuid)read-only

ID of the system account.

namestring

Name of the system account.

descriptionstring

Description of the system account.

created_atstring(date-time)read-only

Timestamp of when the system account was created.

updated_atstring(date-time)read-only

Timestamp of when the system account was last updated.

konnect_managedboolean

The system account is managed by Konnect (true/false).

get/system-accounts/{accountId}
 
application/json

Update System Account

Updates the specified system account. Returns a 409 if the updated name is the same as another system account in the organization.

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

Path Parameters

accountIdstringrequired

ID of the system account.

Body

application/json

The request schema for the update system account request.

namestring

Name of the system account.

descriptionstring

Description of the system account.

Response

application/json

A response including a single system account.

System Account

Schema of the system account.

idstring(uuid)read-only

ID of the system account.

namestring

Name of the system account.

descriptionstring

Description of the system account.

created_atstring(date-time)read-only

Timestamp of when the system account was created.

updated_atstring(date-time)read-only

Timestamp of when the system account was last updated.

konnect_managedboolean

The system account is managed by Konnect (true/false).

patch/system-accounts/{accountId}

Body

{}
 
application/json

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