Signadot

Signadot Cluster API

The Cluster API from Signadot — 5 operation(s) for cluster.

GitHub OpenAPI
Business capability
Environment Management BC-4210.20

Operations 8

GET /orgs/{orgName}/clusters/ List clusters #
DELETE /orgs/{orgName}/clusters/{clusterName}/ Remove a cluster #
GET /orgs/{orgName}/clusters/{clusterName}/ Get a cluster #
PUT /orgs/{orgName}/clusters/{clusterName}/ Add a cluster #
POST /orgs/{orgName}/clusters/{clusterName}/tokens Create cluster token #
GET /orgs/{orgName}/clusters/{clusterName}/tokens/ List cluster tokens #
DELETE /orgs/{orgName}/clusters/{clusterName}/tokens/{tokenId} Delete cluster token #
GET /orgs/{orgName}/clusters/{clusterName}/tokens/{tokenId} Get a cluster token #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/signadot/openapi/signadot-cluster-api-openapi.yml

Other Resources

🔗
ErrorCatalog
https://artifacts.apis.io/signadot/errors/signadot-error-codes.yml
🔗
DataModel
https://artifacts.apis.io/signadot/data-model/signadot-data-model.yml
🔗
Conventions
https://artifacts.apis.io/signadot/conventions/signadot-conventions.yml
🔗
APIsJSON
https://artifacts.apis.io/signadot/apis.yml
🔗
Arazzo
https://artifacts.apis.io/signadot/arazzo/_index.yml
🔗
Arazzo
https://artifacts.apis.io/signadot/arazzo/signadot-create-and-inspect-sandbox.yml

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/signadot:signadot-cluster-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

signadot-cluster-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  contact: {}
  description: API for Signadot Sandboxes
  title: Signadot Cluster API
  version: '2.0'
servers:
- url: https://api.signadot.com/api/v2
tags:
- name: Cluster
paths:
  /orgs/{orgName}/clusters/:
    get:
      description: List clusters.
      operationId: list-clusters
      parameters:
      - description: Signadot Org Name
        in: path
        name: orgName
        required: true
        x-example: my-company
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/Cluster'
                type: array
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '502':
          description: Bad Gateway
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - ApiKeyAuth: []
      summary: List clusters
      tags:
      - Cluster
  /orgs/{orgName}/clusters/{clusterName}/:
    delete:
      description: Remove a Kubernetes cluster from Signadot.
      operationId: remove-cluster
      parameters:
      - description: Signadot Org Name
        in: path
        name: orgName
        required: true
        x-example: my-company
        schema:
          type: string
      - description: Cluster Name
        in: path
        name: clusterName
        required: true
        x-example: my-cluster
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '502':
          description: Bad Gateway
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - ApiKeyAuth: []
      summary: Remove a cluster
      tags:
      - Cluster
    get:
      description: Get a cluster.
      operationId: get-cluster
      parameters:
      - description: Signadot Org Name
        in: path
        name: orgName
        required: true
        x-example: my-company
        schema:
          type: string
      - description: Cluster Name
        in: path
        name: clusterName
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Cluster'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '502':
          description: Bad Gateway
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - ApiKeyAuth: []
      summary: Get a cluster
      tags:
      - Cluster
    put:
      description: Add a Kubernetes cluster to Signadot.
      operationId: add-cluster
      parameters:
      - description: Signadot Org Name
        in: path
        name: orgName
        required: true
        x-example: my-company
        schema:
          type: string
      - description: Cluster Name
        in: path
        name: clusterName
        required: true
        x-example: my-cluster
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Cluster'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '502':
          description: Bad Gateway
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - ApiKeyAuth: []
      summary: Add a cluster
      tags:
      - Cluster
  /orgs/{orgName}/clusters/{clusterName}/tokens:
    post:
      description: Create a new token for connecting a cluster.
      operationId: create-cluster-token
      parameters:
      - description: Signadot Org Name
        in: path
        name: orgName
        required: true
        x-example: my-company
        schema:
          type: string
      - description: Cluster Name
        in: path
        name: clusterName
        required: true
        x-example: my-new-cluster
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClusterToken'
      security:
      - ApiKeyAuth: []
      summary: Create cluster token
      tags:
      - Cluster
  /orgs/{orgName}/clusters/{clusterName}/tokens/:
    get:
      description: List the cluster tokens associated with a cluster.
      operationId: list-cluster-tokens
      parameters:
      - description: Signadot Org Name
        in: path
        name: orgName
        required: true
        x-example: my-company
        schema:
          type: string
      - description: Cluster Name
        in: path
        name: clusterName
        required: true
        x-example: my-new-cluster
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ClusterToken'
                type: array
      security:
      - ApiKeyAuth: []
      summary: List cluster tokens
      tags:
      - Cluster
  /orgs/{orgName}/clusters/{clusterName}/tokens/{tokenId}:
    delete:
      description: Delete a cluster token associated with a cluster.
      operationId: delete-cluster-token
      parameters:
      - description: Signadot Org Name
        in: path
        name: orgName
        required: true
        x-example: my-company
        schema:
          type: string
      - description: Cluster Name
        in: path
        name: clusterName
        required: true
        x-example: my-new-cluster
        schema:
          type: string
      - description: Token Id
        in: path
        name: tokenId
        required: true
        x-example: kq6mtksk7mn5
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
      security:
      - ApiKeyAuth: []
      summary: Delete cluster token
      tags:
      - Cluster
    get:
      description: Get a cluster token associated with a cluster.
      operationId: get-cluster-token
      parameters:
      - description: Signadot Org Name
        in: path
        name: orgName
        required: true
        x-example: my-company
        schema:
          type: string
      - description: Cluster Name
        in: path
        name: clusterName
        required: true
        x-example: my-new-cluster
        schema:
          type: string
      - description: Token Id
        in: path
        name: tokenId
        required: true
        x-example: kq6mtksk7mn5
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClusterToken'
      security:
      - ApiKeyAuth: []
      summary: Get a cluster token
      tags:
      - Cluster
