From 2e682dfaec4e0af62453d9a5d31fa2e08b6b812c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sebastian=20D=C3=B6ll?= Date: Mon, 6 May 2024 14:15:29 +0000 Subject: [PATCH] wip: update version --- .github/workflows/docs.yml | 4 +- docs/index.html | 913 +++++++++++++++++++++++++++++++++++++ 2 files changed, 915 insertions(+), 2 deletions(-) create mode 100644 docs/index.html diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 4d7114be..ceb4957d 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -15,8 +15,8 @@ jobs: - uses: actions/checkout@v4 - uses: actions/setup-node@v4 with: - node-version: "14" - - run: npx @redocly/cli build-docs api/api.yml --o docs/index.html + node-version: "20" + - run: npx -y @redocly/cli build-docs api/api.yml --o docs/index.html - uses: actions/upload-artifact@v2 if: github.ref == 'refs/heads/main' with: diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 00000000..b8df180a --- /dev/null +++ b/docs/index.html @@ -0,0 +1,913 @@ + + + + + + Typhoon API + + + + + + + + + +
API docs by Redocly

Typhoon API (1.0.0)

Download OpenAPI specification:Download

Sebastian Doell: sebastian@katallaxie.dev License: Apache-2.0

Typhoon is an event bridge built on top of an event mesh, +with a powerful API and beautiful experience.

+

Introduction

Typhoon is an event bridge for applications and services.

+

Server

These are administrative operations.

+

Returns the current version of the API.

Authorizations:
bearerAuthapiKey

Responses

Response samples

Content type
application/json
{
  • "version": "string",
  • "date": "string"
}

Teams

These are the teams that manage Typhoon.

+

Users

These are the users that manage Typhonn.

+

System

These are the system managed by Typhoon.

+

List all managed systems.

Returns a list of managed systems.

+
Authorizations:
bearerAuthapiKey

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "offset": 0,
  • "limit": 0,
  • "results": [
    ]
}

Creates a new system

Authorizations:
bearerAuthapiKey
Request Body schema: application/json
name
required
string

Name of the system

+
description
string

A description of the system.

+
object (Operator)
required
Array of objects (Clusters) <= 100 items
createdAt
string <date-time>

Creation date and time

+
updatedAt
string <date-time>

Creation date and time

+
deletedAt
string <date-time>

Creation date and time

+

Responses

Request samples

Content type
application/json
{
  • "name": "eu-west-1",
  • "description": "string",
  • "operator": {
    },
  • "clusters": [
    ],
  • "createdAt": "2021-01-30T08:30:00Z",
  • "updatedAt": "2021-01-30T08:30:00Z",
  • "deletedAt": "2021-01-30T08:30:00Z"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "eu-west-1",
  • "description": "string",
  • "operator": {
    },
  • "clusters": [
    ],
  • "createdAt": "2021-01-30T08:30:00Z",
  • "updatedAt": "2021-01-30T08:30:00Z",
  • "deletedAt": "2021-01-30T08:30:00Z"
}

Team

These are the teams that are using Typhoon.

+

List all teams

Authorizations:
bearerAuthapiKey
query Parameters
offset
integer >= 0
Default: 0

The number of items to skip before starting to collect the result set.

+
limit
integer [ 1 .. 50 ]
Default: 20

The numbers of items to return.

+

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "offset": 0,
  • "limit": 0,
  • "results": [
    ]
}

Creates a new team

Authorizations:
bearerAuthapiKey
Request Body schema: application/json
name
required
string
description
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "contactEmail": "string",
  • "createdAt": "2021-01-30T08:30:00Z",
  • "updatedAt": "2021-01-30T08:30:00Z",
  • "deletedAt": "2021-01-30T08:30:00Z"
}

List all systems for a team

Authorizations:
bearerAuth
path Parameters
teamId
required
string <uuid>

The id of the team to retrieve.

+
query Parameters
offset
integer >= 0
Default: 0

The number of items to skip before starting to collect the result set.

+
limit
integer [ 1 .. 50 ]
Default: 20

The numbers of items to return.

+

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "offset": 0,
  • "limit": 0,
  • "results": [
    ]
}

