Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kubeshop Organizations API

The Organizations API from Kubeshop — 104 operation(s) for organizations.

Kubeshop Organizations API is one of 30 APIs that Kubeshop publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Organizations. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 175 operations across 104 paths, and defines 288 schemas. It is described by OpenAPI 3.0.1, at version 1.0.0.

Requests are made against 2 base URLs: https://api.testkube.io, https://.

175 operations 104 paths 288 schemas 30 DELETE88 GET17 PATCH35 POST5 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0.0
Base URL
https://api.testkube.io
License
Resource Areas
1

Paths & Operations 175

Across 104 paths, the API surfaces 175 operations — 30 DELETE, 88 GET, 17 PATCH, 35 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

Organizations 175
GET
/organizations
List organizations
listOrganizations 1 param → 200401
POST
/organizations
Create new organization
createOrganization body → 200400401429
GET
/organizations/{id}
Get organization by ID
getOrganization 1 param → 200401404
DELETE
/organizations/{id}
Delete organization
deleteOrganization 1 param → 204401
PATCH
/organizations/{id}
Update organization
updateOrganization 1 param body → 200400401
GET
/organizations/{id}/agents
List agents used in the organization
listAgents 8 params → 200401403404
POST
/organizations/{id}/agents
Create a new agent in the organization
createAgent 8 params body → 201400401403404
GET
/organizations/{id}/agents/{agentID}
Get agent from the organization
getAgent 3 params → 200401403404
DELETE
/organizations/{id}/agents/{agentID}
Delete agent in the organization
deleteAgent 3 params → 204401403404
PATCH
/organizations/{id}/agents/{agentID}
Update agent data in the organization
updateAgent 3 params body → 204401403404
GET
/organizations/{id}/agents/{agentID}/commands
[internal] Get commands for this super agent
getSuperAgentCommands 2 params → 200401403404
GET
/organizations/{id}/agents/{agentID}/secret-key
Get the secret key for selected agent.
getAgentSecretKey 2 params → 200401403404
DELETE
/organizations/{id}/agents/{agentID}/secret-key
Regenerate the secret key for selected agent.
regenerateAgentSecretKey 2 params → 200401403404
GET
/organizations/{id}/audit
Retrieve a list of application audit logs
listApplicationAuditLogs 9 params → 200400401
GET
/organizations/{id}/audit/export
Download an export of application audit logs
exportApplicationAuditLog 7 params → 200400401
GET
/organizations/{id}/audit/filters/subject
Returns a list of distinct values for the subject filter.
getAuditLogSubjectFilterValues 5 params → 200400401
GET
/organizations/{id}/audit/keymap
Retrieve a keymap of application audit log types
getApplicationAuditLogKeymap 1 param → 200401
GET
/organizations/{id}/boards
List board summaries
listBoards 8 params → 200401403
POST
/organizations/{id}/boards
Create a board
createBoard 1 param body → 200400401403
GET
/organizations/{id}/boards/{boardID}
Get a board
getBoard 2 params → 200401404
DELETE
/organizations/{id}/boards/{boardID}
Delete a board
deleteBoard 2 params → 204401403404
PATCH
/organizations/{id}/boards/{boardID}
Update a board
updateBoard 2 params body → 200400401403404
PATCH
/organizations/{id}/boards/shared-order
Reorder shared boards
reorderSharedBoards 1 param body → 204400401403
GET
/organizations/{id}/credentials
List credentials used in the organization
listCredentials 2 params → 200401403404
POST
/organizations/{id}/credentials
Create a new credential in the organization
createCredential 2 params body → 201400401403404409
GET
/organizations/{id}/credentials/{credentialName}
Get credential in the organization
getCredential 2 params → 200401403404
DELETE
/organizations/{id}/credentials/{credentialName}
Delete credential in the organization
deleteCredential 2 params → 204401403404
PATCH
/organizations/{id}/credentials/{credentialName}
Update value of the credential in the organization
updateCredential 2 params body → 204400401403404
GET
/organizations/{id}/environments
List environments
listEnvironments 2 params → 200400401403404
POST
/organizations/{id}/environments
Create new environment
createEnvironment 1 param body → 200400
DELETE
/organizations/{id}/environments
Delete environments
deleteEnvironments 2 params → 204401403
GET
/organizations/{id}/environments/{environmentID}
Get environment by ID
getEnvironment 2 params → 200401403
DELETE
/organizations/{id}/environments/{environmentID}
Delete test environment
deleteEnvironment 2 params → 204401403
PATCH
/organizations/{id}/environments/{environmentID}
Update environment
updateEnvironment 2 params body → 200400401403
GET
/organizations/{id}/environments/{environmentID}/collaborators
Lists all collaborators for this environment
listEnvironmentCollaborators 2 params → 200401403404
POST
/organizations/{id}/environments/{environmentID}/collaborators
Adds many collaborators to this environment
addManyEnvironmentCollaborators 2 params body → 200400401403404429
DELETE
/organizations/{id}/environments/{environmentID}/collaborators
Remove many collaborators from this environment
removeManyEnvironmentCollaborators 2 params body → 200400401403404
GET
/organizations/{id}/environments/{environmentID}/credentials
List credentials in the environment
listEnvironmentCredentials 3 params → 200401403404
POST
/organizations/{id}/environments/{environmentID}/credentials
Create a new credential in the environment
createEnvironmentCredential 2 params body → 201400401403404409
GET
/organizations/{id}/environments/{environmentID}/credentials/{credentialName}
Get credential in the environment
getEnvironmentCredential 3 params → 200401403404
DELETE
/organizations/{id}/environments/{environmentID}/credentials/{credentialName}
Delete credential in the environment
deleteEnvironmentCredential 3 params → 204401403404
PATCH
/organizations/{id}/environments/{environmentID}/credentials/{credentialName}
Update value of the credential in the environment
updateEnvironmentCredential 3 params body → 204400401403404
GET
/organizations/{id}/environments/{environmentID}/executions
Get recent executions
listExecutions 11 params → 200401403
GET
/organizations/{id}/environments/{environmentID}/executions/{executionID}/artifact-archive
Get artifact archive
getArtifactArchive 5 params → 200400401403404410
POST
/organizations/{id}/environments/{environmentID}/executions/{executionID}/artifacts
Get artifact
getArtifactPost 5 params body → 200400401403404410
GET
/organizations/{id}/environments/{environmentID}/executions/{executionID}/artifacts/{artifactID}
Get artifact
getArtifact 6 params → 200400401403404410
GET
/organizations/{id}/environments/{environmentID}/executions/{executionID}/download-artifact/{artifactID}
Download artifact
downloadArtifact 4 params → 307400401403404410500
GET
/organizations/{id}/environments/{environmentID}/executions/{executionID}/events
Get events that regard this execution.
getExecutionEvents 4 params → 200401403404
GET
/organizations/{id}/environments/{environmentID}/executions/{executionID}/junit
Get JUnit report for execution
getExecutionJUnitReports 3 params → 200401403404500
GET
/organizations/{id}/environments/{environmentID}/executions/{executionID}/logs
Get Testkube Pro logs for execution
getExecutionLogs 5 params → 200401403404410
POST
/organizations/{id}/environments/{environmentID}/executions/{executionID}/serve-artifact
Serve artifact
serveArtifactPost 5 params body → 200400401403404410
GET
/organizations/{id}/environments/{environmentID}/executions/{executionID}/serve-artifact/{artifactID}
Serve artifact
serveArtifact 6 params → 200400401403404410
POST
/organizations/{id}/environments/{environmentID}/test-workflow-executions/{executionID}/artifacts
Get Test Workflow artifact
getTestWorkflowArtifactPost 3 params body → 200400401403404
GET
/organizations/{id}/environments/{environmentID}/test-workflow-executions/{executionID}/artifacts/{artifactID}
Get Test Workflow artifact
getTestWorkflowArtifact 4 params → 200400401403404
GET
/organizations/{id}/environments/{environmentID}/test-workflow-executions/{executionID}/download-artifact/{artifactID}
Download test workflow artifact
downloadTestWorkflowArtifact 4 params → 307400401403404500
GET
/organizations/{id}/environments/{environmentID}/test-workflow-executions/{executionID}/logs
Get Test Workflow logs URL
getTestWorkflowLogsURL 3 params → 200400401403404
POST
/organizations/{id}/environments/{environmentID}/test-workflow-executions/{executionID}/serve-artifact
Serve artifact
serveTestWorkflowArtifactPost 5 params body → 200400401403404
GET
/organizations/{id}/environments/{environmentID}/test-workflow-executions/{executionID}/serve-artifact/{artifactID}
Serve Test Workflow artifact
serveTestWorkflowArtifact 4 params → 200400401403404
GET
/organizations/{id}/environments/{environmentID}/test-workflow-executions/summaries
Get execution summaries in bulk
getTestWorkflowExecutionSummariesBulk 6 params → 200400401403500
DELETE
/organizations/{id}/environments/{environmentID}/test-workflows/{testWorkflowName}
Delete test workflow
deleteTestWorkflowExecutions 3 params → 204401403
GET
/organizations/{id}/environments/{environmentID}/test-workflows/{testWorkflowName}/credentials
List credentials for the test workflow
listWorkflowCredentials 4 params → 200401403404
POST
/organizations/{id}/environments/{environmentID}/test-workflows/{testWorkflowName}/credentials
Create a new credential for the test workflow
createWorkflowCredential 3 params body → 201400401403404409
GET
/organizations/{id}/environments/{environmentID}/test-workflows/{testWorkflowName}/credentials/{credentialName}
Get credential for the test workflow
getWorkflowCredential 4 params → 200401403404
DELETE
/organizations/{id}/environments/{environmentID}/test-workflows/{testWorkflowName}/credentials/{credentialName}
Delete credential for the test workflow
deleteWorkflowCredential 4 params → 204401403404
PATCH
/organizations/{id}/environments/{environmentID}/test-workflows/{testWorkflowName}/credentials/{credentialName}
Update value of the credential for the test workflow
updateWorkflowCredential 4 params body → 204400401403404
GET
/organizations/{id}/environments/{environmentID}/test-workflows/definitions
Get workflow definitions in bulk
getTestWorkflowDefinitionsBulk 5 params → 200400401403500
GET
/organizations/{id}/environments/{environmentId}/agent/executions
Get all test executions
listExecutions 11 params → 200404500
POST
/organizations/{id}/environments/{environmentId}/agent/executions
Starts new test executions
executeTests 6 params body → 201400404500502
GET
/organizations/{id}/environments/{environmentId}/agent/executions/{executionID}
Get test execution by ID
getExecutionByID 3 params → 200404500502
GET
/organizations/{id}/environments/{environmentId}/agent/executions/{id}/artifact-archive
Download artifact archive
downloadArchive 4 params → 200404500
GET
/organizations/{id}/environments/{environmentId}/agent/executions/{id}/artifacts
Get execution's artifacts by ID
getExecutionArtifacts 3 params → 200404500
GET
/organizations/{id}/environments/{environmentId}/agent/executions/{id}/artifacts/{filename}
Download artifact
downloadFile 4 params → 200404500
GET
/organizations/{id}/environments/{environmentId}/agent/executions/{id}/logs
Get execution's logs by ID
getExecutionLogs 3 params → 200500
GET
/organizations/{id}/environments/{environmentId}/agent/executions/{id}/logs/v2
Get execution's logs by ID version 2
getExecutionLogsV2 3 params → 200500
GET
/organizations/{id}/environments/{environmentId}/agent/test-workflow-executions
List test workflow executions
listTestWorkflowExecutions 6 params → 200400402502
POST
/organizations/{id}/environments/{environmentId}/agent/test-workflow-executions
Execute test workflows
executeTestWorkflows 4 params body → 200400402502
GET
/organizations/{id}/environments/{environmentId}/agent/test-workflow-executions/{executionID}
Get test workflow execution
getTestWorkflowExecution 3 params → 200400402502
POST
/organizations/{id}/environments/{environmentId}/agent/test-workflow-executions/{executionID}/abort
Abort test workflow execution
abortTestWorkflowExecution 4 params → 204400402502
GET
/organizations/{id}/environments/{environmentId}/agent/test-workflow-executions/{executionID}/artifact-archive
Download test workflow artifact archive
downloadTestWorkflowArtifactArchive 4 params → 200402404500
GET
/organizations/{id}/environments/{environmentId}/agent/test-workflow-executions/{executionID}/artifacts
Get test workflow execution's artifacts by ID
getTestWorkflowExecutionArtifacts 3 params → 200402404500
GET
/organizations/{id}/environments/{environmentId}/agent/test-workflow-executions/{executionID}/artifacts/{filename}
Download test workflow artifact
downloadTestWorkflowArtifact 4 params → 200402404500
POST
/organizations/{id}/environments/{environmentId}/agent/test-workflow-executions/{executionID}/rerun
Rerun test workflow execution
rerunTestWorkflowExecution 3 params body → 200400502
GET
/organizations/{id}/environments/{environmentId}/agent/test-workflow-templates
List test workflow templates
listTestWorkflowTemplates 3 params → 200400402502
PUT
/organizations/{id}/environments/{environmentId}/agent/test-workflow-templates
Validate test workflow template
validateTestWorkflowTemplate 2 params body → 204400502
POST
/organizations/{id}/environments/{environmentId}/agent/test-workflow-templates
Create test workflow template
createTestWorkflowTemplate 2 params body → 200400402502
DELETE
/organizations/{id}/environments/{environmentId}/agent/test-workflow-templates
Delete test workflow templates
deleteTestWorkflowTemplates 3 params → 204400402502
GET
/organizations/{id}/environments/{environmentId}/agent/test-workflow-templates/{id}
Get test workflow template details
getTestWorkflowTemplate 3 params → 200402404502
PUT
/organizations/{id}/environments/{environmentId}/agent/test-workflow-templates/{id}
Update test workflow template details
updateTestWorkflowTemplate 3 params body → 200402404502
DELETE
/organizations/{id}/environments/{environmentId}/agent/test-workflow-templates/{id}
Delete test workflow template
deleteTestWorkflowTemplate 3 params → 204402404502
GET
/organizations/{id}/environments/{environmentId}/agent/test-workflow-with-executions
List test workflows with latest execution
listTestWorkflowWithExecutions 3 params → 200400402502
GET
/organizations/{id}/environments/{environmentId}/agent/test-workflow-with-executions/{id}
Get test workflow details with latest execution
getTestWorkflowWithExecution 3 params → 200402404502
GET
/organizations/{id}/environments/{environmentId}/agent/test-workflow-with-executions/{id}/tags
List test workflow execution tags
listTestWorkflowWithExecutionTags 3 params → 200502
GET
/organizations/{id}/environments/{environmentId}/agent/test-workflows
List test workflows
listTestWorkflows 3 params → 200400402502
PUT
/organizations/{id}/environments/{environmentId}/agent/test-workflows
Validate test workflow
validateTestWorkflow 2 params body → 204400502
POST
/organizations/{id}/environments/{environmentId}/agent/test-workflows
Create test workflow
createTestWorkflow 2 params body → 200400402502
DELETE
/organizations/{id}/environments/{environmentId}/agent/test-workflows
Delete test workflows
deleteTestWorkflows 4 params → 204400402502
GET
/organizations/{id}/environments/{environmentId}/agent/test-workflows/{id}
Get test workflow details
getTestWorkflow 3 params → 200402404502
PUT
/organizations/{id}/environments/{environmentId}/agent/test-workflows/{id}
Update test workflow details
updateTestWorkflow 3 params body → 200402404502
DELETE
/organizations/{id}/environments/{environmentId}/agent/test-workflows/{id}
Delete test workflow
deleteTestWorkflow 5 params → 204402404502
POST
/organizations/{id}/environments/{environmentId}/agent/test-workflows/{id}/abort
Abort all test workflow executions
abortAllTestWorkflowExecutions 3 params → 204400402502
GET
/organizations/{id}/environments/{environmentId}/agent/test-workflows/{id}/executions
List test workflow executions
listTestWorkflowExecutionsByTestWorkflow 6 params → 200400402502
POST
/organizations/{id}/environments/{environmentId}/agent/test-workflows/{id}/executions
Execute test workflow
executeTestWorkflow 4 params body → 200400402502
GET
/organizations/{id}/environments/{environmentId}/agent/test-workflows/{id}/executions/{executionID}
Get test workflow execution
getTestWorkflowExecutionByTestWorkflow 4 params → 200400402502
POST
/organizations/{id}/environments/{environmentId}/agent/test-workflows/{id}/executions/{executionID}/abort
Abort test workflow execution
abortTestWorkflowExecutionByTestWorkflow 5 params → 204400402502
POST
/organizations/{id}/environments/{environmentId}/agent/test-workflows/{id}/executions/{executionID}/rerun
Rerun test workflow execution
rerunTestWorkflowExecutionByTestWorkflow 4 params body → 200400502
GET
/organizations/{id}/environments/{environmentId}/agent/test-workflows/{id}/metrics
Get test workflow metrics
getTestWorkflowMetrics 3 params → 200400402502
GET
/organizations/{id}/environments/{environmentId}/agent/test-workflows/{id}/tags
List test workflow execution tags
listTestWorkflowTagsByTestWorkflow 3 params → 200502
GET
/organizations/{id}/environments/{environmentId}/agent/triggers
List test triggers
listTestTriggers 4 params → 200400502
POST
/organizations/{id}/environments/{environmentId}/agent/triggers
Create new test trigger
createTestTrigger 2 params body → 200400502
DELETE
/organizations/{id}/environments/{environmentId}/agent/triggers
Delete test triggers
deleteTestTriggers 4 params → 204400404502
PATCH
/organizations/{id}/environments/{environmentId}/agent/triggers
Bulk update test triggers
bulkUpdateTestTriggers 2 params body → 200400502
GET
/organizations/{id}/environments/{environmentId}/agent/triggers/{id}
Get test trigger by ID
getTestTriggerByID 4 params → 200404502
DELETE
/organizations/{id}/environments/{environmentId}/agent/triggers/{id}
Delete test trigger
deleteTestTrigger 4 params → 204404502
PATCH
/organizations/{id}/environments/{environmentId}/agent/triggers/{id}
Update test trigger
updateTestTrigger 5 params body → 200400404502
GET
/organizations/{id}/environments/{environmentId}/agent/webhook-templates
List webhook templates
listWebhookTemplates 3 params → 200400502
POST
/organizations/{id}/environments/{environmentId}/agent/webhook-templates
Create new webhook template
createWebhookTemplate 2 params body → 200201400502
DELETE
/organizations/{id}/environments/{environmentId}/agent/webhook-templates
Delete webhook templates
deleteWebhookTemplates 3 params → 204502
GET
/organizations/{id}/environments/{environmentId}/agent/webhook-templates/{id}
Get webhook template details
getWebhookTemplate 3 params → 200400404500502
DELETE
/organizations/{id}/environments/{environmentId}/agent/webhook-templates/{id}
Delete webhook template
deleteWebhookTemplate 3 params → 204404502
PATCH
/organizations/{id}/environments/{environmentId}/agent/webhook-templates/{id}
Update new webhook template
updateWebhookTemplate 3 params body → 200400404502
GET
/organizations/{id}/environments/{environmentId}/agent/webhooks
List webhooks
listWebhooks 3 params → 200400502
POST
/organizations/{id}/environments/{environmentId}/agent/webhooks
Create new webhook
createWebhook 2 params body → 200201400502
DELETE
/organizations/{id}/environments/{environmentId}/agent/webhooks
Delete webhooks
deleteWebhooks 3 params → 204502
GET
/organizations/{id}/environments/{environmentId}/agent/webhooks/{id}
Get webhook details
getWebhook 3 params → 200400404500502
DELETE
/organizations/{id}/environments/{environmentId}/agent/webhooks/{id}
Delete webhook
deleteWebhook 3 params → 204404502
PATCH
/organizations/{id}/environments/{environmentId}/agent/webhooks/{id}
Update new webhook
updateWebhook 3 params body → 200400404502
PUT
/organizations/{id}/favorites
Create or return a favorite
putFavorite 1 param body → 200201400401403404
DELETE
/organizations/{id}/favorites
Delete a favorite
deleteFavorite 1 param body → 204400401403404
GET
/organizations/{id}/groups
List organization groups
listResourceGroups 1 param → 200401403
POST
/organizations/{id}/groups
Create a resource group
createResourceGroup 1 param body → 200400401403
GET
/organizations/{id}/groups/{groupID}
Get a resource group
getResourceGroup 2 params → 200401404
DELETE
/organizations/{id}/groups/{groupID}
Delete a resource group
deleteResourceGroup 2 params → 204400401403404
PATCH
/organizations/{id}/groups/{groupID}
Update a resource group
updateResourceGroup 2 params body → 200400401403404
GET
/organizations/{id}/groups/{groupID}/collaborators
Lists all collaborators for this resource group
listResourceGroupCollaborators 2 params → 200401403404
POST
/organizations/{id}/groups/{groupID}/collaborators
Adds all collaborators to this resource group
addManyResourceGroupCollaborators 2 params body → 200400401403404429
DELETE
/organizations/{id}/groups/{groupID}/collaborators
Remove many members from this group
removeManyResourceGroupCollaborators 2 params body → 200400401403404
GET
/organizations/{id}/groups/{groupID}/credentials
List credentials in the resource group
listResourceGroupCredentials 3 params → 200401403404
POST
/organizations/{id}/groups/{groupID}/credentials
Create a new credential in the resource group
createResourceGroupCredential 2 params body → 201400401403404409
GET
/organizations/{id}/groups/{groupID}/credentials/{credentialName}
Get credential in the resource group
getResourceGroupCredential 3 params → 200401403404
DELETE
/organizations/{id}/groups/{groupID}/credentials/{credentialName}
Delete credential in the resource group
deleteResourceGroupCredential 3 params → 204401403404
PATCH
/organizations/{id}/groups/{groupID}/credentials/{credentialName}
Update value of the credential in the resource group
updateResourceGroupCredential 3 params body → 204400401403404
GET
/organizations/{id}/insights/executions
Get environment execution duration stats
getExecutionInsights 8 params → 200400401403
GET
/organizations/{id}/insights/series
Get time series insights
getTimeSeriesInsights 12 params → 200400401403
GET
/organizations/{id}/insights/series/catalog
List granular insight series catalog
listInsightSeriesCatalog 9 params → 200400401403
GET
/organizations/{id}/insights/series/catalog/metric-keys
List granular insight series metric keys
listInsightSeriesMetricKeys 8 params → 200400401403
GET
/organizations/{id}/insights/series/executions
Get execution references
listInsightExecutions 9 params → 200401403
GET
/organizations/{id}/insights/stats
Get environment execution count stats
getPassFailInsights 6 params → 200400401403
GET
/organizations/{id}/insights/workflows
Get environment workflow summaries
getWorkflowSummaryInsights 7 params → 200400401403
GET
/organizations/{id}/integrations/github/connect
Get GitHub App connect URL
getGitHubConnectURL 1 param → 200400401403500
GET
/organizations/{id}/integrations/github/installations
List GitHub App installations
listGitHubInstallations 1 param → 200401403500
POST
/organizations/{id}/integrations/github/installations
Add GitHub App installation manually
addGitHubInstallation 1 param body → 200400401403409500
DELETE
/organizations/{id}/integrations/github/installations/{githubOrg}
Remove GitHub App installation
deleteGitHubInstallation 2 params → 204401403500
GET
/organizations/{id}/invites
List organization invites
listInvites 2 params → 200401403
POST
/organizations/{id}/invites
Invite users to the organization
createInvites 1 param body → 200400401403429500
GET
/organizations/{id}/invites/{inviteID}
Get organization invite
getInvite 2 params → 200401403404
PATCH
/organizations/{id}/invites/{inviteID}
Updates an organization invite
updateInvite 2 params body → 200400401403404
POST
/organizations/{id}/invites/{inviteID}/resend
Resend organization invite
resendInvite 2 params → 201401403404
POST
/organizations/{id}/invites/{inviteID}/revoke
Revoke organization invite
revokeInvite 2 params → 201400401403404
GET
/organizations/{id}/members
Get organization members
getOrganizationMembers 2 params → 200401402403
DELETE
/organizations/{id}/members/{memberEmail}
Remove user from organization
deleteOrganizationMember 2 params → 204400
PATCH
/organizations/{id}/members/{memberEmail}
Update org member role
updateOrganizationMemberRole 2 params body → 200400401402403429
GET
/organizations/{id}/members/{memberEmail}/permissions
Get member permissions
getOrganizationMemberPermissions 2 params → 200404
GET
/organizations/{id}/teams
List organization teams
listTeams 1 param → 200401403
POST
/organizations/{id}/teams
Create a team
createTeam 1 param body → 200400401403
GET
/organizations/{id}/teams/{teamID}
Get a team
getTeam 2 params → 200401404
DELETE
/organizations/{id}/teams/{teamID}
Delete a team
deleteTeam 2 params → 204400401403404
PATCH
/organizations/{id}/teams/{teamID}
Update a team
updateTeam 2 params body → 200400401403404
GET
/organizations/{id}/teams/{teamID}/members
Lists all members for this team
listTeamMembers 2 params → 200401403404
POST
/organizations/{id}/teams/{teamID}/members
Adds members to this team
addTeamMembers 2 params body → 200400401403404429
DELETE
/organizations/{id}/teams/{teamID}/members
Remove many members from this team
removeTeamMembers 2 params body → 200400401403404
GET
/organizations/{id}/tokens
List API Tokens
listAPITokens 4 params → 200400401404
POST
/organizations/{id}/tokens
Create API Token
createAPIToken 1 param body → 200400402403
GET
/organizations/{id}/tokens/{tokenID}
Get API Token
getOrganizationToken 2 params → 200400401403404
DELETE
/organizations/{id}/tokens/{tokenID}
Delete API Token
deleteAPIToken 2 params → 204400401403
GET
/organizations/invites/{inviteID}/acceptdeprecated
Accept email invite
acceptOrganizationEmailInvite 1 param → 200400401404

