Testkube Control Plane ../environments operations

• getList environments
• postCreate new environment
• delDelete environments
• getGet environment by ID
• delDelete test environment
• patchUpdate environment

API docs by Redocly

Testkube Pro API (cloud-api/1.10.38)

Download OpenAPI specification:Download

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

API for Testkube Pro

List environments

List environments from the active 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}/environments

Response samples

• 200
• 400
• 401
• 403
• 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",
    • "slug": "demo-environment",
    • "connected": true,
    • "status": "Green",
    • "organizationID": "733420bd-7e56-461f-8431-6378759e60ae",
    • "agentToken": "tkcagnt_adead343112adeadcaaaaa221daee2",
    • "connectCommand": "testkube pro connect --agent-key tkcagnt_111",
    • "disconnectCommand": "testkube pro disconnect",
    • "installCommand": "helm upgrade --install --create-namespace testkube testkube/testkube --set testkube-api.cloud.url=agent.testkube.xyz:443 --set testkube-api.cloud.key=<api-key> --set testkube-api.minio.enabled=false --set mongodb.enabled=false --namespace testkube",
    • "installCommandCli": "testkube init-cloud --agent-key tkcagnt_111 --agent-url agent.testkube.xyz:443",
    • "configureContextCommand": "testkube context set --api-url https://api.testkube.xyz --api-key <api-key> --agent-url https://agent.testkube.xyz --agent-key <agent-key>",
    • "members": [

      • {

        • "email": "jack.the.ripper@testkube.io",
        • "status": "Invited",
        • "role": "read",
        • "inviteID": "1234567890-12312321-123123-3333",
        • "invitingEmail": "pikachu@testkube.io"

        }

      ],
    • "features": [

      • {

        • "name": "string",
        • "displayName": "string",
        • "description": "string",
        • "learnMoreUrl": "http://example.com",
        • "enabled": true

        }

      ]

    }

  ]

}

Create new environment

Create test environment

Authorizations:

None

path Parameters

id required

string unique id of the object

Request Body schema: application/json

required

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
connected required	boolean State of the agent connection
status	string Enum: "Green" "Yellow" "Red" State of the environment
organizationID	string organizationID
agentToken	string agent token for environment
connectCommand	string command to connect existing Testkube OSS installation to the Testkube Pro
disconnectCommand	string command to disconnect from testkube pro and get back to standalone OSS mode
installCommand	string command to install/upgrade agent
installCommandCli	string command to install/upgrade agent
configureContextCommand	string command to configure
	Array of objects (EnvironmentMember)
	Array of objects (EnvironmentFeature)

Responses

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

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": "demo-environment",
• "connected": true,
• "status": "Green",
• "organizationID": "733420bd-7e56-461f-8431-6378759e60ae",
• "agentToken": "tkcagnt_adead343112adeadcaaaaa221daee2",
• "connectCommand": "testkube pro connect --agent-key tkcagnt_111",
• "disconnectCommand": "testkube pro disconnect",
• "installCommand": "helm upgrade --install --create-namespace testkube testkube/testkube --set testkube-api.cloud.url=agent.testkube.xyz:443 --set testkube-api.cloud.key=<api-key> --set testkube-api.minio.enabled=false --set mongodb.enabled=false --namespace testkube",
• "installCommandCli": "testkube init-cloud --agent-key tkcagnt_111 --agent-url agent.testkube.xyz:443",
• "configureContextCommand": "testkube context set --api-url https://api.testkube.xyz --api-key <api-key> --agent-url https://agent.testkube.xyz --agent-key <agent-key>",
• "members": [

  • {

    • "email": "jack.the.ripper@testkube.io",
    • "status": "Invited",
    • "role": "read",
    • "inviteID": "1234567890-12312321-123123-3333",
    • "invitingEmail": "pikachu@testkube.io"

    }

  ],
• "features": [

  • {

    • "name": "string",
    • "displayName": "string",
    • "description": "string",
    • "learnMoreUrl": "http://example.com",
    • "enabled": true

    }

  ]

}

Response samples

• 200
• 400

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": "demo-environment",
• "connected": true,
• "status": "Green",
• "organizationID": "733420bd-7e56-461f-8431-6378759e60ae",
• "agentToken": "tkcagnt_adead343112adeadcaaaaa221daee2",
• "connectCommand": "testkube pro connect --agent-key tkcagnt_111",
• "disconnectCommand": "testkube pro disconnect",
• "installCommand": "helm upgrade --install --create-namespace testkube testkube/testkube --set testkube-api.cloud.url=agent.testkube.xyz:443 --set testkube-api.cloud.key=<api-key> --set testkube-api.minio.enabled=false --set mongodb.enabled=false --namespace testkube",
• "installCommandCli": "testkube init-cloud --agent-key tkcagnt_111 --agent-url agent.testkube.xyz:443",
• "configureContextCommand": "testkube context set --api-url https://api.testkube.xyz --api-key <api-key> --agent-url https://agent.testkube.xyz --agent-key <agent-key>",
• "members": [

  • {

    • "email": "jack.the.ripper@testkube.io",
    • "status": "Invited",
    • "role": "read",
    • "inviteID": "1234567890-12312321-123123-3333",
    • "invitingEmail": "pikachu@testkube.io"

    }

  ],
• "features": [

  • {

    • "name": "string",
    • "displayName": "string",
    • "description": "string",
    • "learnMoreUrl": "http://example.com",
    • "enabled": true

    }

  ]

}

Delete environments

Deletes all or labeled environments

Authorizations:

None

path Parameters

id required

string unique id of the object

query Parameters

name	string object name to search for

Responses

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

Response samples

• 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"

}

Get environment by ID

