Testkube Control Plane ../secrets operations

• getList secrets
• postCreate secret
• getGet secret
• delDelete secret
• patchUpdate secret

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 secrets

List secrets available in cluster

path Parameters

id required	string organizationId
environmentId required	string environmentID

query Parameters

all	boolean Default: false flag to request all resources
namespace	string Default: "testkube" Namespace of the object

Responses

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

Response samples

• 200
• 403
• 502

Content type

application/json

[

• {

  • "name": "git-secret",
  • "namespace": "string",
  • "type": "Opaque",
  • "createdAt": "2022-07-30T06:54:15Z",
  • "updatedAt": "2022-07-30T06:54:15Z",
  • "controlled": true,
  • "owner": {

    • "kind": "string",
    • "name": "string"

    },
  • "labels": {

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

    },
  • "keys": [

    • "key1",
    • "key2",
    • "key3"

    ]

  }

]

Create secret

Create secret in the cluster

path Parameters

id required	string organizationId
environmentId required	string environmentID

Request Body schema: application/json

required

secret data

name required	string secret name
type	string Default: "Opaque" secret type
namespace	string secret namespace
	object (SecretOwner) Resource that owns the secret
	object labels associated with the secret
required	object data to store in the secret

Responses

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

Request samples

• Payload

Content type

application/json

{

• "name": "git-secret",
• "type": "Opaque",
• "namespace": "string",
• "owner": {

  • "kind": "string",
  • "name": "string"

  },
• "labels": {

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

  },
• "data": {

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

  }

}

Response samples

• 200
• 400
• 403
• 502

Content type

application/json

{

• "name": "git-secret",
• "namespace": "string",
• "type": "Opaque",
• "createdAt": "2022-07-30T06:54:15Z",
• "updatedAt": "2022-07-30T06:54:15Z",
• "controlled": true,
• "owner": {

  • "kind": "string",
  • "name": "string"

  },
• "labels": {

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

  },
• "keys": [

  • "key1",
  • "key2",
  • "key3"

  ]

}

Get secret

Get secret in the cluster

path Parameters

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

Responses

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

Response samples

• 200
• 400
• 403
• 404
• 502

Content type

application/json

{

• "name": "git-secret",
• "namespace": "string",
• "type": "Opaque",
• "createdAt": "2022-07-30T06:54:15Z",
• "updatedAt": "2022-07-30T06:54:15Z",
• "controlled": true,
• "owner": {

  • "kind": "string",
  • "name": "string"

  },
• "labels": {

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

  },
• "keys": [

  • "key1",
  • "key2",
  • "key3"

  ]

}

Delete secret

Delete secret in the cluster

path Parameters

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

query Parameters

namespace

string Default: "testkube" Namespace of the object

Responses

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

Response samples

• 400
• 403
• 404
• 502

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 secret

Update secret in the cluster

path Parameters

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

Request Body schema: application/json

required

secret data

name	string secret name
	object (SecretOwner) Resource that owns the secret
	object labels associated with the secret
	object data to store in the secret

Responses

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

Request samples

• Payload

Content type

application/json

{

• "name": "git-secret",
• "owner": {

  • "kind": "string",
  • "name": "string"

  },
• "labels": {

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

  },
• "data": {

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

  }

}

Response samples

• 200
• 400
• 403
• 404
• 502

Content type

application/json

{

• "name": "git-secret",
• "namespace": "string",
• "type": "Opaque",
• "createdAt": "2022-07-30T06:54:15Z",
• "updatedAt": "2022-07-30T06:54:15Z",
• "controlled": true,
• "owner": {

  • "kind": "string",
  • "name": "string"

  },
• "labels": {

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

  },
• "keys": [

  • "key1",
  • "key2",
  • "key3"

  ]

}