Kubeshop

Kubeshop Organizations API

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

GitHub OpenAPI

Operations 175

GET /organizations List organizations #
POST /organizations Create new organization #
GET /organizations/{id} Get organization by ID #
DELETE /organizations/{id} Delete organization #
PATCH /organizations/{id} Update organization #
GET /organizations/{id}/agents List agents used in the organization #
POST /organizations/{id}/agents Create a new agent in the organization #
GET /organizations/{id}/agents/{agentID} Get agent from the organization #
DELETE /organizations/{id}/agents/{agentID} Delete agent in the organization #
PATCH /organizations/{id}/agents/{agentID} Update agent data in the organization #
GET /organizations/{id}/agents/{agentID}/commands [internal] Get commands for this super agent #
GET /organizations/{id}/agents/{agentID}/secret-key Get the secret key for selected agent. #
DELETE /organizations/{id}/agents/{agentID}/secret-key Regenerate the secret key for selected agent. #
GET /organizations/{id}/audit Retrieve a list of application audit logs #
GET /organizations/{id}/audit/export Download an export of application audit logs #
GET /organizations/{id}/audit/filters/subject Returns a list of distinct values for the subject filter. #
GET /organizations/{id}/audit/keymap Retrieve a keymap of application audit log types #
GET /organizations/{id}/boards List board summaries #
POST /organizations/{id}/boards Create a board #
GET /organizations/{id}/boards/{boardID} Get a board #
DELETE /organizations/{id}/boards/{boardID} Delete a board #
PATCH /organizations/{id}/boards/{boardID} Update a board #
PATCH /organizations/{id}/boards/shared-order Reorder shared boards #
GET /organizations/{id}/credentials List credentials used in the organization #
POST /organizations/{id}/credentials Create a new credential in the organization #
GET /organizations/{id}/credentials/{credentialName} Get credential in the organization #
DELETE /organizations/{id}/credentials/{credentialName} Delete credential in the organization #
PATCH /organizations/{id}/credentials/{credentialName} Update value of the credential in the organization #
GET /organizations/{id}/environments List environments #
POST /organizations/{id}/environments Create new environment #
DELETE /organizations/{id}/environments Delete environments #
GET /organizations/{id}/environments/{environmentID} Get environment by ID #
DELETE /organizations/{id}/environments/{environmentID} Delete test environment #
PATCH /organizations/{id}/environments/{environmentID} Update environment #
GET /organizations/{id}/environments/{environmentID}/collaborators Lists all collaborators for this environment #
POST /organizations/{id}/environments/{environmentID}/collaborators Adds many collaborators to this environment #
DELETE /organizations/{id}/environments/{environmentID}/collaborators Remove many collaborators from this environment #
GET /organizations/{id}/environments/{environmentID}/credentials List credentials in the environment #
POST /organizations/{id}/environments/{environmentID}/credentials Create a new credential in the environment #
GET /organizations/{id}/environments/{environmentID}/credentials/{credentialName} Get credential in the environment #
DELETE /organizations/{id}/environments/{environmentID}/credentials/{credentialName} Delete credential in the environment #
PATCH /organizations/{id}/environments/{environmentID}/credentials/{credentialName} Update value of the credential in the environment #
GET /organizations/{id}/environments/{environmentID}/executions Get recent executions #
GET /organizations/{id}/environments/{environmentID}/executions/{executionID}/artifact-archive Get artifact archive #
POST /organizations/{id}/environments/{environmentID}/executions/{executionID}/artifacts Get artifact #
GET /organizations/{id}/environments/{environmentID}/executions/{executionID}/artifacts/{artifactID} Get artifact #
GET /organizations/{id}/environments/{environmentID}/executions/{executionID}/download-artifact/{artifactID} Download artifact #
GET /organizations/{id}/environments/{environmentID}/executions/{executionID}/events Get events that regard this execution. #
GET /organizations/{id}/environments/{environmentID}/executions/{executionID}/junit Get JUnit report for execution #
GET /organizations/{id}/environments/{environmentID}/executions/{executionID}/logs Get Testkube Pro logs for execution #
POST /organizations/{id}/environments/{environmentID}/executions/{executionID}/serve-artifact Serve artifact #
GET /organizations/{id}/environments/{environmentID}/executions/{executionID}/serve-artifact/{artifactID} Serve artifact #
POST /organizations/{id}/environments/{environmentID}/test-workflow-executions/{executionID}/artifacts Get Test Workflow artifact #
GET /organizations/{id}/environments/{environmentID}/test-workflow-executions/{executionID}/artifacts/{artifactID} Get Test Workflow artifact #
GET /organizations/{id}/environments/{environmentID}/test-workflow-executions/{executionID}/download-artifact/{artifactID} Download test workflow artifact #
GET /organizations/{id}/environments/{environmentID}/test-workflow-executions/{executionID}/logs Get Test Workflow logs URL #
POST /organizations/{id}/environments/{environmentID}/test-workflow-executions/{executionID}/serve-artifact Serve artifact #
GET /organizations/{id}/environments/{environmentID}/test-workflow-executions/{executionID}/serve-artifact/{artifactID} Serve Test Workflow artifact #
GET /organizations/{id}/environments/{environmentID}/test-workflow-executions/summaries Get execution summaries in bulk #
DELETE /organizations/{id}/environments/{environmentID}/test-workflows/{testWorkflowName} Delete test workflow #
GET /organizations/{id}/environments/{environmentID}/test-workflows/{testWorkflowName}/credentials List credentials for the test workflow #
POST /organizations/{id}/environments/{environmentID}/test-workflows/{testWorkflowName}/credentials Create a new credential for the test workflow #
GET /organizations/{id}/environments/{environmentID}/test-workflows/{testWorkflowName}/credentials/{credentialName} Get credential for the test workflow #
DELETE /organizations/{id}/environments/{environmentID}/test-workflows/{testWorkflowName}/credentials/{credentialName} Delete credential for the test workflow #
PATCH /organizations/{id}/environments/{environmentID}/test-workflows/{testWorkflowName}/credentials/{credentialName} Update value of the credential for the test workflow #
GET /organizations/{id}/environments/{environmentID}/test-workflows/definitions Get workflow definitions in bulk #
GET /organizations/{id}/environments/{environmentId}/agent/executions Get all test executions #
POST /organizations/{id}/environments/{environmentId}/agent/executions Starts new test executions #
GET /organizations/{id}/environments/{environmentId}/agent/executions/{executionID} Get test execution by ID #
GET /organizations/{id}/environments/{environmentId}/agent/executions/{id}/artifact-archive Download artifact archive #
GET /organizations/{id}/environments/{environmentId}/agent/executions/{id}/artifacts Get execution's artifacts by ID #
GET /organizations/{id}/environments/{environmentId}/agent/executions/{id}/artifacts/{filename} Download artifact #
GET /organizations/{id}/environments/{environmentId}/agent/executions/{id}/logs Get execution's logs by ID #
GET /organizations/{id}/environments/{environmentId}/agent/executions/{id}/logs/v2 Get execution's logs by ID version 2 #
GET /organizations/{id}/environments/{environmentId}/agent/test-workflow-executions List test workflow executions #
POST /organizations/{id}/environments/{environmentId}/agent/test-workflow-executions Execute test workflows #
GET /organizations/{id}/environments/{environmentId}/agent/test-workflow-executions/{executionID} Get test workflow execution #
POST /organizations/{id}/environments/{environmentId}/agent/test-workflow-executions/{executionID}/abort Abort test workflow execution #
GET /organizations/{id}/environments/{environmentId}/agent/test-workflow-executions/{executionID}/artifact-archive Download test workflow artifact archive #
GET /organizations/{id}/environments/{environmentId}/agent/test-workflow-executions/{executionID}/artifacts Get test workflow execution's artifacts by ID #
GET /organizations/{id}/environments/{environmentId}/agent/test-workflow-executions/{executionID}/artifacts/{filename} Download test workflow artifact #
POST /organizations/{id}/environments/{environmentId}/agent/test-workflow-executions/{executionID}/rerun Rerun test workflow execution #
GET /organizations/{id}/environments/{environmentId}/agent/test-workflow-templates List test workflow templates #
PUT /organizations/{id}/environments/{environmentId}/agent/test-workflow-templates Validate test workflow template #
POST /organizations/{id}/environments/{environmentId}/agent/test-workflow-templates Create test workflow template #
DELETE /organizations/{id}/environments/{environmentId}/agent/test-workflow-templates Delete test workflow templates #
GET /organizations/{id}/environments/{environmentId}/agent/test-workflow-templates/{id} Get test workflow template details #
PUT /organizations/{id}/environments/{environmentId}/agent/test-workflow-templates/{id} Update test workflow template details #
DELETE /organizations/{id}/environments/{environmentId}/agent/test-workflow-templates/{id} Delete test workflow template #
GET /organizations/{id}/environments/{environmentId}/agent/test-workflow-with-executions List test workflows with latest execution #
GET /organizations/{id}/environments/{environmentId}/agent/test-workflow-with-executions/{id} Get test workflow details with latest execution #
GET /organizations/{id}/environments/{environmentId}/agent/test-workflow-with-executions/{id}/tags List test workflow execution tags #
GET /organizations/{id}/environments/{environmentId}/agent/test-workflows List test workflows #
PUT /organizations/{id}/environments/{environmentId}/agent/test-workflows Validate test workflow #
POST /organizations/{id}/environments/{environmentId}/agent/test-workflows Create test workflow #
DELETE /organizations/{id}/environments/{environmentId}/agent/test-workflows Delete test workflows #
GET /organizations/{id}/environments/{environmentId}/agent/test-workflows/{id} Get test workflow details #
PUT /organizations/{id}/environments/{environmentId}/agent/test-workflows/{id} Update test workflow details #
DELETE /organizations/{id}/environments/{environmentId}/agent/test-workflows/{id} Delete test workflow #
POST /organizations/{id}/environments/{environmentId}/agent/test-workflows/{id}/abort Abort all test workflow executions #
GET /organizations/{id}/environments/{environmentId}/agent/test-workflows/{id}/executions List test workflow executions #
POST /organizations/{id}/environments/{environmentId}/agent/test-workflows/{id}/executions Execute test workflow #
GET /organizations/{id}/environments/{environmentId}/agent/test-workflows/{id}/executions/{executionID} Get test workflow execution #
POST /organizations/{id}/environments/{environmentId}/agent/test-workflows/{id}/executions/{executionID}/abort Abort test workflow execution #
POST /organizations/{id}/environments/{environmentId}/agent/test-workflows/{id}/executions/{executionID}/rerun Rerun test workflow execution #
GET /organizations/{id}/environments/{environmentId}/agent/test-workflows/{id}/metrics Get test workflow metrics #
GET /organizations/{id}/environments/{environmentId}/agent/test-workflows/{id}/tags List test workflow execution tags #
GET /organizations/{id}/environments/{environmentId}/agent/triggers List test triggers #
POST /organizations/{id}/environments/{environmentId}/agent/triggers Create new test trigger #
DELETE /organizations/{id}/environments/{environmentId}/agent/triggers Delete test triggers #
PATCH /organizations/{id}/environments/{environmentId}/agent/triggers Bulk update test triggers #
GET /organizations/{id}/environments/{environmentId}/agent/triggers/{id} Get test trigger by ID #
DELETE /organizations/{id}/environments/{environmentId}/agent/triggers/{id} Delete test trigger #
PATCH /organizations/{id}/environments/{environmentId}/agent/triggers/{id} Update test trigger #
GET /organizations/{id}/environments/{environmentId}/agent/webhook-templates List webhook templates #
POST /organizations/{id}/environments/{environmentId}/agent/webhook-templates Create new webhook template #
DELETE /organizations/{id}/environments/{environmentId}/agent/webhook-templates Delete webhook templates #
GET /organizations/{id}/environments/{environmentId}/agent/webhook-templates/{id} Get webhook template details #
DELETE /organizations/{id}/environments/{environmentId}/agent/webhook-templates/{id} Delete webhook template #
PATCH /organizations/{id}/environments/{environmentId}/agent/webhook-templates/{id} Update new webhook template #
GET /organizations/{id}/environments/{environmentId}/agent/webhooks List webhooks #
POST /organizations/{id}/environments/{environmentId}/agent/webhooks Create new webhook #
DELETE /organizations/{id}/environments/{environmentId}/agent/webhooks Delete webhooks #
GET /organizations/{id}/environments/{environmentId}/agent/webhooks/{id} Get webhook details #
DELETE /organizations/{id}/environments/{environmentId}/agent/webhooks/{id} Delete webhook #
PATCH /organizations/{id}/environments/{environmentId}/agent/webhooks/{id} Update new webhook #
PUT /organizations/{id}/favorites Create or return a favorite #
DELETE /organizations/{id}/favorites Delete a favorite #
GET /organizations/{id}/groups List organization groups #
POST /organizations/{id}/groups Create a resource group #
GET /organizations/{id}/groups/{groupID} Get a resource group #
DELETE /organizations/{id}/groups/{groupID} Delete a resource group #
PATCH /organizations/{id}/groups/{groupID} Update a resource group #
GET /organizations/{id}/groups/{groupID}/collaborators Lists all collaborators for this resource group #
POST /organizations/{id}/groups/{groupID}/collaborators Adds all collaborators to this resource group #
DELETE /organizations/{id}/groups/{groupID}/collaborators Remove many members from this group #
GET /organizations/{id}/groups/{groupID}/credentials List credentials in the resource group #
POST /organizations/{id}/groups/{groupID}/credentials Create a new credential in the resource group #
GET /organizations/{id}/groups/{groupID}/credentials/{credentialName} Get credential in the resource group #
DELETE /organizations/{id}/groups/{groupID}/credentials/{credentialName} Delete credential in the resource group #
PATCH /organizations/{id}/groups/{groupID}/credentials/{credentialName} Update value of the credential in the resource group #
GET /organizations/{id}/insights/executions Get environment execution duration stats #
GET /organizations/{id}/insights/series Get time series insights #
GET /organizations/{id}/insights/series/catalog List granular insight series catalog #
GET /organizations/{id}/insights/series/catalog/metric-keys List granular insight series metric keys #
GET /organizations/{id}/insights/series/executions Get execution references #
GET /organizations/{id}/insights/stats Get environment execution count stats #
GET /organizations/{id}/insights/workflows Get environment workflow summaries #
GET /organizations/{id}/integrations/github/connect Get GitHub App connect URL #
GET /organizations/{id}/integrations/github/installations List GitHub App installations #
POST /organizations/{id}/integrations/github/installations Add GitHub App installation manually #
DELETE /organizations/{id}/integrations/github/installations/{githubOrg} Remove GitHub App installation #
GET /organizations/{id}/invites List organization invites #
POST /organizations/{id}/invites Invite users to the organization #
GET /organizations/{id}/invites/{inviteID} Get organization invite #
PATCH /organizations/{id}/invites/{inviteID} Updates an organization invite #
POST /organizations/{id}/invites/{inviteID}/resend Resend organization invite #
POST /organizations/{id}/invites/{inviteID}/revoke Revoke organization invite #
GET /organizations/{id}/members Get organization members #
DELETE /organizations/{id}/members/{memberEmail} Remove user from organization #
PATCH /organizations/{id}/members/{memberEmail} Update org member role #
GET /organizations/{id}/members/{memberEmail}/permissions Get member permissions #
GET /organizations/{id}/teams List organization teams #
POST /organizations/{id}/teams Create a team #
GET /organizations/{id}/teams/{teamID} Get a team #
DELETE /organizations/{id}/teams/{teamID} Delete a team #
PATCH /organizations/{id}/teams/{teamID} Update a team #
GET /organizations/{id}/teams/{teamID}/members Lists all members for this team #
POST /organizations/{id}/teams/{teamID}/members Adds members to this team #
DELETE /organizations/{id}/teams/{teamID}/members Remove many members from this team #
GET /organizations/{id}/tokens List API Tokens #
POST /organizations/{id}/tokens Create API Token #
GET /organizations/{id}/tokens/{tokenID} Get API Token #
DELETE /organizations/{id}/tokens/{tokenID} Delete API Token #
GET /organizations/invites/{inviteID}/accept Accept email invite #