List all accounts for a team

Authorizations:
bearerAuth
path Parameters
teamId
required
string <uuid>

The id of the team to retrieve.

+
query Parameters
offset
integer >= 0
Default: 0

The number of items to skip before starting to collect the result set.

+
limit
integer [ 1 .. 50 ]
Default: 20

The numbers of items to return.

+

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "offset": 0,
  • "limit": 0,
  • "results": [
    ]
}

List all signing key groups for an account

Authorizations:
bearerAuth
path Parameters
teamId
required
string <uuid>

The id of the team to retrieve.

+
accountId
required
string <uuid>

The id of the account to retrieve.

+
query Parameters
offset
integer >= 0
Default: 0

The number of items to skip before starting to collect the result set.

+
limit
integer [ 1 .. 50 ]
Default: 20

The numbers of items to return.

+

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "offset": 0,
  • "limit": 0,
  • "results": [
    ]
}

Creates a new signing key group

Authorizations:
bearerAuthapiKey
path Parameters
teamId
required
string <uuid>

The id of the team to retrieve.

+
accountId
required
string <uuid>

The id of the account to retrieve.

+
Request Body schema: application/json
name
required
string
description
string
object (SigningKeyGroupScope)
is_scoped
boolean
Default: false
disabled
boolean
Default: false
createdAt
string <date-time>

Creation date and time

+
updatedAt
string <date-time>

Creation date and time

+
deletedAt
string <date-time>

Creation date and time

+

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "scope": {
    },
  • "is_scoped": false,
  • "disabled": false,
  • "createdAt": "2021-01-30T08:30:00Z",
  • "updatedAt": "2021-01-30T08:30:00Z",
  • "deletedAt": "2021-01-30T08:30:00Z"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "scope": {
    },
  • "is_scoped": false,
  • "disabled": false,
  • "createdAt": "2021-01-30T08:30:00Z",
  • "updatedAt": "2021-01-30T08:30:00Z",
  • "deletedAt": "2021-01-30T08:30:00Z"
}

List all users for an account

Authorizations:
bearerAuth
path Parameters
teamId
required
string <uuid>

The id of the team to retrieve.

+
accountId
required
string <uuid>

The id of the account to retrieve.

+
query Parameters
offset
integer >= 0
Default: 0

The number of items to skip before starting to collect the result set.

+
limit
integer [ 1 .. 50 ]
Default: 20

The numbers of items to return.

+

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "offset": 0,
  • "limit": 0,
  • "results": [
    ]
}

Creates a new user

Authorizations:
bearerAuthapiKey
path Parameters
teamId
required
string <uuid>

The id of the team to retrieve.

+
accountId
required
string <uuid>

The id of the account to retrieve.

+
Request Body schema: application/json
name
required
string
email
string
jwt
string
key
string
createdAt
string <date-time>

Creation date and time

+
updatedAt
string <date-time>

Creation date and time

+
deletedAt
string <date-time>

Creation date and time

+

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "email": "string",
  • "jwt": "string",
  • "key": "string",
  • "createdAt": "2021-01-30T08:30:00Z",
  • "updatedAt": "2021-01-30T08:30:00Z",
  • "deletedAt": "2021-01-30T08:30:00Z"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "email": "string",
  • "jwt": "string",
  • "key": "string",
  • "createdAt": "2021-01-30T08:30:00Z",
  • "updatedAt": "2021-01-30T08:30:00Z",
  • "deletedAt": "2021-01-30T08:30:00Z"
}

Triggers

These are the triggers that are used to send events to Typhoon.

+

Operator

List all operators

Authorizations:
bearerAuthapiKey
query Parameters
offset
integer >= 0
Default: 0

The number of items to skip before starting to collect the result set.

+
limit
integer [ 1 .. 50 ]
Default: 20

The numbers of items to return.

+

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "offset": 0,
  • "limit": 0,
  • "results": [
    ]
}

Creates a new operator

