System Accounts

Create System Account

Changed on

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

post/v3/system-accounts

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v3/system-accounts
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Request body

namestring required

Name of the system account.

descriptionstring required

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

A response including a single system account.

idstring uuid

ID of the system account.

namestring

Name of the system account.

descriptionstring

Description of the system account.

created_atstring date-time

Timestamp of when the system account was created.

updated_atstring date-time

Timestamp of when the system account was last updated.

konnect_managedboolean

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

Example response

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "Example System Account",
  "description": "This is a sample system account description.",
  "created_at": "2022-08-24T14:15:22Z",
  "updated_at": "2022-10-05T10:33:49Z",
  "konnect_managed": false
}

Changes

  • 68d43091b84dRevision changes
    • warning

      added the new 401.00 enum value to the response property for the response status

    • warning

      added the new 409.00 enum value to the response property for the response status

  • f324fb7610e4Revision changes
    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status