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
{
  • "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
{
  • "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"
}

ResourcePlugins

List resource plugins

List all resource plugins 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 resource plugin

Delete the resource plugin by name

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

Signadot Org Name

pluginName
required
string
Example: mariadb-plugin

Resource plugin name

Responses

Response samples

Content type
application/json
{ }

Get the requested resource plugin

Get the specified resource plugin by name

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

Signadot Org Name

pluginName
required
string
Example: mariadb-plugin

Resource plugin name

Responses

Response samples

Content type
application/json
{
  • "createdAt": "string",
  • "name": "string",
  • "spec": {
    },
  • "status": {
    },
  • "updatedAt": "string"
}

Apply a resource plugin

Apply a resource plugin. Updates are not supported at this time.

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 or update a resource plugin

createdAt
string

The time at which the resource plugin was created

name
string

Name of the resource plugin

object (resourceplugin.Spec)
object (resourceplugin.Status)
updatedAt
string

The time at which the resource plugin was last updated

Responses

Request samples

Content type
application/json
{
  • "createdAt": "string",
  • "name": "string",
  • "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",
  • "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
Array of objects (routeGroup.Endpoint)
name
string
routingKey
string
object (routeGroup.Spec)
object (routeGroup.Status)
updatedAt
string

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "createdAt": "string",
  • "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",
  • "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
Array of objects (sandbox.Endpoint)
name
string

Human-readable name of this sandbox

routingKey
string
object (sandbox.Spec)
object (sandbox.Readiness)
updatedAt
string

Responses

Request samples

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

Response samples

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