Skip to main content
API docs by Redocly

Signadot API (2.0)

Download OpenAPI specification:Download

API for Signadot Sandboxes

Cluster

List clusters

List clusters.

Authorizations:
ApiKeyAuth
path Parameters
orgName
required
string
Example: my-company

Signadot Org Name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Remove a cluster

Remove a Kubernetes cluster from Signadot.

Authorizations:
ApiKeyAuth
path Parameters
orgName
required
string
Example: my-company

Signadot Org Name

clusterName
required
string
Example: my-cluster

Cluster Name

Responses

Response samples

Content type
application/json
{ }

Get a cluster

Get a cluster.

Authorizations:
ApiKeyAuth
path Parameters
orgName
required
string
Example: my-company

Signadot Org Name

clusterName
required
string

Cluster Name

Responses

Response samples

Content type
application/json
{
  • "clusterConfig": {
    },
  • "createdAt": "string",
  • "name": "string",
  • "operator": {
    }
}

Add a cluster

Add a Kubernetes cluster to Signadot.

Authorizations:
ApiKeyAuth
path Parameters
orgName
required
string
Example: my-company

Signadot Org Name

clusterName
required
string
Example: my-cluster

Cluster Name

Responses

Response samples

Content type
application/json
{
  • "clusterConfig": {
    },
  • "createdAt": "string",
  • "name": "string",
  • "operator": {
    }
}

Create cluster token

Create a new token for connecting a cluster.

Authorizations:
ApiKeyAuth
path Parameters
orgName
required
string
Example: my-company

Signadot Org Name

clusterName
required
string
Example: my-new-cluster

Cluster Name

Responses

Response samples

Content type
application/json
{
  • "createdAt": "string",
  • "id": "string",
  • "maskedValue": "string",
  • "status": {
    },
  • "token": "string"
}

List cluster tokens

List the cluster tokens associated with a cluster.

Authorizations:
ApiKeyAuth
path Parameters
orgName
required
string
Example: my-company

Signadot Org Name

clusterName
required
string
Example: my-new-cluster

Cluster Name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete cluster token

Delete a cluster token associated with a cluster.

Authorizations:
ApiKeyAuth
path Parameters
orgName
required
string
Example: my-company

Signadot Org Name

clusterName
required
string
Example: my-new-cluster

Cluster Name

tokenId
required
string
Example: kq6mtksk7mn5

Token Id

Responses

Response samples

Content type
application/json
{ }

Get a cluster token

Get a cluster token associated with a cluster.

Authorizations:
ApiKeyAuth
path Parameters
orgName
required
string
Example: my-company

Signadot Org Name

clusterName
required
string
Example: my-new-cluster

Cluster Name

tokenId
required
string
Example: kq6mtksk7mn5

Token Id

Responses

Response samples

Content type
application/json
{
  • "createdAt": "string",
  • "id": "string",
  • "maskedValue": "string",
  • "status": {
    },
  • "token": "string"
}

Orgs

Get Org Name

Get organization details

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "clusterID": "string",
  • "featureFlags": {
    },
  • "orgs": [
    ],
  • "user": {
    },
  • "userFlags": {
    }
}

ResourcePlugins

List resource plugins

List resource plugins under the specified Signadot org. By default returns only the highest-semver version of each plugin. Pass ?version=all to expand the response into one row per published (name, version), sorted by name then semver-descending. ?version=latest is accepted as an explicit alias for the default.

Authorizations:
ApiKeyAuth
path Parameters
orgName
required
string
Example: my-company

Signadot Org Name

query Parameters
version
string
Enum: "latest" "all"

'latest' (default) returns only the highest-semver version of each plugin; 'all' returns every published version

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete a resource plugin

Delete a resource plugin version. Omit the version query parameter to delete the latest version. Deletion is blocked when any sandbox references the specific version being deleted.

Authorizations:
ApiKeyAuth
path Parameters
orgName
required
string
Example: my-company

Signadot Org Name

pluginName
required
string
Example: mariadb-plugin

Resource plugin name

query Parameters
version
string
Example: version=1.2.0

Resource plugin version (semver); omit for latest

Responses

Response samples

Content type
application/json
{ }

Get the requested resource plugin

Get the specified resource plugin. Omit the version query parameter to get the latest version.

Authorizations:
ApiKeyAuth
path Parameters
orgName
required
string
Example: my-company

Signadot Org Name

pluginName
required
string
Example: mariadb-plugin

Resource plugin name

query Parameters
version
string
Example: version=1.2.0

Resource plugin version (semver); omit for latest

Responses

Response samples

Content type
application/json
{
  • "createdAt": "string",
  • "name": "my-plugin@1.2.0",
  • "spec": {
    },
  • "status": {
    },
  • "updatedAt": "string"
}

Apply a resource plugin

Creates a new version of a resource plugin. The body's name field carries the wire form bareName[@semver] (e.g. my-plugin@1.2.0); its bare part must match the URL path name. A bare-name form (no @) publishes the default version 0.0.0. Versions are immutable; PUTting an existing (name, version) pair returns 409. The version suffix must be a concrete semver; "latest" is only accepted on the read and delete query parameters.