components:
  schemas:
    ErrorResponse:
      properties:
        code:
          type: integer
        error:
          type: string
        requestId:
          type: string
      type: object
    config.LinkerdConfig:
      properties:
        enabled:
          type: boolean
        operator:
          $ref: '#/components/schemas/config.LinkerdSignadotOperator'
      type: object
    config.GatewayAPIConfig:
      properties:
        enabled:
          type: boolean
        preservedAnnotations:
          items:
            type: string
          type: array
        preservedLabels:
          items:
            type: string
          type: array
      type: object
    config.TrafficCaptureConfig:
      properties:
        enabled:
          type: boolean
        requestHeadersElide:
          items:
            type: string
          type: array
        responseHeadersElide:
          items:
            type: string
          type: array
      type: object
    cluster.Operator:
      properties:
        version:
          description: 'The operator version of the cluster.  This may be

            nil if the cluster has not yet connected to Signadot.'
          type: string
      type: object
    config.DefaultHeaderClass:
      enum:
      - baggage
      - tracestate
      type: string
      x-enum-varnames:
      - DefaultHeaderBaggage
      - DefaultHeaderTraceState
    config.RoutingConfig:
      properties:
        customHeaders:
          items:
            type: string
          type: array
        defaultHeaders:
          items:
            $ref: '#/components/schemas/config.DefaultHeaderClass'
          type: array
        gatewayAPI:
          $ref: '#/components/schemas/config.GatewayAPIConfig'
        iptablesMode:
          type: string
        istio:
          $ref: '#/components/schemas/config.IstioConfig'
        linkerd:
          $ref: '#/components/schemas/config.LinkerdConfig'
        queryParamRouting:
          $ref: '#/components/schemas/config.QueryParamRoutingConfig'
      type: object
    ClusterToken:
      properties:
        createdAt:
          description: The time when this cluster was registered with Signadot.
          type: string
        id:
          description: The ID of this token
          type: string
        maskedValue:
          description: A Masked token value.
          type: string
        status:
          allOf:
          - $ref: '#/components/schemas/ClusterTokenStatus'
          description: Token status.
        token:
          description: The token value.
          type: string
      type: object
    config.SandboxTrafficManagerConfig:
      properties:
        enabled:
          type: boolean
      type: object
    Cluster:
      properties:
        clusterConfig:
          allOf:
          - $ref: '#/components/schemas/config.ClusterConfig'
          description: Cluster config read from the cluster
        createdAt:
          description: The time when this cluster was registered with Signadot.
          type: string
        name:
          description: The name of the cluster.
          type: string
        operator:
          allOf:
          - $ref: '#/components/schemas/cluster.Operator'
          description: Information about the Signadot Operator in this cluster.
      type: object
    config.LinkerdSignadotOperator:
      properties:
        podAnnotations:
          additionalProperties:
            type: string
          type: object
      type: object
    config.IstioConfig:
      properties:
        enableHostRouting:
          description: Deprecated fields
          type: boolean
        enabled:
          type: boolean
        operator:
          $ref: '#/components/schemas/config.IstioSignadotOperator'
      type: object
    config.ClusterConfig:
      properties:
        allowOrphanedResources:
          type: boolean
        allowedNamespaces:
          items:
            type: string
          type: array
        controlPlane:
          $ref: '#/components/schemas/config.ControlPlaneConfig'
        routing:
          $ref: '#/components/schemas/config.RoutingConfig'
        sandboxTrafficManager:
          allOf:
          - $ref: '#/components/schemas/config.SandboxTrafficManagerConfig'
          description: Deprecated field
        trafficCapture:
          $ref: '#/components/schemas/config.TrafficCaptureConfig'
        trafficManager:
          $ref: '#/components/schemas/config.TrafficManagerConfig'
      type: object
    EmptyResponse:
      type: object
    ClusterTokenStatus:
      properties:
        lastConnectedAt:
          description: The last time at which this token was used to connect.
          type: string
        lastConnectedIp:
          description: The last IP address from which this token connected.
          type: string
      type: object
    config.TrafficManagerConfig:
      properties:
        enabled:
          type: boolean
      type: object
    config.IstioSignadotOperator:
      properties:
        podLabels:
          additionalProperties:
            type: string
          type: object
      type: object
    config.ControlPlaneConfig:
      properties:
        disabled:
          description: control plane can be disabled
          type: boolean
        proxy:
          description: control plane proxy can be "enabled" or "disabled"
          type: string
        tunnelAddr:
          type: string
        tunnelTLS:
          type: boolean
      type: object
    config.QueryParamRoutingConfig:
      properties:
        enabled:
          type: boolean
        paramName:
          type: string
      type: object
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: signadot-api-key
      type: apiKey