Authorizations:
bearerAuthapiKey
Request Body schema: application/json
name
required
string
description
string
contactEmail
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "contactEmail": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "key": {
    },
  • "signingKeys": [
    ],
  • "description": "string",
  • "contactEmail": "string",
  • "createdAt": "2021-01-30T08:30:00Z",
  • "updatedAt": "2021-01-30T08:30:00Z",
  • "deletedAt": "2021-01-30T08:30:00Z"
}

List all signing keys for an operator

Authorizations:
bearerAuth
path Parameters
operatorId
required
string <uuid>

The id of the operator to retrieve.

+
query Parameters
offset
integer >= 0
Default: 0

The number of items to skip before starting to collect the result set.

+
limit
integer [ 1 .. 50 ]
Default: 20

The numbers of items to return.

+

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "offset": 0,
  • "limit": 0,
  • "results": [
    ]
}

List all accounts for an operator

Authorizations:
bearerAuth
path Parameters
operatorId
required
string <uuid>

The id of the operator to retrieve.

+
query Parameters
offset
integer >= 0
Default: 0

The number of items to skip before starting to collect the result set.

+
limit
integer [ 1 .. 50 ]
Default: 20

The numbers of items to return.

+

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "offset": 0,
  • "limit": 0,
  • "results": [
    ]
}

Creates a new account

Authorizations:
bearerAuthapiKey
path Parameters
operatorId
required
string <uuid>

The id of the operator to retrieve.

+
Request Body schema: application/json
name
required
string
description
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "contactEmail": "string",
  • "key": {
    },
  • "signingKeys": [
    ],
  • "createdAt": "2021-01-30T08:30:00Z",
  • "updatedAt": "2021-01-30T08:30:00Z",
  • "deletedAt": "2021-01-30T08:30:00Z"
}

List all signing keys for an account

Authorizations:
bearerAuth
path Parameters
operatorId
required
string <uuid>

The id of the operator to retrieve.

+
accountId
required
string <uuid>

The id of the account to retrieve.

+
query Parameters
offset
integer >= 0
Default: 0

The number of items to skip before starting to collect the result set.

+
limit
integer [ 1 .. 50 ]
Default: 20

The numbers of items to return.

+

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "offset": 0,
  • "limit": 0,
  • "results": [
    ]
}

List all users for an account

Authorizations:
bearerAuth
path Parameters
operatorId
required
string <uuid>

The id of the operator to retrieve.

+
accountId
required
string <uuid>

The id of the account to retrieve.

+
query Parameters
offset
integer >= 0
Default: 0

The number of items to skip before starting to collect the result set.

+
limit
integer [ 1 .. 50 ]
Default: 20

The numbers of items to return.

+

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "offset": 0,
  • "limit": 0,
  • "results": [
    ]
}

Creates a new user

Authorizations:
bearerAuthapiKey
path Parameters
operatorId
required
string <uuid>

The id of the operator to retrieve.

+
accountId
required
string <uuid>

The id of the account to retrieve.

+
Request Body schema: application/json
name
required
string
email
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "email": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "email": "string",
  • "jwt": "string",
  • "key": "string",
  • "createdAt": "2021-01-30T08:30:00Z",
  • "updatedAt": "2021-01-30T08:30:00Z",
  • "deletedAt": "2021-01-30T08:30:00Z"
}

Gets an operator by ID

Authorizations:
bearerAuthapiKey
path Parameters
operatorId
required
string <uuid>

The id of the operator to retrieve.

+

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "key": {
    },
  • "signingKeys": [
    ],
  • "description": "string",
  • "contactEmail": "string",
  • "createdAt": "2021-01-30T08:30:00Z",
  • "updatedAt": "2021-01-30T08:30:00Z",
  • "deletedAt": "2021-01-30T08:30:00Z"
}

Updates an operator by ID

Authorizations:
bearerAuthapiKey
path Parameters
operatorId
required
string <uuid>

The id of the operator to retrieve.

+
Request Body schema: application/json
name
required
string
object (KeyPair)
Array of objects (KeyPair)
description
string
contactEmail
string
createdAt
string <date-time>

Creation date and time

+
updatedAt
string <date-time>

Creation date and time

+
deletedAt
string <date-time>

Creation date and time

