DocsGPU APIInstance Management

Instance Management

Launch, stop, and delete GPU VMs programmatically.

POST

https://api.geodd.io/vm/up

POST

https://api.geodd.io/vm/down

DELETE

https://api.geodd.io/vm/instances/{instanceId}

Authorizations

Authorization string header required

Bearer authentication header of the form Bearer <apiKey>, where <apiKey> is your Enterprise API key.

Launch VM

POST /vm/up

instanceType string required

One of the VM types from VM Availability.

Example: gpu_1x_h100

region string required

A region with available capacity for that type.

Example: us-east-1

sshKeyId string required

Id of one of your SSH keys, installed on the VM for login.

Stop VM

POST /vm/down

instanceId string required

Id of the VM to stop.

Delete VM

DELETE /vm/instances/{instanceId}

instanceId string path required

The id of the VM to delete.

Responses

401

Unauthorized

Missing or invalid API key. Check the Authorization header.

503

Service Unavailable

Instance management is not currently available.

Example Request — Launch a VM:

curl -X POST https://api.geodd.io/vm/up \
  -H "Authorization: Bearer $GEODD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "instanceType": "gpu_1x_h100",
    "region": "us-east-1",
    "sshKeyId": "69b10a7763766addac6461a1"
  }'

Current Response:

{
  "success": false,
  "error": "Instance management is not currently available"
}

Notes

Enterprise customers can request early access to instance management by emailing [email protected].
Until then, GPU instances can be deployed through the Deploy Pad console.

SSH Keys

Payment Methods