Schemas 288

The contract defines 288 schemas that model the data the API accepts and returns. The most detailed are ExecutionRequest (49 properties), Execution (38 properties), TestWorkflowStepExecuteTestExecutionRequest (28 properties), TestWorkflowExecution (25 properties). Each schema is shown below with its type and property counts.

ImagePullPolicy
string
ExecutionsMetrics
object
12 properties
TestTriggerProbeSpec
object
3 properties
AgentRunnerPolicy
object
1 property 1 required
GithubInstallation
object
2 properties 2 required
Members
array
Environments
object
1 property 1 required
GRPCAction
object
2 properties
TestContent
object
4 properties
GroupedExecutionsStats
object
Statistics of executions, including total and grouped counts.
2 properties 2 required
TestWorkflowExecutionHealth
object
3 properties 3 required
PlanLimits
object
23 properties
LogsStats
object
2 properties 2 required
TestTriggerContentGit
object
15 properties 1 required
CSIVolumeSource
object
Represents a source location of a volume to mount, managed by an external CSI driver
5 properties
MemberRole
string
TestWorkflowStepParallel
object
HostAlias
object
2 properties
TestTriggerContentSelector
object
1 property
Variable
object
5 properties
EnvironmentWorkflowSummary
object
7 properties 7 required
AgentCapability
string
TestWorkflowTarballRequest
object
2 properties 1 required
PodSecurityContext
object
13 properties
GroupedExecutionsCountByTimestamp
array
An array of touples representing counts of execution timestamp and count
AssertionResult
object
execution result data
3 properties
SELinuxOptions
object
4 properties
TCPSocketAction
object
2 properties
ExecutionsCountByGrouping
object
Statistics of executions, grouped by status.
2 properties 2 required
TestWorkflowConcurrencyPolicy
object
configuration to control concurrent executions.
3 properties
TemplatableBoxedInteger
object
1 property 1 required
ExecutionsTotals
object
various execution counters
5 properties 6 required
ConfigMapRef
object
Testkube internal reference for data in Kubernetes config maps
3 properties 2 required
ExecutionStatus
string
TestWorkflowExecutionRuntime
object
runtime configuration for a specific test workflow execution
1 property
LocalObjectReference
object
Reference to Kubernetes object
1 property
HostPathVolumeSource
object
hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or…
2 properties 1 required
EmptyDirVolumeSource
object
emptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumesemptydir
2 properties
TestTriggerActions
string
supported actions for test triggers
SeccompProfile
object
2 properties
WebhookConfig
object
configuration values
Organization
EnvironmentDurationStats
object
Average workflow execution duration and execution count statistics grouped by status.
2 properties 2 required
TestWorkflowContentFile
object
4 properties 1 required
TestWorkflowExecutionRequest
object
10 properties
ExecutionsMetricsExecutions
object
8 properties
PodAffinityTerm
object
4 properties
Field
object
2 properties 2 required
TestWorkflowContentTarball
object
3 properties 2 required
LogV2
object
Log format version 2
8 properties 2 required
TestWorkflowStepExecuteTestExecutionRequest
object
28 properties
TestWorkflowExecutionStepResourceAggregations
object
Step-based resource metrics aggregations (by measurement and field)
2 properties
TestWorkflowResult
object
13 properties 5 required
TestkubeEvent
object
9 properties 7 required
TestWorkflowExecution
object
25 properties 3 required
Sysctl
object
2 properties
ExecutionsDurationByGrouping
object
Statistics of average execution durations in milliseconds, grouped by status.
2 properties 2 required
TestTriggerConcurrencyPolicies
string
supported concurrency policies for test triggers
PlanName
string
ApplicationAuditEventMetadata
object
Metadata object containing key-value pairs with additional information. This can store data such as environment IDs, organization IDs, or any custom informatio…
WebhookTemplateCreateRequest
object
webhook template create request body
NodeSelector
object
1 property
LogV1
object
Log format version 1
1 property 1 required
ProjectedVolumeSource
object
Represents a projected volume source
2 properties
TestWorkflowStepParallelTransfer
object
4 properties 1 required
ExecutionTarget
object
3 properties
TestWorkflowEvent
object
1 property
AzureDiskVolumeSource
object
azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
6 properties 2 required
TestWorkflowServiceSpec
object
TestWorkflowConfigSchema
object
configuration definition
TestWorkflowReport
object
4 properties
TestTriggerConditionStatuses
string
supported kubernetes condition statuses for test triggers
TestWorkflowExecutionSummary
object
16 properties 3 required
ServeArtifact
object
1 property 1 required
EnvReference
object
Reference to env resource
4 properties 1 required
Team
object
7 properties 6 required
ResourceFieldRef
object
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and…
3 properties 1 required
TestWorkflowTemplateRef
object
2 properties 1 required
VariableType
string
AWSElasticBlockStoreVolumeSource
object
awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io…
4 properties 1 required
EventSeries
object
2 properties 2 required
MemberStatus
string
Did Member confirmed organization subscription
WebhookConfigValue
object
configuration value
2 properties
TestWorkflowResourcesList
object
4 properties
TestWorkflowWithExecution
object
2 properties
ArtifactURL
object
1 property 1 required
NFSVolumeSource
object
nfs represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumesnfs
3 properties 2 required
TestWorkflowExecutionConfig
object
map of configuration values used in the test workflow execution
Repository
object
repository representation for tests in git repositories
12 properties 2 required
TestWorkflowRunningContextActorType
string
supported actors for test workflow running context
TestWorkflowStep
object
23 properties
SecretRef
object
Testkube internal reference for secret storage in Kubernetes secrets
3 properties 2 required
TestWorkflowPvcConfig
object
9 properties
TestTriggerCondition
object
supported condition for test triggers
4 properties 2 required
Webhook
object
CRD based webhook data
19 properties 1 required
TestWorkflowRunningContextInterfaceType
string
supported interfaces for test workflow running context
HTTPGetAction
object
5 properties
Log
object
4 properties 4 required
LabelSelectorRequirement
object
3 properties
TestWorkflowExecutionResourceAggregations
object
TestWorkflowExecutionResourceAggregations provides min, max, average, total, and standard deviation values for a resource metric.
5 properties
BoardLayoutSummary
object
2 properties 2 required
ConfigMapVolumeSource
object
configMap represents a configMap that should populate this volume
4 properties
ConfigMapEnvSource
object
2 properties 1 required
Report
object
5 properties 2 required
NodeSelectorRequirement
object
3 properties
TestWorkflowReportSummary
object
6 properties
ExecutionRefs
object
4 properties 3 required
TestWorkflowTemplate
object
9 properties
TeamMember
object
2 properties 2 required
JUnitTestCase
object
Represents an individual test case element
8 properties 2 required
TestWorkflowTagValue
object
tag values to pass to the test workflow execution
TestWorkflowRunningContext
object
running context for test workflow execution
2 properties 2 required
EventTarget
object
3 properties 1 required
InsightSeriesCatalogItem
object
7 properties 7 required
TestWorkflowExecutionResourceAggregationsReport
object
TestWorkflowExecutionResourceAggregationsReport provides resource usage aggregations for an entire TestWorkflowExecution (globally) and also per-step (by measu…
2 properties
TestWorkflowResources
object
2 properties
Toleration
object
5 properties
EnvVar
object
4 properties
TestWorkflowStepControl
object
5 properties
GroupedExecutionsRatioStats
object
Statistics of pass/fail ratio.
2 properties 2 required
BasicObject
object
6 properties 2 required
TypedObjectReference
object
TypedObjectReference contains enough information to let you locate the typed referenced object inside the specified namespace
1 property
Member
object
9 properties 1 required
ContentGitAuthType
string
auth type for git requests
ExecutionsResult
object
the result for a page of executions
3 properties 2 required
FieldRef
object
Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels[' '], metadata.annotations[' '], spec.nodeName, spec.serviceAccountName…
2 properties 1 required
TestWorkflowConfigValue
object
configuration values to pass to the template
Source
string
synchronisation sources
TestWorkflowStepExecuteStrategy
object
4 properties
TestWorkflowSignature
object
7 properties
AzureFileVolumeSource
object
azureFile represents an Azure File Service mount on the host and bind mount to the pod.
3 properties 2 required
TypedLocalObjectReference
object
TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace
3 properties
TestWorkflowRetryPolicy
object
2 properties 1 required
BoxedStringList
object
1 property 1 required
JUnitTestSuite
object
Represents a test suite element
12 properties 3 required
TestWorkflowTimeouts
object
configures timeout behavior for a workflow (queue, initialization)
2 properties
Volume
object
Volume represents a named volume in a pod that may be accessed by any container in the pod.
14 properties 1 required
TestTriggerExecutions
string
supported test resources for test triggers
PodDNSConfig
object
3 properties
TestTriggerUpsertRequest
object
test trigger create or update request body
4 required
PodResourceClaim
object
2 properties
Environment
TestWorkflowSummary
object
5 properties
InsightSeriesCatalogResponse
object
2 properties 2 required
Agent
object
14 properties 4 required
Tokens
object
1 property 1 required
ResourceRequest
object
resource request specification
2 properties
SuperAgentCommands
object
10 properties 10 required
ExecAction
object
1 property
TestWorkflowSpec
object
16 properties
WebhookTemplateRef
object
1 property 1 required
Problem
object
problem response in case of error
6 properties 5 required
SecurityContext
object
12 properties
TestWorkflowExecutionConfigValue
object
configuration values used in the test workflow execution
6 properties
EnvVarSource
object
EnvVarSource represents a source for the value of an EnvVar.
4 properties
PodSchedulingGate
object
1 property
PreferredSchedulingTerm
object
2 properties 1 required
Credential
object
12 properties 3 required
TopologySpreadConstraint
object
8 properties
Collaborator
object
10 properties 5 required
MemberRoleChange
object
2 properties 1 required
HTTPHeader
object
2 properties
EnvironmentWorkflowSummaries
array
A list of environment workflow summaries.
TestContentRequest
object
test content request body
1 property
TestWorkflowRunningContextActor
object
running context actor for test workflow execution
6 properties 1 required
Invite
object
19 properties 8 required
TestWorkflow
object
11 properties
AppArmorProfile
object
2 properties
ExecutionResult
object
execution result returned from executor
6 properties 1 required
ReorderSharedBoardsReq
object
1 property 1 required
TimeSeriesData
array
WeightedPodAffinityTerm
object
2 properties 1 required
TestWorkflowStepParallelFetch
object
3 properties 1 required
AgentEnvironment
object
3 properties 3 required
TestWorkflowIndependentStep
object
21 properties
TestWorkflowResultSummary
object
10 properties 5 required
EventType
string
TestTriggerContentGitPullRequest
object
Pull request trigger configuration for GitHub API polling.
3 properties
TestTriggerResources
string
supported kubernetes resources for test triggers
ArtifactRequest
object
artifact request body with test artifacts
9 properties
EnvFromSource
object
3 properties
TestWorkflowStepArtifactsCompression
object
1 property
ExecutionRef
object
16 properties 8 required
TestTriggerResourceRef
object
3 properties 1 required
TestWorkflowStepStatus
string
JUnitReport
object
Represents the root element, which can contain one or more test suites
3 properties
Logs
object
2 properties 2 required
TestWorkflowExecutionResourceAggregationsByMeasurement
object
TestWorkflowExecutionResourceAggregationsByMeasurement provides resource usage aggregations for a specific measurement (e.g. CPU, Memory, etc.) across all step…
TestWorkflowJobConfig
object
4 properties
TestTriggerActionParameters
object
supported action parameters for test triggers
3 properties
TestWorkflowWithExecutionSummary
object
2 properties
Capabilities
object
2 properties
TestWorkflowStepOperations
object
5 properties
Affinity
object
3 properties
BoardSummary
object
12 properties 9 required
FavoriteReq
object
3 properties 3 required
BoxedBoolean
object
1 property 1 required
TestTriggerSelector
object
5 properties
AuditLogDistinctSubjects
object
A key-value map where keys are entity types and values are distinct subjects.
Plan
ClaimSource
object
2 properties
TestWorkflowStepArtifacts
object
3 properties 1 required
TimeSeriesSegment
object
2 properties 2 required
ExecutorOutput
object
CRD based executor data
4 properties 1 required
TestWorkflowTarballFilePattern
object
dynamic expression or static list of file patterns to pack
2 properties
TestTriggerConditionSpec
object
3 properties
Token
TestWorkflowStepExecuteTestWorkflowRef
object
TestTrigger
object
21 properties 4 required
SecretEnvSource
object
2 properties 1 required
GCEPersistentDiskVolumeSource
object
gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/doc…
4 properties 1 required
TestWorkflowPodConfig
object
24 properties
EnvironmentExecutionStats
object
Overall statistics, including totals, ratio, and statistics for passed and failed executions.
3 properties 3 required
WebhookTemplateUpdateRequest
object
webhook template update request body
Entity
object
Holds information about an action participant.
4 properties 4 required
PodRequest
object
pod request body
3 properties
GroupedExecutionsRatioByTimestamp
array
A map from string to float64 representing the ratio of executions, grouped by timestamp.
TestWorkflowStatus
string
WebhookTemplate
object
CRD based webhook data template
16 properties 1 required
TestWorkflowCronJobConfig
object
cron job configuration
6 properties 1 required
TestWorkflowPause
object
3 properties 2 required
SecretVolumeSource
object
secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumessecret
4 properties
TestTriggerFieldCondition
object
3 properties 2 required
PodResourcesRequest
object
pod resources request specification
2 properties
WebhookCreateRequest
object
webhook create request body
Labels
object
ExecutionRequest
object
test execution request body
49 properties
TestWorkflowExecutionsResult
object
3 properties 3 required
PodAffinity
object
2 properties
Board
object
12 properties 9 required
NodeSelectorTerm
object
2 properties
PodDNSConfigOption
object
2 properties
TestWorkflowIndependentStepParallel
object
LabelSelector
object
2 properties
SilentMode
object
controls what aspects of an execution should be silent (not tracked/processed)
5 properties
GithubConnectURL
object
1 property 1 required
WindowsSecurityContextOptions
object
4 properties
PersistentVolumeClaimVolumeSource
object
persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/stora…
2 properties 1 required
ResourceGroup
object
7 properties 7 required
TestTriggerFieldOperator
string
supported comparison operators for TestTrigger match conditions
TestWorkflowStepExecuteTestRef
object
VolumeMount
object
VolumeMount describes a mounting of a Volume within a container.
6 properties 2 required
PlanStatus
string
TestWorkflowIndependentServiceSpec
object
WebhookParameterSchema
object
parameter definition
6 properties 1 required
WebhookUpdateRequest
object
webhook update request body
Favorite
object
6 properties 6 required
ExecutionSummary
object
Execution summary
13 properties 5 required
TestWorkflowContent
object
3 properties
TestWorkflowParameterSchema
object
15 properties 1 required
GroupedExecutionDurationsByGrouping
array
An array of touples of string and int64 representing the execution grouping and average execution duration (milliseconds).
ExecutionStepResult
object
execution result data
4 properties 2 required
InsightSeriesMetricKeysResponse
object
2 properties 2 required
TestWorkflowStatusSummary
object
test workflow status
1 property
TestWorkflowSystem
object
2 properties
TestWorkflowExecutionSchema
object
test workflow execution configuration
3 properties
RunningContext
object
running context for test or test suite execution
2 properties 1 required
Syncable
object
source information about resources that may have been synced from multiple sources. An empty source indicates that the source was the UI/API for backwards comp…
2 properties
NodeAffinity
object
2 properties
TestWorkflowStepRun
object
11 properties
TimeSeriesSegments
array
EnvironmentFeature
object
5 properties 2 required
RepositoryParameters
object
repository parameters for tests in git repositories
4 properties
TestWorkflowRunningContextInterface
object
running context interface for test workflow execution
2 properties 1 required
TestWorkflowTemplateSpec
object
15 properties
BoxedInteger
object
1 property 1 required
TestWorkflowParameterType
string
type of the config parameter
ApplicationAuditEvent
object
Represents an audit event for application operations.
9 properties 9 required
BoxedString
object
1 property 1 required
Artifact
object
API server artifact
4 properties
TestWorkflowContentGit
object
12 properties
TestTriggerProbe
object
supported probe for test triggers
5 properties
Variables
object
execution variables passed to executor converted to vars for usage in tests
GroupedExecutionCountByGrouping
array
An array of touples of string and int32 representing the execution grouping and count
Scope
object
3 properties 3 required
TestWorkflowStepExecute
object
4 properties
Probe
object
Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
10 properties
ApplicationAuditLogKeymap
object
Represents a keymap that defines various audit-related types such as event types, actions, entity types, and sources. Each map contains a set of key-value pair…
4 properties 4 required
TestWorkflowContainerConfig
object
10 properties
CephFSVolumeSource
object
cephFS represents a Ceph FS mount on the host that shares a pod's lifetime
6 properties 1 required
TestWorkflowOutput
object
3 properties
ObjectRef
object
2 properties 1 required
TestWorkflowStepResult
object
6 properties
ApplicationAuditLog
array
List of audit events
TimeSeriesDatum
object
3 properties 2 required
Organizations
object
1 property 1 required
JUnitTestSuitesSummary
object
Summary of all test suites
6 properties
Execution
object
test execution
38 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kubeshop-organizations-api-openapi.yml Raw ↑

Other APIs Kubeshop publishes across the network.

Kubeshop api API
Kubeshop artifacts API
Kubeshop cluster-resources API
Kubeshop Executions API
Kubeshop executor API
Kubeshop keymap API
Kubeshop labels API
Kubeshop logs API
Kubeshop pro API
Kubeshop repository API
Kubeshop secrets API
Kubeshop Status Pages API