+

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "key": {
    },
  • "signingKeys": [
    ],
  • "description": "string",
  • "contactEmail": "string",
  • "createdAt": "2021-01-30T08:30:00Z",
  • "updatedAt": "2021-01-30T08:30:00Z",
  • "deletedAt": "2021-01-30T08:30:00Z"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "key": {
    },
  • "signingKeys": [
    ],
  • "description": "string",
  • "contactEmail": "string",
  • "createdAt": "2021-01-30T08:30:00Z",
  • "updatedAt": "2021-01-30T08:30:00Z",
  • "deletedAt": "2021-01-30T08:30:00Z"
}

Deletes an operator by ID

Authorizations:
bearerAuthapiKey
path Parameters
operatorId
required
string <uuid>

The id of the operator to retrieve.

+

Responses

Gets a token for an operator

Authorizations:
bearerAuthapiKey
path Parameters
operatorId
required
string <uuid>

The id of the operator to retrieve.

+

Responses

Response samples

Content type
application/json
"string"

Updates a token for an operator

Authorizations:
bearerAuthapiKey
path Parameters
operatorId
required
string <uuid>

The id of the operator to retrieve.

+

Responses

Response samples

Content type
application/json
"string"

Deletes a token for an operator

Authorizations:
bearerAuthapiKey
path Parameters
operatorId
required
string <uuid>

The id of the operator to retrieve.

+

Responses

Gets an account by ID

Authorizations:
bearerAuthapiKey
path Parameters
operatorId
required
string <uuid>

The id of the operator to retrieve.

+
accountId
required
string <uuid>

The id of the account to retrieve.

+

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "contactEmail": "string",
  • "key": {
    },
  • "signingKeys": [
    ],
  • "createdAt": "2021-01-30T08:30:00Z",
  • "updatedAt": "2021-01-30T08:30:00Z",
  • "deletedAt": "2021-01-30T08:30:00Z"
}

Updates an account by ID

Authorizations:
bearerAuthapiKey
path Parameters
operatorId
required
string <uuid>

The id of the operator to retrieve.

+
accountId
required
string <uuid>

The id of the account to retrieve.

+
Request Body schema: application/json
name
required
string
description
string
object (JWTAccountClaims)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "claims": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "contactEmail": "string",
  • "key": {
    },
  • "signingKeys": [
    ],
  • "createdAt": "2021-01-30T08:30:00Z",
  • "updatedAt": "2021-01-30T08:30:00Z",
  • "deletedAt": "2021-01-30T08:30:00Z"
}

Deletes an account by ID

Authorizations:
bearerAuthapiKey
path Parameters
operatorId
required
string <uuid>

The id of the operator to retrieve.

+
accountId
required
string <uuid>

The id of the account to retrieve.

+

Responses

Gets a token for an account

Authorizations:
bearerAuthapiKey
path Parameters
operatorId
required
string <uuid>

The id of the operator to retrieve.

+
accountId
required
string <uuid>

The id of the account to retrieve.

+

Responses

Response samples

Content type
application/json
"string"

Deletes a token for an account

Authorizations:
bearerAuthapiKey
path Parameters
operatorId
required
string <uuid>

The id of the operator to retrieve.

+
accountId
required
string <uuid>

The id of the account to retrieve.

+

Responses

Gets a user by ID

Authorizations:
bearerAuthapiKey
path Parameters
operatorId
required
string <uuid>

The id of the operator to retrieve.

+
accountId
required
string <uuid>

The id of the account to retrieve.

+
userId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "email": "string",
  • "jwt": "string",
  • "key": "string",
  • "createdAt": "2021-01-30T08:30:00Z",
  • "updatedAt": "2021-01-30T08:30:00Z",
  • "deletedAt": "2021-01-30T08:30:00Z"
}

Gets a token for a user

Authorizations:
bearerAuthapiKey
path Parameters
operatorId
required
string <uuid>

The id of the operator to retrieve.

+
accountId
required
string <uuid>

The id of the account to retrieve.

+
userId
required
string <uuid>

The id of the user to retrieve.

+

Responses

Response samples

Content type
application/json
"string"

Gets the credentials for a user

