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

TensorDock Instances API

The current TensorDock Instances API (v2) at https://dashboard.tensordock.com/api/v2/instances for creating, listing, inspecting, starting, stopping, modifying, and deleting GPU and CPU virtual machines. Uses Bearer token authentication and a JSON:API-style envelope of `data.type`, `data.id`, and `data.attributes`. Supports both location-based and hostnode-based deployment patterns.

TensorDock Instances API is one of 3 APIs that TensorDock publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include GPU, Cloud, Compute, Instances, and Virtual Machines. The published artifact set on APIs.io includes API documentation, an OpenAPI specification, a JSON-LD context, and 1 JSON Schema.

This API exposes 7 operations across 5 paths, and defines 11 schemas. It is described by OpenAPI 3.1.0, at version 2.0.

Requests are made against a single base URL, https://dashboard.tensordock.com.

7 operations 5 paths 11 schemas 1 DELETE2 GET3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0
Server
https://dashboard.tensordock.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

TensorDock Instances API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (API Key) (BearerAuth). By default, every request must be authenticated.

  • BearerAuth — Bearer token authentication. Generate API tokens at https://dashboard.tensordock.com/api. Send the token in the Authorization: Bearer header.

Paths & Operations 7

Across 5 paths, the API surfaces 7 operations — 1 DELETE, 2 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Instances 7

Create, list, inspect, and manage virtual machine instances

GET
/api/v2/instances
List Instances
listInstances → 200401429
POST
/api/v2/instances
Create Instance
createInstance body → 201400401429
GET
/api/v2/instances/{id}
Get Instance
getInstance 1 param → 200401404
DELETE
/api/v2/instances/{id}
Delete Instance
deleteInstance 1 param → 200
POST
/api/v2/instances/{id}/start
Start Instance
startInstance 1 param → 200
POST
/api/v2/instances/{id}/stop
Stop Instance
stopInstance 1 param → 200
PUT
/api/v2/instances/{id}/modify
Modify Instance
modifyInstance 1 param body → 200

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are InstanceAttributes (8 properties), ModifyInstanceRequest (4 properties), Resources (4 properties), InstanceEnvelope (3 properties). Each schema is shown below with its type and property counts.

InstanceStatusEnvelope
object
1 property
ErrorResponse
object
1 property
GpuAllocation
object
2 properties
InstanceListResponse
object
1 property
InstanceAttributes
object
8 properties
SuccessEnvelope
object
1 property
CreateInstanceRequest
object
1 property 1 required
ModifyInstanceRequest
object
4 properties
InstanceEnvelope
object
3 properties
Resources
object
4 properties
InstanceResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tensordock-instances-api-openapi.yml Raw ↑

Other APIs TensorDock publishes across the network.

TensorDock Marketplace API
TensorDock Secrets API