Skip to main content
New to Testkube? Unleash the power of cloud native testing in Kubernetes with Testkube. Get Started >

Testkube Control Plane ../groups operations

Testkube Pro API (cloud-api/1.10.51)

Download OpenAPI specification:Download

API for Testkube Pro

List organization groups

Lists the projects in an organization.

Authorizations:
None
path Parameters
id
required
string

unique id of the object

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a resource group

Creates a resource group.

Authorizations:
None
path Parameters
id
required
string

unique id of the object

Request Body schema: application/json
required
name
required
string

Display name of the resource group

slug
string

Human- and URL friendly identifier.

description
string

Description of the resource group

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": "string",
  • "slug": "string",
  • "name": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "role": "string"
}

Get a resource group

Get a resource group by its id.

Authorizations:
None
path Parameters
id
required
string

unique id of the object

groupID
required
string

The identifier of this resource group

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "slug": "string",
  • "name": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "role": "string"
}

Delete a resource group

Deletes a resource group.

Authorizations:
None
path Parameters
id
required
string

unique id of the object

groupID
required
string

The identifier of this resource group

Responses

Response samples

Content type
application/problem+json
{}

Update a resource group

Updates a resource groups information.

Authorizations:
None
path Parameters
id
required
string

unique id of the object

groupID
required
string

The identifier of this resource group

Request Body schema: application/json
required
name
string

Name of the resource group

description
string

Description of the resource group

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": "string",
  • "slug": "string",
  • "name": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "role": "string"
}

Lists all collaborators for this resource group

Lists all collaborators for this resource group.

Authorizations:
None
path Parameters
id
required
string

unique id of the object

groupID
required
string

The identifier of this resource group

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Adds all collaborators to this resource group

Adds all collaborators to this resource group.

Authorizations:
None
path Parameters
id
required
string

unique id of the object

groupID
required
string

The identifier of this resource group

Request Body schema: application/json
required
collaborators
required
Array of strings

The collaborators to add to this resource group.

role
required
string

The role to assign to all collaborators.

Responses

Request samples

Content type
application/json
{
  • "collaborators": [
    ],
  • "role": "string"
}

Response samples

Content type
application/json
{
  • "collaborators": [
    ],
  • "failed": [
    ]
}

Remove many members from this group

Remove many members from this access group.

Authorizations:
None
path Parameters
id
required
string

unique id of the object

groupID
required
string

The identifier of this resource group

Request Body schema: application/json
required
collaborators
required
Array of strings

The collaborators to remove from this group.

Responses

Request samples

Content type
application/json
{
  • "collaborators": [
    ]
}

Response samples

Content type
application/json
{
  • "failed": [
    ]
}