System Accounts

Update System Account

Changed on

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

patch/v3/system-accounts/{accountId}

Request

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

Request body

namestring nullable

Name of the system account.

descriptionstring nullable

Description of the system account.

Response

A response including a single system account.

idstring uuid

ID of the system account.

namestring nullable

Name of the system account.

descriptionstring nullable

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 nullable

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

  • f530bf400198Revision changes
    • warning

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

    • warning

      added the new 404.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

  • 4a02153f2e60Revision 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

    • 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

      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

      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

    • 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