GPU Cloud Metrics API
The Metrics API from GPU Cloud — 1 operation(s) for metrics.
The Metrics API from GPU Cloud — 1 operation(s) for metrics.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/gpucloud-ca:gpucloud-ca-metrics-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: GPU Cloud Metrics API
description: 'REST API of GPUcloud.ca: GPU plans, GPU servers (deploy, power actions, metrics, firewall), SSH keys and API keys. All prices are in CAD. Authenticate with a REST API key: `Authorization: Bearer `. AI agents should use the MCP endpoint (https://gpucloud.ca/api/mcp) with an MCP key instead. REST keys (prefix gpu_) are created in the console, expire after 90 days and are either full access or read-only (GET only; a read-only key gets 401 on any other method). Write requests (POST, PUT, DELETE) must also send the header `Origin: https://gpucloud.ca`, otherwise they get 403. Developer guide: https://gpucloud.ca/en/developers'
version: 1.1.1
contact:
name: GPU Cloud Support
url: https://gpucloud.ca
email: info@gpucloud.ca
servers:
- url: https://gpucloud.ca/api
description: Production
security: []
tags:
- name: Metrics
paths:
/servers/{id}/metrics:
parameters:
- name: id
in: path
required: true
schema:
type: string
description: Server ID
get:
summary: Server Metrics
description: Get CPU, RAM, and network metrics for a server.
operationId: getServerMetrics
tags:
- Metrics
security:
- BearerAuth: []
responses:
'200':
description: Server metrics
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/Metrics'
'400':
description: Server not yet provisioned
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalError'
components:
schemas:
Metrics:
type: object
properties:
cpu:
type: object
properties:
timestamps:
type: array
items:
type: string
values:
type: array
items:
type: number
ram:
type: object
properties:
timestamps:
type: array
items:
type: string
values:
type: array
items:
type: number
network_in:
type: object
properties:
timestamps:
type: array
items:
type: string
values:
type: array
items:
type: number
network_out:
type: object
properties:
timestamps:
type: array
items:
type: string
values:
type: array
items:
type: number
AccountAction:
type: object
description: What to do to fix an account or payment problem, with the direct absolute link. Same object on every route and in the MCP tool errors (structuredContent.error.accountAction). The message is in French when Accept-Language asks for it, otherwise in English.
properties:
code:
type: string
enum:
- NO_API_KEY
- INVALID_API_KEY
- PAYMENT_REQUIRED
- BUDGET_CAP_REACHED
description: Stable machine code. NO_API_KEY and INVALID_API_KEY come with HTTP 401, PAYMENT_REQUIRED and BUDGET_CAP_REACHED with HTTP 402.
message:
type: string
description: Clear sentence telling what to do, including the link.
action:
type: object
properties:
label:
type: string
url:
type: string
format: uri
required:
- label
- url
links:
type: object
description: 'Absolute links: account creation, sign in, API keys page, billing, add credits (opens the credit window), payment card, budget or cap setting, documentation.'
properties:
signup:
type: string
format: uri
login:
type: string
format: uri
apiKeys:
type: string
format: uri
billing:
type: string
format: uri
addCredits:
type: string
format: uri
paymentMethod:
type: string
format: uri
budget:
type: string
format: uri
documentation:
type: string
format: uri
required:
- signup
- login
- apiKeys
- billing
- addCredits
- paymentMethod
- budget
- documentation
minimumCad:
type: number
description: 'PAYMENT_REQUIRED only, when known: credits (CAD) covering one hour of the GPU asked for, computed by the server from the same price as the deployment.'
minimumTopupCad:
type: number
description: Smallest credit purchase accepted (CAD), given with minimumCad.
balanceCad:
type: number
description: 'PAYMENT_REQUIRED and BUDGET_CAP_REACHED, when known: the account''s credit balance (CAD) when the request was refused.'
hibernationThresholdCad:
type: number
description: 'PAYMENT_REQUIRED, when a server is concerned: its hibernation threshold (CAD), the larger of 3 CAD and 2 hours of its hourly rate. A running hourly server is hibernated when the balance reaches its threshold (after the automatic reload was tried); it restarts automatically as soon as the balance is above the threshold. A server is never deleted while the account has credit left. When the balance covers only about 24 hours of what the account spends per hour, a first notice is sent while the servers still run, then two more about 24 hours and 1 hour before the deletion; a server is deleted with its data only once it is out of service (stopped or hibernated for lack of credit, or hibernated by the user for at least 72 hours), once the credit is exhausted (the balance no longer pays the next hour of the account''s servers), after the three notices and at least 24 hours after the first. Adding credits cancels the deletion. For the restart of such a server, minimumCad is the balance that restarts it (threshold + 0.01).'
capCad:
type: number
description: 'BUDGET_CAP_REACHED of an MCP key, for a money cap: the cap reached (CAD). The cap set by the customer is always respected: nothing is charged or reloaded beyond it.'
capRemainingCad:
type: number
description: 'BUDGET_CAP_REACHED of an MCP key, with capCad: what is left of that cap (CAD).'
required:
- code
- message
- action
- links
AccountActionError:
type: object
description: 'Error of an account or payment problem. Backward compatible: `error` keeps its previous string value (for example "Unauthorized" or "INSUFFICIENT_CREDITS"), `message` and the existing details stay; `accountAction` is added.'
properties:
error:
type: string
description: Previous error string or code, unchanged (backward compatibility).
message:
type: string
requiredCredits:
type: number
description: 'INSUFFICIENT_CREDITS: credits (CAD) the action needs.'
currentBalance:
type: number
accountAction:
$ref: '#/components/schemas/AccountAction'
required:
- error
- accountAction
Error:
type: object
properties:
error:
type: string
required:
- error
responses:
NotFound:
description: Resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error: Server not found
TooManyRequests:
description: Rate limit exceeded
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error: Too many requests
Unauthorized:
description: 'No API key (accountAction.code NO_API_KEY) or an invalid, expired, revoked or read only key on a write (INVALID_API_KEY). Provide a valid API key as `Authorization: Bearer <key>`; accountAction gives the links to create an account and a key.'
headers:
WWW-Authenticate:
schema:
type: string
description: Bearer realm="gpucloud" (error="invalid_token" when a key was sent).
content:
application/json:
schema:
$ref: '#/components/schemas/AccountActionError'
examples:
noKey:
summary: No key sent
value:
error: Unauthorized. Use Bearer API key.
message: 'No API key was sent. Create a GPU Cloud account (https://gpucloud.ca/en/auth/register), then an API key in the console (https://gpucloud.ca/en/console/settings#api-keys), and send it in the header Authorization: Bearer gpu_...'
accountAction:
code: NO_API_KEY
message: 'No API key was sent. Create a GPU Cloud account (https://gpucloud.ca/en/auth/register), then an API key in the console (https://gpucloud.ca/en/console/settings#api-keys), and send it in the header Authorization: Bearer gpu_...'
action:
label: Create an account
url: https://gpucloud.ca/en/auth/register
links:
signup: https://gpucloud.ca/en/auth/register
login: https://gpucloud.ca/en/auth/login
apiKeys: https://gpucloud.ca/en/console/settings#api-keys
billing: https://gpucloud.ca/en/console/billing
addCredits: https://gpucloud.ca/en/console/billing?addCredits=25
paymentMethod: https://gpucloud.ca/en/console/billing?addCredits=25#payment-method
budget: https://gpucloud.ca/en/console/billing#budget-limit
documentation: https://gpucloud.ca/en/developers#errors
invalidKey:
summary: Invalid, expired or revoked key
value:
error: Unauthorized
message: 'This API key is invalid, expired, revoked or lacks the required permission. Create a new API key in the console (https://gpucloud.ca/en/console/settings#api-keys) and send it in the header Authorization: Bearer gpu_... No account yet: https://gpucloud.ca/en/auth/register'
accountAction:
code: INVALID_API_KEY
message: 'This API key is invalid, expired, revoked or lacks the required permission. Create a new API key in the console (https://gpucloud.ca/en/console/settings#api-keys) and send it in the header Authorization: Bearer gpu_... No account yet: https://gpucloud.ca/en/auth/register'
action:
label: Create an API key
url: https://gpucloud.ca/en/console/settings#api-keys
links:
signup: https://gpucloud.ca/en/auth/register
login: https://gpucloud.ca/en/auth/login
apiKeys: https://gpucloud.ca/en/console/settings#api-keys
billing: https://gpucloud.ca/en/console/billing
addCredits: https://gpucloud.ca/en/console/billing?addCredits=25
paymentMethod: https://gpucloud.ca/en/console/billing?addCredits=25#payment-method
budget: https://gpucloud.ca/en/console/billing#budget-limit
documentation: https://gpucloud.ca/en/developers#errors
InternalError:
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error: Internal server error
securitySchemes:
BearerAuth:
type: http
scheme: bearer
description: 'REST API key (prefix gpu_) created in the GPU Cloud console (Settings). Pass it as `Authorization: Bearer <your-api-key>`. Keys expire after 90 days; a read-only key may only call GET. Write requests (POST, PUT, DELETE) must also send `Origin: https://gpucloud.ca`.'