Authorizations:
ApiKeyAuth
path Parameters
orgName
required
string
Example: my-company

Signadot Org Name

pluginName
required
string
Example: mariadb-plugin

Resource plugin name

Request Body schema: application/json
required

Request to create a resource plugin version

createdAt
string

The time at which the resource plugin was created

name
string

Plugin identity of the form bareName[@semver]. The bare-name form (no @) means the default version (0.0.0); responses for plugins at the default version use this bare form for backward compatibility with pre-versioning clients.

object

Specification for the resource plugin

object

Status of the resource plugin

updatedAt
string

The time at which the resource plugin was last updated

Responses

Request samples

Content type
application/json
{
  • "createdAt": "string",
  • "name": "my-plugin@1.2.0",
  • "spec": {
    },
  • "status": {
    },
  • "updatedAt": "string"
}

Response samples

Content type
application/json
{ }

RouteGroups

List routegroups

List all routegroups under the specified Signadot org.

Authorizations:
ApiKeyAuth
path Parameters
orgName
required
string
Example: my-company

Signadot Org Name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete a routegroup

Delete a given routegroup.

Authorizations:
ApiKeyAuth
path Parameters
orgName
required
string
Example: my-company

Signadot Org Name

routegroupName
required
string
Example: my-routegroup

RouteGroup Name

Responses

Response samples

Content type
application/json
{ }

Get a routegroup

Fetch the details about a given routegroup.

Authorizations:
ApiKeyAuth
path Parameters
orgName
required
string
Example: my-company

Signadot Org Name

routegroupName
required
string
Example: my-routegroup

RouteGroup Name

Responses

Response samples

Content type
application/json
{
  • "createdAt": "string",
  • "defaults": {
    },
  • "endpoints": [
    ],
  • "name": "string",
  • "routingKey": "string",
  • "spec": {
    },
  • "status": {
    },
  • "updatedAt": "string"
}

Create or update a routegroup

Creates or updates a routegroup with the provided parameters.

Authorizations:
ApiKeyAuth
path Parameters
orgName
required
string
Example: my-company

Signadot Org Name

routegroupName
required
string
Example: my-routegroup

RouteGroup Name

Request Body schema: application/json
required

Request to create or update routegroup

createdAt
string
object (defaults.CompositeDefaults)
Array of objects (routegroups.EndpointURL)
name
string
routingKey
string
object (routeGroup.Spec)
object (routeGroup.Status)
updatedAt
string

Responses

Request samples

Content type
application/json
{
  • "createdAt": "string",
  • "defaults": {
    },
  • "endpoints": [
    ],
  • "name": "string",
  • "routingKey": "string",
  • "spec": {
    },
  • "status": {
    },
  • "updatedAt": "string"
}

Response samples

Content type
application/json
{
  • "createdAt": "string",
  • "defaults": {
    },
  • "endpoints": [
    ],
  • "name": "string",
  • "routingKey": "string",
  • "spec": {
    },
  • "status": {
    },
  • "updatedAt": "string"
}

Sandboxes

List sandboxes

List all sandboxes under the specified Signadot org.

Authorizations:
ApiKeyAuth
path Parameters
orgName
required
string
Example: my-company

Signadot Org Name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete a sandbox

Delete a given sandbox.

Authorizations:
ApiKeyAuth
path Parameters
orgName
required
string
Example: my-company

Signadot Org Name

sandboxName
required
string
Example: my-sandbox

Sandbox Name

query Parameters
force
boolean

force

Responses

Response samples

Content type
application/json
{ }

Get a sandbox

Fetch the details about a given sandbox.

Authorizations:
ApiKeyAuth
path Parameters
orgName
required
string
Example: my-company

Signadot Org Name

sandboxName
required
string
Example: my-sandbox

Sandbox Name

Responses

Response samples

Content type
application/json
{
  • "createdAt": "string",
  • "defaults": {
    },
  • "endpoints": [
    ],
  • "name": "string",
  • "routingKey": "string",
  • "spec": {
    },
  • "status": {
    },
  • "updatedAt": "string"
}

Create or update a sandbox

Creates or updates a sandbox with the provided parameters.

Authorizations:
ApiKeyAuth
path Parameters
orgName
required
string
Example: my-company

Signadot Org Name

sandboxName
required
string
Example: my-sandbox

Sandbox Name

Request Body schema: application/json
required

Request to create sandbox

createdAt
string
object (defaults.CompositeDefaults)
Array of objects (sandbox.Endpoint)
name
string

Human-readable name of this sandbox

routingKey
string
object (sandbox.Spec)
object

Status *sdv1.SandboxReadiness json:"status,omitempty"

updatedAt
string

Responses

Request samples

Content type
application/json
{
  • "createdAt": "string",
  • "defaults": {
    },
  • "endpoints": [
    ],
  • "name": "string",
  • "routingKey": "string",
  • "spec": {
    },
  • "status": {
    },
  • "updatedAt": "string"
}

Response samples

Content type
application/json
{
  • "createdAt": "string",
  • "defaults": {
    },
  • "endpoints": [
    ],
  • "name": "string",
  • "routingKey": "string",
  • "spec": {
    },
  • "status": {
    },
  • "updatedAt": "string"
}