Documentation

📖
Documentation
https://docs.testkube.io/openapi/overview
📖
Documentation
https://docs.testkube.io/openapi/agent/default--test-workflows

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/kubeshop/refs/heads/main/openapi/kubeshop-organizations-api-openapi.yml

Other Resources

🔗
SourceCode
https://github.com/kubeshop/testkube

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/kubeshop-organizations-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

kubeshop-organizations-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Testkube Control Plane Organizations API
  description: API for Testkube Control Plane
  contact:
    email: info@testkube.io
  version: 1.0.0
servers:
- url: https://api.testkube.io
  description: Testkube Cloud Control Plane API Endpoint
- url: https://<your-testkube-api-host>
  description: Testkube On-Prem API Endpoint
tags:
- name: Organizations
paths:
  /organizations:
    get:
      summary: List organizations
      description: List organizations
      operationId: listOrganizations
      parameters:
      - $ref: '#/components/parameters/Limit'
      responses:
        '200':
          $ref: '#/components/responses/Organizations'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
      security:
      - BearerAuth: []
      tags:
      - Organizations
    post:
      summary: Create new organization
      description: Create organization
      operationId: createOrganization
      requestBody:
        $ref: '#/components/requestBodies/Organization'
      responses:
        '200':
          $ref: '#/components/responses/Organization'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '429':
          $ref: '#/components/responses/TooManyRequests'
      security:
      - BearerAuth: []
      tags:
      - Organizations
  /organizations/{id}:
    parameters:
    - $ref: '#/components/parameters/ID'
    get:
      summary: Get organization by ID
      description: Get organization by ID
      operationId: getOrganization
      responses:
        '200':
          description: get organization response body
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Organization'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '404':
          $ref: '#/components/responses/NotFoundError'
      security:
      - BearerAuth: []
      tags:
      - Organizations
    delete:
      summary: Delete organization
      description: Deletes organization
      operationId: deleteOrganization
      responses:
        '204':
          $ref: '#/components/responses/NoContent'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
      security:
      - BearerAuth: []
      tags:
      - Organizations
    patch:
      summary: Update organization
      description: Update organization with given request body
      operationId: updateOrganization
      requestBody:
        $ref: '#/components/requestBodies/Organization'
      responses:
        '200':
          $ref: '#/components/responses/Organization'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
      security:
      - BearerAuth: []
      tags:
      - Organizations
  /organizations/{id}/agents:
    parameters:
    - $ref: '#/components/parameters/ID'
    - $ref: '#/components/parameters/EnvironmentIDQP'
    - $ref: '#/components/parameters/AgentCapabilityQP'
    - $ref: '#/components/parameters/Limit'
    - $ref: '#/components/parameters/Offset'
    - $ref: '#/components/parameters/Page'
    - $ref: '#/components/parameters/PageSize'
    - $ref: '#/components/parameters/IncludeDeleted'
    get:
      summary: List agents used in the organization
      description: List agents used in the organization.
      operationId: listAgents
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  elements:
                    type: array
                    items:
                      $ref: '#/components/schemas/Agent'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
      security:
      - BearerAuth: []
      tags:
      - Organizations
    post:
      summary: Create a new agent in the organization
      description: Create a new agent in the organization.
      operationId: createAgent
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  maxLength: 40
                  pattern: ^[a-z0-9]([a-z0-9-.]*[a-z0-9])?$
                labels:
                  type: object
                  additionalProperties:
                    type: string
                environments:
                  description: Environment IDs where the agent is restricted to.
                  type: array
                  items:
                    type: string
                capabilities:
                  description: Capabilities enabled for this agent.
                  type: array
                  items:
                    $ref: '#/components/schemas/AgentCapability'
                runnerPolicy:
                  $ref: '#/components/schemas/AgentRunnerPolicy'
                floating:
                  type: boolean
              required:
              - name
              - environments
        required: true
      responses:
        '201':
          description: Response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Agent'
                - type: object
                  properties:
                    secretKey:
                      type: string
                  required:
                  - secretKey
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
      security:
      - BearerAuth: []
      tags:
      - Organizations
  /organizations/{id}/agents/{agentID}:
    parameters:
    - $ref: '#/components/parameters/ID'
    - $ref: '#/components/parameters/AgentName'
    - $ref: '#/components/parameters/IncludeDeleted'
    get:
      summary: Get agent from the organization
      description: Get agent from the organization.
      operationId: getAgent
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Agent'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
      security:
      - BearerAuth: []
      tags:
      - Organizations
    delete:
      summary: Delete agent in the organization
      description: Delete agent in the organization.
      operationId: deleteAgent
      responses:
        '204':
          $ref: '#/components/responses/NoContent'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
      security:
      - BearerAuth: []
      tags:
      - Organizations
    patch:
      summary: Update agent data in the organization
      description: Update agent data in the organization.
      operationId: updateAgent
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                runnerPolicy:
                  type: object
                  properties:
                    requiredMatch:
                      type: array
                      items:
                        type: string
                labels:
                  type: object
                  additionalProperties:
                    type: string
                disabled:
                  type: boolean
                environments:
                  description: Environment IDs where the agent is restricted to.
                  type: array
                  items:
                    type: string
        required: true
      responses:
        '204':
          $ref: '#/components/responses/NoContent'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
      security:
      - BearerAuth: []
      tags:
      - Organizations
  /organizations/{id}/agents/{agentID}/commands:
    parameters:
    - $ref: '#/components/parameters/ID'
    - $ref: '#/components/parameters/AgentName'
    get:
      summary: '[internal] Get commands for this super agent'
      description: Get commands for this super agent. This endpoint is deprecated and will be removed in the near future.
      operationId: getSuperAgentCommands
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuperAgentCommands'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
      security:
      - BearerAuth: []
      tags:
      - Organizations
  /organizations/{id}/agents/{agentID}/secret-key:
    parameters:
    - $ref: '#/components/parameters/ID'
    - $ref: '#/components/parameters/AgentName'
    get:
      summary: Get the secret key for selected agent.
      description: Get the secret key for selected agent.
      operationId: getAgentSecretKey
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  secretKey:
                    type: string
                required:
                - secretKey
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
      security:
      - BearerAuth: []
      tags:
      - Organizations
    delete:
      summary: Regenerate the secret key for selected agent.
      description: Regenerate the secret key for selected agent.
      operationId: regenerateAgentSecretKey
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  secretKey:
                    type: string
                required:
                - secretKey
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
      security:
      - BearerAuth: []
      tags:
      - Organizations
  /organizations/{id}/audit:
    get:
      summary: Retrieve a list of application audit logs
      description: 'Fetch a paginated list of audit logs detailing actions performed on application resources.

        This includes actions such as resource creation, updates, and deletions, along with metadata

        about the entities involved and the context in which the actions occurred.


        The logs provide visibility into operations for auditing and compliance purposes,

        and may be filtered or limited by the parameters provided.

        '
      operationId: listApplicationAuditLogs
      parameters:
      - $ref: '#/components/parameters/ID'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/EnvironmentIDQP'
      - $ref: '#/components/parameters/StartDateTime'
      - $ref: '#/components/parameters/EndDateTime'
      - $ref: '#/components/parameters/Subject'
      - $ref: '#/components/parameters/EventType'
      - $ref: '#/components/parameters/Page'
      - $ref: '#/components/parameters/PageSize'
      responses:
        '200':
          $ref: '#/components/responses/PaginatedApplicationAuditLog'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
      security:
      - BearerAuth: []
      tags:
      - Organizations
  /organizations/{id}/audit/export:
    get:
      summary: Download an export of application audit logs
      description: 'Download an export of application audit logs in a structured format, such as CSV or JSON,

        for the specified organization. The export includes detailed information about actions

        performed on application resources, including the entities involved, the context in which

        the actions occurred, and metadata about the operations.


        The export provides a comprehensive record of operations for auditing and compliance purposes,

        and can be used to analyze and visualize the history of changes to application resources.

        '
      operationId: exportApplicationAuditLog
      parameters:
      - $ref: '#/components/parameters/ID'
      - $ref: '#/components/parameters/EnvironmentIDQP'
      - $ref: '#/components/parameters/StartDateTime'
      - $ref: '#/components/parameters/EndDateTime'
      - $ref: '#/components/parameters/Subject'
      - $ref: '#/components/parameters/EventType'
      - $ref: '#/components/parameters/ExportFormat'
      responses:
        '200':
          $ref: '#/components/responses/ExportedApplicationAuditLog'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
      security:
      - BearerAuth: []
      tags:
      - Organizations
  /organizations/{id}/audit/filters/subject:
    get:
      summary: Returns a list of distinct values for the subject filter.
      description: 'Returns a list of distinct values for the subject filter based on the provided query parameters.

        The subject filter is used to filter audit logs based on the entity that performed the action,

        such as a user, API token... This endpoint provides a list of distinct

        subjects that can be used to filter audit logs by the entity that performed the action.

        '
      operationId: getAuditLogSubjectFilterValues
      parameters:
      - $ref: '#/components/parameters/ID'
      - $ref: '#/components/parameters/EnvironmentIDQP'
      - $ref: '#/components/parameters/StartDateTime'
      - $ref: '#/components/parameters/EndDateTime'
      - $ref: '#/components/parameters/EventType'
      responses:
        '200':
          $ref: '#/components/responses/AuditLogSubjectFilterValues'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
      security:
      - BearerAuth: []
      tags:
      - Organizations
  /organizations/{id}/audit/keymap:
    get:
      summary: Retrieve a keymap of application audit log types
      description: 'Retrieve a keymap that provides mappings of various audit log attributes, such as event types,

        actions, entity types, and sources, for the specified organization.


        This keymap helps interpret the structure and meaning of audit logs by mapping internal identifiers

        to their corresponding human-readable descriptions. It can be used to facilitate the analysis and

        display of audit logs by providing context for different events, actions, and entities involved in the

        logged operations.

        '
      operationId: getApplicationAuditLogKeymap
      parameters:
      - $ref: '#/components/parameters/ID'
      responses:
        '200':
          $ref: '#/components/responses/ApplicationAuditLogKeymap'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
      security:
      - BearerAuth: []
      tags:
      - Organizations
  /organizations/{id}/boards:
    parameters:
    - $ref: '#/components/parameters/ID'
    get:
      summary: List board summaries
      description: Lists the summaries of the boards in your organization.
      operationId: listBoards
      parameters:
      - name: name
        in: query
        description: Filter boards by name (case-insensitive substring match)
        schema:
          type: string
      - name: private
        in: query
        description: Return only private boards owned by the current user.
        schema:
          type: boolean
      - name: shared
        in: query
        description: Return only shared organization boards.
        schema:
          type: boolean
      - name: userFavorite
        in: query
        description: Return only boards favorited by the current user.
        schema:
          type: boolean
      - name: orgFavorite
        in: query
        description: Return only boards favorited at the organization level.
        schema:
          type: boolean
      - $ref: '#/components/parameters/Page'
      - $ref: '#/components/parameters/PageSize'
      responses:
        '200':
          description: Response
          headers:
            Link:
              $ref: '#/components/headers/link'
            Total-Count:
              $ref: '#/components/headers/total-count'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/BoardSummary'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
      security:
      - BearerAuth: []
      tags:
      - Organizations
    post:
      summary: Create a board
      description: Creates a board.
      operationId: createBoard
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  description: The display name of the new board
                  type: string
                slug:
                  description: The slug of the new board
                  type: string
                description:
                  description: The description of the new board
                  type: string
                isPrivate:
                  description: When true, the board is only visible to the creator.
                  type: boolean
                  default: false
              required:
              - name
        required: true
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Board'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
      security:
      - BearerAuth: []
      tags:
      - Organizations
  /organizations/{id}/boards/{boardID}:
    parameters:
    - $ref: '#/components/parameters/ID'
    - $ref: '#/components/parameters/BoardID'
    get:
      summary: Get a board
      description: Get a board by its `id` or `slug`.
      operationId: getBoard
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Board'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '404':
          $ref: '#/components/responses/NotFoundError'
      security:
      - BearerAuth: []
      tags:
      - Organizations
    delete:
      summary: Delete a board
      description: Deletes a board.
      operationId: deleteBoard
      responses:
        '204':
          description: Delete Success
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
      security:
      - BearerAuth: []
      tags:
      - Organizations
    patch:
      summary: Update a board
      description: Updates a board's details, content or layout.
      operationId: updateBoard
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  description: The new display name of this board.
                  type: string
                description:
                  description: The new description of this board.
                  type: string
                slug:
                  description: The new slug of this board.
                  type: string
                isPrivate:
                  description: When set, toggles whether the board is private to the current user or shared with the organization.
                  type: boolean
                layout: {}
                content:
                  description: A patch for the content of this board.
                  type: object
                  properties:
                    action:
                      type: string
                      enum:
                      - create
                      - update
                      - delete
                    content_kind:
                      type: string
                    content_id:
                      type: string
                    content_data: {}
                  required:
                  - action
                  - content_kind
        required: true
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Board'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
      security:
      - BearerAuth: []
      tags:
      - Organizations
  /organizations/{id}/boards/shared-order:
    parameters:
    - $ref: '#/components/parameters/ID'
    patch:
      summary: Reorder shared boards
      description: Sets the sidebar navigation order for shared organization boards. Requires organization admin.
      operationId: reorderSharedBoards
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReorderSharedBoardsReq'
        required: true
      responses:
        '204':
          $ref: '#/components/responses/NoContent'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
      security:
      - BearerAuth: []
      tags:
      - Organizations
  /organizations/{id}/credentials:
    parameters:
    - $ref: '#/components/parameters/ID'
    - $ref: '#/components/parameters/EnvironmentIDQP'
    get:
      summary: List credentials used in the organization
      description: List credentials used in the organization.
      operationId: listCredentials
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  elements:
                    type: array
                    items:
                      $ref: '#/components/schemas/Credential'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
      security:
      - BearerAuth: []
      tags:
      - Organizations
    post:
      summary: Create a new credential in the organization
      description: Create a new credential in the organization.
      operationId: createCredential
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  description: The identifier for the credential.
                  type: string
                type:
                  description: The type of credential (secret, variable, vault, or vault_ref). Defaults to secret if not specified.
                  type: string
                  enum:
                  - secret
                  - variable
                  - vault
                  - vault_ref
                base64:
                  description: Base64-encoded value for the credential.
                  type: string
                environmentId:
                  description: Environment ID where the credential is restricted to.
                  type: string
                workflowName:
                  description: Workflow Name where the credential is restricted to.
                  type: string
                source:
                  description: The source that created this credential (e.g. 'ai-agent').
                  type: string
                  maxLength: 50
              required:
              - name
        required: true
      responses:
        '201':
          description: Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Credential'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '409':
          $ref: '#/components/responses/Conflict'
      security:
      - BearerAuth: []
      tags:
      - Organizations
  /organizations/{id}/credentials/{credentialName}:
    parameters:
    - $ref: '#/components/parameters/ID'
    - $ref: '#/components/parameters/CredentialName'
    get:
      summary: Get credential in the organization
      description: Get credential details. Variables will include their decrypted value, secrets will not.
      operationId: getCredential
      responses:
        '200':
          $ref: '#/components/responses/Credential'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
      security:
      - BearerAuth: []
      tags:
      - Organizations
    delete:
      summary: Delete credential in the organization
      description: Delete credential in the organization.
      operationId: deleteCredential
      responses:
        '204':
          $ref: '#/components/responses/NoContent'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
      security:
      - BearerAuth: []
      tags:
      - Organizations
    patch:
      summary: Update value of the credential in the organization
      description: Update value of the credential in the organization.
      operationId: updateCredential
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                base64:
                  description: Base64-encoded value for the credential.
                  type: string
              required:
              - base64
        required: true
      responses:
        '204':
          $ref: '#/components/responses/NoContent'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
      security:
      - BearerAuth: []
      tags:
      - Organizations
  /organizations/{id}/environments:
    parameters:
    - $ref: '#/components/parameters/ID'
    get:
      summary: List environments
      description: List environments from the active organization
      operationId: listEnvironments
      parameters:
      - $ref: '#/components/parameters/Limit'
      responses:
        '200':
          $ref: '#/components/responses/Environments'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
      security:
      - BearerAuth: []
      tags:
      - Organizations
    post:
      summary: Create new environment
      description: Create test environment
      operationId: createEnvironment
      requestBody:
        $ref: '#/components/requestBodies/Environment'
      responses:
        '200':
          $ref: '#/components/responses/Environment'
        '400':
          $ref: '#/components/responses/BadRequestError'
      security:
      - BearerAuth: []
      tags:
      - Organizations
    delete:
      summary: Delete environments
      description: Deletes all or labeled environments
      operationId: deleteEnvironments
      parameters:
      - $ref: '#/components/parameters/Name'
      responses:
        '204':
          $ref: '#/components/responses/NoContent'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
      security:
      - BearerAuth: []
      tags:
      - Organizations
  /organizations/{id}/environments/{environmentID}:
    parameters:
    - $ref: '#/components/parameters/ID'
    - $ref: '#/components/parameters/EnvironmentID'
    get:
      summary: Get environment by ID
      description: Get test environment by ID from CRD in kubernetes cluster
      operationId: getEnvironment
      responses:
        '200':
          $ref: '#/components/responses/Environment'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
      security:
      - BearerAuth: []
      tags:
      - Organizations
    delete:
      summary: Delete test environment
      description: Deletes a test environment
      operationId: deleteEnvironment
      responses:
        '204':
          $ref: '#/components/responses/NoContent'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
      security:
      - BearerAuth: []
      tags:
      - Organizations
    patch:
      summary: Update environment
      description: Update environment with given request body
      operationId: updateEnvironment
      requestBody:
        $ref: '#/components/requestBodies/Environment'
      responses:
        '200':
          $ref: '#/components/responses/Environment'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
      security:
      - BearerAuth: []
      tags:
      - Organizations
  /organizations/{id}/environments/{environmentID}/collaborators:
    parameters:
    - $ref: '#/components/parameters/ID'
    - $ref: '#/components/parameters/EnvironmentID'
    get:
      summary: Lists all collaborators for this environment
      description: Lists all collaborators for this environment.
      operationId: listEnvironmentCollaborators
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Collaborator'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
      security:
      - BearerAuth: []
      tags:
      - Org

# --- truncated at 32 KB (426 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/kubeshop/refs/heads/main/openapi/kubeshop-organizations-api-openapi.yml