Testkube Control Plane /organizations operations
Testkube Pro API (cloud-api/1.10.51)
Download OpenAPI specification:Download
E-mail: testkube@kubeshop.io License: COMMERICAL
API for Testkube Pro
List organizations
List organizations
Authorizations:
None
query Parameters
limit | integer limit queries for list of resources |
Responses
Response samples
- 200
- 401
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",
- "slug": "my-personal-org",
- "plan": {
- "id": "string",
- "name": "plan_free",
- "description": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "status": "Active",
- "customerId": "string",
- "checkoutSessionId": "cs_2039092394029043",
- "subscriptionId": "si_2039092394029043",
- "currentPeriodStart": "2019-08-24T14:15:22Z",
- "currentPeriodEnd": "2019-08-24T14:15:22Z",
- "usageRecordTime": "2019-08-24T14:15:22Z",
- "limits": {
- "maxEnvironments": 1000,
- "maxOrganizations": 1000,
- "maxUsers": 12,
- "maxTestResults": 12,
- "maxStorageGb": 128,
- "dataRetentionGb": 32,
- "dataRetentionDays": 7,
- "weeklyAiAnalysis": 14,
- "dailyAiAnalysis": 2,
- "ssoAllowed": true,
- "rbacAllowed": true
}, - "gracePeriodDays": 14,
- "isTrial": true,
- "trialEnds": "2019-08-24T14:15:22Z"
}, - "members": [
- {
- "id": "string",
- "email": "jack.the.ripper@testkube.io",
- "status": "Invited",
- "role": "owner",
- "inviteID": "1234567890-12312321-123123-3333",
- "invitingEmail": "pikachu@testkube.io"
}
]
}
]
}
Create new organization
Create organization
Authorizations:
None
Request Body schema: application/jsonrequired
environment details body
id required | string |
name required | string |
description | string |
object | |
createdAt | string <date-time> |
updatedAt | string <date-time> |
slug | string Human- and URL friendly identifier |
object (Plan) | |
Array of objects (Member) |
Responses
Request samples
- Payload
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",
- "slug": "my-personal-org",
- "plan": {
- "id": "string",
- "name": "plan_free",
- "description": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "status": "Active",
- "customerId": "string",
- "checkoutSessionId": "cs_2039092394029043",
- "subscriptionId": "si_2039092394029043",
- "currentPeriodStart": "2019-08-24T14:15:22Z",
- "currentPeriodEnd": "2019-08-24T14:15:22Z",
- "usageRecordTime": "2019-08-24T14:15:22Z",
- "limits": {
- "maxEnvironments": 1000,
- "maxOrganizations": 1000,
- "maxUsers": 12,
- "maxTestResults": 12,
- "maxStorageGb": 128,
- "dataRetentionGb": 32,
- "dataRetentionDays": 7,
- "weeklyAiAnalysis": 14,
- "dailyAiAnalysis": 2,
- "ssoAllowed": true,
- "rbacAllowed": true
}, - "gracePeriodDays": 14,
- "isTrial": true,
- "trialEnds": "2019-08-24T14:15:22Z"
}, - "members": [
- {
- "id": "string",
- "email": "jack.the.ripper@testkube.io",
- "status": "Invited",
- "role": "owner",
- "inviteID": "1234567890-12312321-123123-3333",
- "invitingEmail": "pikachu@testkube.io"
}
]
}
Response samples
- 200
- 400
- 401
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",
- "slug": "my-personal-org",
- "plan": {
- "id": "string",
- "name": "plan_free",
- "description": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "status": "Active",
- "customerId": "string",
- "checkoutSessionId": "cs_2039092394029043",
- "subscriptionId": "si_2039092394029043",
- "currentPeriodStart": "2019-08-24T14:15:22Z",
- "currentPeriodEnd": "2019-08-24T14:15:22Z",
- "usageRecordTime": "2019-08-24T14:15:22Z",
- "limits": {
- "maxEnvironments": 1000,
- "maxOrganizations": 1000,
- "maxUsers": 12,
- "maxTestResults": 12,
- "maxStorageGb": 128,
- "dataRetentionGb": 32,
- "dataRetentionDays": 7,
- "weeklyAiAnalysis": 14,
- "dailyAiAnalysis": 2,
- "ssoAllowed": true,
- "rbacAllowed": true
}, - "gracePeriodDays": 14,
- "isTrial": true,
- "trialEnds": "2019-08-24T14:15:22Z"
}, - "members": [
- {
- "id": "string",
- "email": "jack.the.ripper@testkube.io",
- "status": "Invited",
- "role": "owner",
- "inviteID": "1234567890-12312321-123123-3333",
- "invitingEmail": "pikachu@testkube.io"
}
]
}
Get organization by ID
Get organization by ID
Authorizations:
None
path Parameters
id required | string unique id of the object |
Responses
Response samples
- 200
- 401
- 404
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",
- "slug": "my-personal-org",
- "plan": {
- "id": "string",
- "name": "plan_free",
- "description": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "status": "Active",
- "customerId": "string",
- "checkoutSessionId": "cs_2039092394029043",
- "subscriptionId": "si_2039092394029043",
- "currentPeriodStart": "2019-08-24T14:15:22Z",
- "currentPeriodEnd": "2019-08-24T14:15:22Z",
- "usageRecordTime": "2019-08-24T14:15:22Z",
- "limits": {
- "maxEnvironments": 1000,
- "maxOrganizations": 1000,
- "maxUsers": 12,
- "maxTestResults": 12,
- "maxStorageGb": 128,
- "dataRetentionGb": 32,
- "dataRetentionDays": 7,
- "weeklyAiAnalysis": 14,
- "dailyAiAnalysis": 2,
- "ssoAllowed": true,
- "rbacAllowed": true
}, - "gracePeriodDays": 14,
- "isTrial": true,
- "trialEnds": "2019-08-24T14:15:22Z"
}, - "members": [
- {
- "id": "string",
- "email": "jack.the.ripper@testkube.io",
- "status": "Invited",
- "role": "owner",
- "inviteID": "1234567890-12312321-123123-3333",
- "invitingEmail": "pikachu@testkube.io"
}
]
}
Delete organization
Deletes organization
Authorizations:
None
path Parameters
id required | string unique id of the object |
Responses
Response samples
- 401
Content type
application/problem+json
{- "title": "Invalid test name",
- "status": 500,
- "detail": "Your test name can't contain forbidden characters like \"}}}\" passed",
}
Update organization
Update organization with given request body
Authorizations:
None
path Parameters
id required | string unique id of the object |
Request Body schema: application/jsonrequired
environment details body
id required | string |
name required | string |
description | string |
object | |
createdAt | string <date-time> |
updatedAt | string <date-time> |
slug | string Human- and URL friendly identifier |
object (Plan) | |
Array of objects (Member) |
Responses
Request samples
- Payload
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",
- "slug": "my-personal-org",
- "plan": {
- "id": "string",
- "name": "plan_free",
- "description": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "status": "Active",
- "customerId": "string",
- "checkoutSessionId": "cs_2039092394029043",
- "subscriptionId": "si_2039092394029043",
- "currentPeriodStart": "2019-08-24T14:15:22Z",
- "currentPeriodEnd": "2019-08-24T14:15:22Z",
- "usageRecordTime": "2019-08-24T14:15:22Z",
- "limits": {
- "maxEnvironments": 1000,
- "maxOrganizations": 1000,
- "maxUsers": 12,
- "maxTestResults": 12,
- "maxStorageGb": 128,
- "dataRetentionGb": 32,
- "dataRetentionDays": 7,
- "weeklyAiAnalysis": 14,
- "dailyAiAnalysis": 2,
- "ssoAllowed": true,
- "rbacAllowed": true
}, - "gracePeriodDays": 14,
- "isTrial": true,
- "trialEnds": "2019-08-24T14:15:22Z"
}, - "members": [
- {
- "id": "string",
- "email": "jack.the.ripper@testkube.io",
- "status": "Invited",
- "role": "owner",
- "inviteID": "1234567890-12312321-123123-3333",
- "invitingEmail": "pikachu@testkube.io"
}
]
}
Response samples
- 200
- 400
- 401
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",
- "slug": "my-personal-org",
- "plan": {
- "id": "string",
- "name": "plan_free",
- "description": "string",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "status": "Active",
- "customerId": "string",
- "checkoutSessionId": "cs_2039092394029043",
- "subscriptionId": "si_2039092394029043",
- "currentPeriodStart": "2019-08-24T14:15:22Z",
- "currentPeriodEnd": "2019-08-24T14:15:22Z",
- "usageRecordTime": "2019-08-24T14:15:22Z",
- "limits": {
- "maxEnvironments": 1000,
- "maxOrganizations": 1000,
- "maxUsers": 12,
- "maxTestResults": 12,
- "maxStorageGb": 128,
- "dataRetentionGb": 32,
- "dataRetentionDays": 7,
- "weeklyAiAnalysis": 14,
- "dailyAiAnalysis": 2,
- "ssoAllowed": true,
- "rbacAllowed": true
}, - "gracePeriodDays": 14,
- "isTrial": true,
- "trialEnds": "2019-08-24T14:15:22Z"
}, - "members": [
- {
- "id": "string",
- "email": "jack.the.ripper@testkube.io",
- "status": "Invited",
- "role": "owner",
- "inviteID": "1234567890-12312321-123123-3333",
- "invitingEmail": "pikachu@testkube.io"
}
]
}