Authorizations:
bearerAuthapiKey
path Parameters
operatorId
required
string <uuid>

The id of the operator to retrieve.

+
accountId
required
string <uuid>

The id of the account to retrieve.

+
userId
required
string <uuid>

The id of the user to retrieve.

+

Responses

Gets a team by ID

Authorizations:
bearerAuthapiKey
path Parameters
teamId
required
string <uuid>

The id of the team to retrieve.

+

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "contactEmail": "string",
  • "createdAt": "2021-01-30T08:30:00Z",
  • "updatedAt": "2021-01-30T08:30:00Z",
  • "deletedAt": "2021-01-30T08:30:00Z"
}

Deletes a team by ID

Authorizations:
bearerAuthapiKey
path Parameters
teamId
required
string <uuid>

The id of the team to retrieve.

+

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "ref": "string",
  • "message": "string"
}

Gets an account by ID

Authorizations:
bearerAuthapiKey
path Parameters
teamId
required
string <uuid>
accountId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "contactEmail": "string",
  • "key": {
    },
  • "signingKeys": [
    ],
  • "createdAt": "2021-01-30T08:30:00Z",
  • "updatedAt": "2021-01-30T08:30:00Z",
  • "deletedAt": "2021-01-30T08:30:00Z"
}

Gets a signing key group by ID

Authorizations:
bearerAuthapiKey
path Parameters
teamId
required
string <uuid>

The id of the team to retrieve.

+
accountId
required
string <uuid>

The id of the account to retrieve.

+
groupId
required
string <uuid>

The id of the group to retrieve.

+

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "scope": {
    },
  • "is_scoped": false,
  • "disabled": false,
  • "createdAt": "2021-01-30T08:30:00Z",
  • "updatedAt": "2021-01-30T08:30:00Z",
  • "deletedAt": "2021-01-30T08:30:00Z"
}

Updates a signing key group by ID

Authorizations:
bearerAuthapiKey
path Parameters
teamId
required
string <uuid>

The id of the team to retrieve.

+
accountId
required
string <uuid>

The id of the account to retrieve.

+
groupId
required
string <uuid>

The id of the group to retrieve.

+
Request Body schema: application/json
name
required
string
description
string
object (SigningKeyGroupScope)
is_scoped
boolean
Default: false
disabled
boolean
Default: false
createdAt
string <date-time>

Creation date and time

+
updatedAt
string <date-time>

Creation date and time

+
deletedAt
string <date-time>

Creation date and time

+

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "scope": {
    },
  • "is_scoped": false,
  • "disabled": false,
  • "createdAt": "2021-01-30T08:30:00Z",
  • "updatedAt": "2021-01-30T08:30:00Z",
  • "deletedAt": "2021-01-30T08:30:00Z"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "scope": {
    },
  • "is_scoped": false,
  • "disabled": false,
  • "createdAt": "2021-01-30T08:30:00Z",
  • "updatedAt": "2021-01-30T08:30:00Z",
  • "deletedAt": "2021-01-30T08:30:00Z"
}

Deletes a signing key group by ID

Authorizations:
bearerAuthapiKey
path Parameters
teamId
required
string <uuid>

The id of the team to retrieve.

+
accountId
required
string <uuid>

The id of the account to retrieve.

+
groupId
required
string <uuid>

The id of the group to retrieve.

+

Responses

Gets a user by ID

Authorizations:
bearerAuthapiKey
path Parameters
teamId
required
string <uuid>

The id of the team to retrieve.

+
accountId
required
string <uuid>

The id of the account to retrieve.

+
userId
required
string <uuid>

The id of the user to retrieve.

+

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "email": "string",
  • "jwt": "string",
  • "key": "string",
  • "createdAt": "2021-01-30T08:30:00Z",
  • "updatedAt": "2021-01-30T08:30:00Z",
  • "deletedAt": "2021-01-30T08:30:00Z"
}

Updates a user by ID

Authorizations:
bearerAuthapiKey
path Parameters
teamId
required
string <uuid>

The id of the team to retrieve.

+
accountId
required
string <uuid>

The id of the account to retrieve.

+
userId
required
string <uuid>

The id of the user to retrieve.