Get test environment by ID from CRD in kubernetes cluster

Authorizations:

None

path Parameters

id required	string unique id of the object
environmentID required	string unique id of the environment

Responses

https://raw.githubusercontent.com/organizations/{id}/environments/{environmentID}

Response samples

• 200
• 401
• 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",
• "slug": "demo-environment",
• "connected": true,
• "status": "Green",
• "organizationID": "733420bd-7e56-461f-8431-6378759e60ae",
• "agentToken": "tkcagnt_adead343112adeadcaaaaa221daee2",
• "connectCommand": "testkube pro connect --agent-key tkcagnt_111",
• "disconnectCommand": "testkube pro disconnect",
• "installCommand": "helm upgrade --install --create-namespace testkube testkube/testkube --set testkube-api.cloud.url=agent.testkube.xyz:443 --set testkube-api.cloud.key=<api-key> --set testkube-api.minio.enabled=false --set mongodb.enabled=false --namespace testkube",
• "installCommandCli": "testkube init-cloud --agent-key tkcagnt_111 --agent-url agent.testkube.xyz:443",
• "configureContextCommand": "testkube context set --api-url https://api.testkube.xyz --api-key <api-key> --agent-url https://agent.testkube.xyz --agent-key <agent-key>",
• "members": [

  • {

    • "email": "jack.the.ripper@testkube.io",
    • "status": "Invited",
    • "role": "read",
    • "inviteID": "1234567890-12312321-123123-3333",
    • "invitingEmail": "pikachu@testkube.io"

    }

  ],
• "features": [

  • {

    • "name": "string",
    • "displayName": "string",
    • "description": "string",
    • "learnMoreUrl": "http://example.com",
    • "enabled": true

    }

  ]

}

Delete test environment

Deletes a test environment

Authorizations:

None

path Parameters

id required	string unique id of the object
environmentID required	string unique id of the environment

Responses

https://raw.githubusercontent.com/organizations/{id}/environments/{environmentID}

Response samples

• 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"

}

Update environment

Update environment with given request body

Authorizations:

None

path Parameters

id required	string unique id of the object
environmentID required	string unique id of the environment

Request Body schema: application/json

required

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
connected required	boolean State of the agent connection
status	string Enum: "Green" "Yellow" "Red" State of the environment
organizationID	string organizationID
agentToken	string agent token for environment
connectCommand	string command to connect existing Testkube OSS installation to the Testkube Pro
disconnectCommand	string command to disconnect from testkube pro and get back to standalone OSS mode
installCommand	string command to install/upgrade agent
installCommandCli	string command to install/upgrade agent
configureContextCommand	string command to configure
	Array of objects (EnvironmentMember)
	Array of objects (EnvironmentFeature)

Responses

https://raw.githubusercontent.com/organizations/{id}/environments/{environmentID}

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": "demo-environment",
• "connected": true,
• "status": "Green",
• "organizationID": "733420bd-7e56-461f-8431-6378759e60ae",
• "agentToken": "tkcagnt_adead343112adeadcaaaaa221daee2",
• "connectCommand": "testkube pro connect --agent-key tkcagnt_111",
• "disconnectCommand": "testkube pro disconnect",
• "installCommand": "helm upgrade --install --create-namespace testkube testkube/testkube --set testkube-api.cloud.url=agent.testkube.xyz:443 --set testkube-api.cloud.key=<api-key> --set testkube-api.minio.enabled=false --set mongodb.enabled=false --namespace testkube",
• "installCommandCli": "testkube init-cloud --agent-key tkcagnt_111 --agent-url agent.testkube.xyz:443",
• "configureContextCommand": "testkube context set --api-url https://api.testkube.xyz --api-key <api-key> --agent-url https://agent.testkube.xyz --agent-key <agent-key>",
• "members": [

  • {

    • "email": "jack.the.ripper@testkube.io",
    • "status": "Invited",
    • "role": "read",
    • "inviteID": "1234567890-12312321-123123-3333",
    • "invitingEmail": "pikachu@testkube.io"

    }

  ],
• "features": [

  • {

    • "name": "string",
    • "displayName": "string",
    • "description": "string",
    • "learnMoreUrl": "http://example.com",
    • "enabled": true

    }

  ]

}

Response samples

• 200
• 400
• 401
• 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",
• "slug": "demo-environment",
• "connected": true,
• "status": "Green",
• "organizationID": "733420bd-7e56-461f-8431-6378759e60ae",
• "agentToken": "tkcagnt_adead343112adeadcaaaaa221daee2",
• "connectCommand": "testkube pro connect --agent-key tkcagnt_111",
• "disconnectCommand": "testkube pro disconnect",
• "installCommand": "helm upgrade --install --create-namespace testkube testkube/testkube --set testkube-api.cloud.url=agent.testkube.xyz:443 --set testkube-api.cloud.key=<api-key> --set testkube-api.minio.enabled=false --set mongodb.enabled=false --namespace testkube",
• "installCommandCli": "testkube init-cloud --agent-key tkcagnt_111 --agent-url agent.testkube.xyz:443",
• "configureContextCommand": "testkube context set --api-url https://api.testkube.xyz --api-key <api-key> --agent-url https://agent.testkube.xyz --agent-key <agent-key>",
• "members": [

  • {

    • "email": "jack.the.ripper@testkube.io",
    • "status": "Invited",
    • "role": "read",
    • "inviteID": "1234567890-12312321-123123-3333",
    • "invitingEmail": "pikachu@testkube.io"

    }

  ],
• "features": [

  • {

    • "name": "string",
    • "displayName": "string",
    • "description": "string",
    • "learnMoreUrl": "http://example.com",
    • "enabled": true

    }

  ]

}