v50

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-07-068428533.0 MB

System Accounts

Create System Account

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

post/v3/system-accounts

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 nullable

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 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
}