+
Request Body schema: application/json
name
required
string
email
string
jwt
string
key
string
createdAt
string <date-time>

Creation date and time

+
updatedAt
string <date-time>

Creation date and time

+
deletedAt
string <date-time>

Creation date and time

+

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "email": "string",
  • "jwt": "string",
  • "key": "string",
  • "createdAt": "2021-01-30T08:30:00Z",
  • "updatedAt": "2021-01-30T08:30:00Z",
  • "deletedAt": "2021-01-30T08:30:00Z"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "email": "string",
  • "jwt": "string",
  • "key": "string",
  • "createdAt": "2021-01-30T08:30:00Z",
  • "updatedAt": "2021-01-30T08:30:00Z",
  • "deletedAt": "2021-01-30T08:30:00Z"
}

Deletes a user by ID

Authorizations:
bearerAuthapiKey
path Parameters
teamId
required
string <uuid>

The id of the team to retrieve.

+
accountId
required
string <uuid>

The id of the account to retrieve.

+
userId
required
string <uuid>

The id of the user to retrieve.

+

Responses

Gets a system by ID

Authorizations:
bearerAuthapiKey
path Parameters
systemId
required
string <uuid>

The id of the system to retrieve.

+

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "eu-west-1",
  • "description": "string",
  • "operator": {
    },
  • "clusters": [
    ],
  • "createdAt": "2021-01-30T08:30:00Z",
  • "updatedAt": "2021-01-30T08:30:00Z",
  • "deletedAt": "2021-01-30T08:30:00Z"
}

Updates a system by ID

Authorizations:
bearerAuthapiKey
path Parameters
systemId
required
string <uuid>

The id of the system to retrieve.

+
Request Body schema: application/json
name
required
string

Name of the system

+
description
string

A description of the system.

+
object (Operator)
required
Array of objects (Clusters) <= 100 items
createdAt
string <date-time>

Creation date and time

+
updatedAt
string <date-time>

Creation date and time

+
deletedAt
string <date-time>

Creation date and time

+

Responses

Request samples

Content type
application/json
{
  • "name": "eu-west-1",
  • "description": "string",
  • "operator": {
    },
  • "clusters": [
    ],
  • "createdAt": "2021-01-30T08:30:00Z",
  • "updatedAt": "2021-01-30T08:30:00Z",
  • "deletedAt": "2021-01-30T08:30:00Z"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "eu-west-1",
  • "description": "string",
  • "operator": {
    },
  • "clusters": [
    ],
  • "createdAt": "2021-01-30T08:30:00Z",
  • "updatedAt": "2021-01-30T08:30:00Z",
  • "deletedAt": "2021-01-30T08:30:00Z"
}

Deletes a system by ID

Authorizations:
bearerAuthapiKey
path Parameters
systemId
required
string <uuid>

The id of the system to retrieve.

+

Responses

Gets the operator for a system

Authorizations:
bearerAuthapiKey
path Parameters
systemId
required
string <uuid>

The id of the system to retrieve.

+

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "key": {
    },
  • "signingKeys": [
    ],
  • "description": "string",
  • "contactEmail": "string",
  • "createdAt": "2021-01-30T08:30:00Z",
  • "updatedAt": "2021-01-30T08:30:00Z",
  • "deletedAt": "2021-01-30T08:30:00Z"
}

Updates the operator for a system

Authorizations:
bearerAuthapiKey
path Parameters
systemId
required
string <uuid>

The id of the system to retrieve.

+
Request Body schema: application/json
operatorId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "operatorId": "373c4133-3dda-4217-938b-a5730b9cc41a"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "key": {
    },
  • "signingKeys": [
    ],
  • "description": "string",
  • "contactEmail": "string",
  • "createdAt": "2021-01-30T08:30:00Z",
  • "updatedAt": "2021-01-30T08:30:00Z",
  • "deletedAt": "2021-01-30T08:30:00Z"
}

Deletes the operator for a system

Authorizations:
bearerAuthapiKey
path Parameters
systemId
required
string <uuid>

The id of the system to retrieve.

+

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "ref": "string",
  • "message": "string"
}
+ + + +