Usages

List Total Account Usage

get

Get account/organization level usage information in minutes.

Headers

Name	Type
Authorization*	HMAC {key}:{signature}:{nonce}:{timestamp}
Content-Type	application/json

Response Fields

Field	Type	Description
usage_minutes	Integer	Available usage in minutes
machine_type	String	Machine type name (e.g., "Planet")

Success Response Example

{
    "usage_minutes": 13174,
    "machine_type": "Planet",
    "client_code": 200,
    "message": "OK",
    "timestamp": "2026-01-28T08:40:08Z"
}

Responses

200

Account usage information

application/json

get

/usage

HTTPcURLJavaScriptPython

GET /organization-management/v1/usage HTTP/1.1
Host: api.vagon.io
Accept: */*

200

Account usage information

{
  "client_code": 200,
  "message": "OK",
  "timestamp": "2026-01-15T15:14:09Z",
  "usage_minutes": 13174,
  "machine_type": "Planet"
}

List Machine Usage

get

Get remaining usage information in minutes for all machines.

Headers

Name	Type
Authorization*	HMAC {key}:{signature}:{nonce}:{timestamp}
Content-Type	application/json

Response Fields

Field	Type	Description
machine_id	Integer	Machine ID
machine_name	String	Machine Name
usage_minutes	Integer	Usage minutes based on total balance (including credits)
machine_type	String	Machine type name (e.g., "Planet")

Success Response Example

{
    "machines": [
        {
            "machine_id": 512,
            "machine_name": "Computer #512",
            "usage_minutes": 0,
            "machine_type": "Planet"
        },
        {
            "machine_id": 509,
            "machine_name": "Computer #509",
            "usage_minutes": 0,
            "machine_type": "Planet"
        }
    ],
    "count": 2,
    "client_code": 200,
    "message": "OK",
    "timestamp": "2026-01-28T08:46:22Z"
}

Responses

200

Machine usage list

application/json

get

/usage/machines

HTTPcURLJavaScriptPython

GET /organization-management/v1/usage/machines HTTP/1.1
Host: api.vagon.io
Accept: */*

200

Machine usage list

{
  "client_code": 200,
  "message": "OK",
  "timestamp": "2026-01-15T15:14:09Z",
  "machines": [
    {
      "machine_id": 1,
      "machine_name": "text",
      "usage_minutes": 1,
      "machine_type": "text"
    }
  ],
  "count": 1
}

List Machine Usages for All

get

Get remaining machine usage information in minutes for a specific machine.

Headers

Name	Type
Authorization*	HMAC {key}:{signature}:{nonce}:{timestamp}
Content-Type	application/json

Path Parameters

Parameter	Type	Description
id*	Integer	Machine ID

Response Fields

Field	Type	Description
machine_id	Integer	Machine ID
machine_name	String	Machine name
usage_minutes	Integer	Usage minutes based on total balance (including credits)
machine_type	String	Machine type friendly name (e.g., "Planet")

Success Response Example

{
    "machine_id": 433,
    "machine_name": "Computer #433",
    "usage_minutes": 2400,
    "machine_type": "Planet",
    "client_code": 200,
    "message": "OK",
    "timestamp": "2026-01-28T08:46:20Z"
}

Error Responses

Status	Description
404	Machine not found
4709	Seat not found for machine

Path parameters

idintegerRequired

(Optional) Machine ID, Don't send to list usages for all machines.

Example: 433

Responses

200

Machine usage information

application/json

404

Machine not found

application/json

4709

Seat not found for machine

application/json

get

/usage/machines/{id}

HTTPcURLJavaScriptPython

GET /organization-management/v1/usage/machines/{id} HTTP/1.1
Host: api.vagon.io
Accept: */*

{
  "client_code": 200,
  "message": "OK",
  "timestamp": "2026-01-15T15:14:09Z",
  "machine_id": 1,
  "machine_name": "text",
  "usage_minutes": 1,
  "machine_type": "text"
}

Assign Machine Usage

post

Assign usage in minutes from team balance to a machine.

Headers

Name	Type
Authorization*	HMAC {key}:{signature}:{nonce}:{timestamp}
Content-Type	application/json

Body Parameters

Parameter	Type	Required	Description
machine_id*	Integer	Yes	Machine ID
minutes*	Integer	Yes	Number of minutes to assign

Request Body Example

{
  "machine_id": 213,
  "minutes": 1
}

Response Fields

Field	Type	Description
assigned_minutes	Integer	Number of minutes assigned
machine_id	Integer	Machine ID that received the assignment
machine_type	String	Machine type friendly name used for pricing calculation (e.g., "Planet")

Success Response Example

{
    "assigned_minutes": 1,
    "machine_id": 433,
    "machine_type": "Planet",
    "client_code": 200,
    "message": "OK",
    "timestamp": "2026-01-28T08:55:51Z"
}

Error Responses

Status	Description
400	Bad request (missing required parameters)
404	Machine not found
480	Insufficient organization balance
482	Balance assignment failed
483	Internal error

Body

application/json

machine_idintegerOptional

minutesintegerOptional

Responses

200

Usage assigned successfully

application/json

400

Bad request

application/json

404

Machine not found

application/json

480

Insufficient organization balance

application/json

482

Balance assignment failed

application/json

post

/usage/assign

HTTPcURLJavaScriptPython

POST /organization-management/v1/usage/assign HTTP/1.1
Host: api.vagon.io
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "machine_id": 433,
  "minutes": 1
}

{
  "client_code": 200,
  "message": "OK",
  "timestamp": "2026-01-15T15:14:09Z",
  "assigned_minutes": 1,
  "machine_id": 1,
  "machine_type": "text"
}

Retrieve Machine Usage

post

Retrieve extra assigned usage from machine back to team balance.

Headers

Name	Type
Authorization*	HMAC {key}:{signature}:{nonce}:{timestamp}
Content-Type	application/json

Body Parameters

Parameter	Type	Required	Description
machine_id*	Integer	Yes	Machine ID
minutes*	Integer	Yes	Number of minutes to retrieve. Cannot exceed available usage.

Request Body Example

{
  "machine_id": 433,
  "minutes": 60
}

Response Fields

Field	Type	Description
retrieved_minutes	Integer	Number of minutes retrieved
machine_id	Integer	Machine ID
machine_type	String	Machine type name

Success Response Example

{
    "retrieved_minutes": 1,
    "machine_id": 433,
    "machine_type": "Planet",
    "client_code": 200,
    "message": "OK",
    "timestamp": "2026-01-28T09:00:21Z"
}

Error Responses

Status	Description
400	Bad request (missing required parameters)
404	Machine not found
480	No usages left in machine
482	Usage retrieval failed
483	Internal error

Body

application/json

machine_idintegerOptional

minutesintegerOptional

Responses

200

Usage retrieved successfully

application/json

400

Bad request

application/json

404

Machine not found

application/json

480

No usages left in machine

application/json

482

Usage retrieval failed

application/json

post

/usage/retrieve

HTTPcURLJavaScriptPython

POST /organization-management/v1/usage/retrieve HTTP/1.1
Host: api.vagon.io
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "machine_id": 433,
  "minutes": 60
}

{
  "client_code": 200,
  "message": "OK",
  "timestamp": "2026-01-15T15:14:09Z",
  "retrieved_minutes": 1,
  "machine_id": 1,
  "machine_type": "text"
}