Testkube Control Plane ../tokens operations

• getList API Tokens
• postCreate API Token
• delDelete API Token

API docs by Redocly

Testkube Pro API (cloud-api/1.10.51)

Download OpenAPI specification:Download

E-mail: testkube@kubeshop.io License: COMMERICAL

API for Testkube Pro

List API Tokens

Lists API Tokens for an Organization

Authorizations:

None

path Parameters

id required

string unique id of the object

query Parameters

limit

integer limit queries for list of resources

Responses

https://raw.githubusercontent.com/organizations/{id}/tokens

Response samples

• 200
• 401
• 404

Content type

application/json

{

• "elements": [

  • {

    • "id": "string",
    • "name": "string",
    • "description": "string",
    • "labels": {

      • "property1": "string",
      • "property2": "string"

      },
    • "createdAt": "2019-08-24T14:15:22Z",
    • "updatedAt": "2019-08-24T14:15:22Z",
    • "type": "user",
    • "token": "tkcagnt_ade343dafecb5412232adeaa521add",
    • "scopes": [

      • {

        • "identifier": "tkcorg_xxxxxxxxxx",
        • "resource": "org",
        • "role": "admin"

        }

      ],
    • "meta": {

      • "property1": "string",
      • "property2": "string"

      },
    • "expiresAt": "2019-08-24T14:15:22Z",
    • "lastActive": "2019-08-24T14:15:22Z"

    }

  ]

}

Create API Token

Creates an API Token for an Organization

Authorizations:

None

path Parameters

id required

string unique id of the object

Request Body schema: application/json

required

token body

name required	string API Token name
expiration	string <duration> Expiration represented as duration string
	Array of objects (Scope) API token scopes

Responses

https://raw.githubusercontent.com/organizations/{id}/tokens

Request samples

• Payload

Content type

application/json

{

• "name": "Organization Read-only token",
• "expiration": "P3D",
• "scopes": [

  • {

    • "identifier": "tkcorg_xxxxxxxxxx",
    • "resource": "org",
    • "role": "admin"

    }

  ]

}

Response samples

• 200
• 400
• 402
• 403

Content type

application/json

{

• "id": "string",
• "name": "string",
• "description": "string",
• "labels": {

  • "property1": "string",
  • "property2": "string"

  },
• "createdAt": "2019-08-24T14:15:22Z",
• "updatedAt": "2019-08-24T14:15:22Z",
• "type": "user",
• "token": "tkcagnt_ade343dafecb5412232adeaa521add",
• "scopes": [

  • {

    • "identifier": "tkcorg_xxxxxxxxxx",
    • "resource": "org",
    • "role": "admin"

    }

  ],
• "meta": {

  • "property1": "string",
  • "property2": "string"

  },
• "expiresAt": "2019-08-24T14:15:22Z",
• "lastActive": "2019-08-24T14:15:22Z"

}

Delete API Token

Deletes an API Token for an Organization

Authorizations:

None

path Parameters

id required	string unique id of the object
tokenID required	string unique ID of the API Token

Responses

https://raw.githubusercontent.com/organizations/{id}/tokens/{tokenID}

Response samples

• 400
• 401
• 403

Content type

application/problem+json

{

• "type": "https://kubeshop.io/testkube/problems/invalidtestname",
• "title": "Invalid test name",
• "status": 500,
• "detail": "Your test name can't contain forbidden characters like \"}}}\" passed",
• "instance": "http://10.23.23.123:8088/tests"

}