Skip to main content
GET
/
resources
/
{resource_id}
Get Resource
curl --request GET \
  --url https://supply-api.compute-desk.com/resources/{resource_id} \
  --header 'Authorization: Bearer <token>'
{
  "resource_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "resource_type": "<string>",
  "vendor": "<string>",
  "vendor_region": "<string>",
  "status": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "status_message": "<string>",
  "access": {
    "external_ip": "<string>",
    "internal_ip": "<string>",
    "ssh_command": "<string>",
    "ssh_port": 123
  },
  "spec": {},
  "linked_resources": [
    {
      "resource_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "resource_type": "<string>",
      "status": "<string>",
      "link_type": "<string>",
      "linked_since": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "linked_until": "2023-11-07T05:31:56Z"
    }
  ],
  "offer_history": [
    {
      "offer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "offer_type": "<string>",
      "role": "<string>",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "pricing_total_hourly": 123,
  "valid_from": "2023-11-07T05:31:56Z",
  "valid_to": "2023-11-07T05:31:56Z",
  "last_synced_at": "2023-11-07T05:31:56Z"
}
Returns details for a single resource including connection info (IP, SSH command) and current status.

​
Force refresh

Pass ?force_refresh=true to trigger a live vendor poll instead of using cached state. This is useful when you need the most up-to-date status immediately after an operation.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
resource_id
string<uuid>
required

Query Parameters

​
force_refresh
boolean
default:false

Response

Successful Response

Summary of a user-level resource (for list endpoint).

​
resource_id
string<uuid>
required
​
resource_type
string
required
​
vendor
string
required
​
vendor_region
string
required
​
status
string
required
​
created_at
string<date-time>
required
​
name
string | null
​
status_message
string | null
​
access
ResourceAccessInfo · object | null

Connection details for a resource (populated from vendor item outputs).

​
spec
Spec · object
​
linked_resources
LinkedResourceSummary · object[]
​
offer_history
OfferResourceSummary · object[]
​
pricing_total_hourly
number | null
​
valid_from
string<date-time> | null
​
valid_to
string<date-time> | null
​
last_synced_at
string<date-time> | null