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")

client_code

Integer

Response code (200 for success)

message

String

Response message

timestamp

String

Response timestamp (ISO 8601)

Success Response Example

{
    "usage_minutes": 2669,
    "machine_type": "Planet",
    "client_code": 200,
    "message": "OK",
    "timestamp": "2026-02-04T13:26:14Z"
}

Responses

200

Account usage information

application/json

Organization-level usage information

client_codeintegerOptionalExample: 200

messagestringOptionalExample: OK

timestampstring · date-timeOptionalExample: 2026-02-05T10:10:22Z

usage_minutesintegerOptional

Available usage time in minutes

Example: 2669

machine_typestringOptional

Machine type for usage calculation

Example: Planet

400

Bad request

application/json

404

Not found

application/json

4710

Permission required

application/json

get

/usage

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

{
  "client_code": 200,
  "message": "OK",
  "timestamp": "2026-02-05T10:10:22Z",
  "usage_minutes": 2669,
  "machine_type": "Planet"
}

List All Machines 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

machines

Array

Array of machine usage objects

machines[].machine_id

Integer

Machine ID

machines[].machine_name

String

Machine Name

machines[].usage_minutes

Integer

Usage minutes based on total balance (including credits)

machines[].machine_type

String

Machine type name (e.g., "Planet")

machines[].usage_source

String

Usage source - "machine" (only assigned usages) or "team_balance" (can use team balance when no additional usage on machine)

count

Integer

Total number of machines

client_code

Integer

Response code (200 for success)

message

String

Response message

timestamp

String

Response timestamp (ISO 8601)

Success Response Example

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

Responses

200

Machine usage list

application/json

Usage information for all machines

client_codeintegerOptionalExample: 200

messagestringOptionalExample: OK

timestampstring · date-timeOptionalExample: 2026-02-05T10:10:22Z

countintegerOptional

Total number of machines

Example: 9

400

Bad request

application/json

404

Not found

application/json

4710

Permission required

application/json

get

/usage/machines

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

{
  "client_code": 200,
  "message": "OK",
  "timestamp": "2026-02-05T10:10:22Z",
  "machines": [
    {
      "machine_id": 717,
      "machine_name": "Computer #717",
      "usage_minutes": 1172,
      "machine_type": "Planet",
      "usage_source": "machine"
    }
  ],
  "count": 9
}

List Machine Usages by ID

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")

usage_source

String

Usage source - "machine" (only assigned usages) or "team_balance" (can use team balance when no additional usage on machine)

client_code

Integer

Response code (200 for success)

message

String

Response message

timestamp

String

Response timestamp (ISO 8601)

Success Response Example

{
    "machine_id": 717,
    "machine_name": "Computer #717",
    "usage_minutes": 1172,
    "machine_type": "Planet",
    "usage_source": "machine",
    "client_code": 200,
    "message": "OK",
    "timestamp": "2026-02-04T13:28:19Z"
}

Error Responses

Status

Description

400

Bad request

404

Machine not found

4709

Seat not found for machine

4710

Permission required

Path parameters

idintegerRequired

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

Example: 433

Responses

200

Machine usage information

application/json

Usage information for a specific machine

client_codeintegerOptionalExample: 200

messagestringOptionalExample: OK

timestampstring · date-timeOptionalExample: 2026-02-05T10:10:22Z

machine_idintegerOptional

Machine ID

Example: 717

machine_namestringOptional

Machine name

Example: Computer #717

usage_minutesintegerOptional

Remaining usage in minutes

Example: 1172

machine_typestringOptional

Machine performance type

Example: Planet

usage_sourcestring · enumOptional

"machine" means only assigned usages; "team_balance" means can use team balance when no additional usage on machine.

Example: machinePossible values:

400

Bad request

application/json

404

Machine not found

application/json

4709

Seat not found for machine

application/json

4710

Permission required

application/json

get

/usage/machines/{id}

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

{
  "client_code": 200,
  "message": "OK",
  "timestamp": "2026-02-05T10:10:22Z",
  "machine_id": 717,
  "machine_name": "Computer #717",
  "usage_minutes": 1172,
  "machine_type": "Planet",
  "usage_source": "machine"
}

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": 717,
  "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")

client_code

Integer

Response code (200 for success)

message

String

Response message

timestamp

String

Response timestamp (ISO 8601)

Success Response Example

{
    "assigned_minutes": 1,
    "machine_id": 717,
    "machine_type": "Planet",
    "client_code": 200,
    "message": "OK",
    "timestamp": "2026-02-04T13:31:47Z"
}

Error Responses

Status

Description

400

Bad request (missing required parameters)

404

Machine not found

480

Insufficient organization balance

482

Balance assignment failed

4710

Permission required

Body

machine_idintegerRequired

Machine ID to assign usage to

minutesintegerRequired

Number of minutes to assign

Responses

200

Usage assigned successfully

application/json

Response after assigning usage to a machine

client_codeintegerOptionalExample: 200

messagestringOptionalExample: OK

timestampstring · date-timeOptionalExample: 2026-02-05T10:10:22Z

assigned_minutesintegerOptional

Number of minutes assigned

Example: 1

machine_idintegerOptional

Machine ID that received the usage

Example: 717

machine_typestringOptional

Machine performance type

Example: Planet

400

Bad request

application/json

404

Machine not found

application/json

480

Insufficient organization balance

application/json

482

Balance assignment failed

application/json

4710

Permission required

application/json

post

/usage/assign

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

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

{
  "client_code": 200,
  "message": "OK",
  "timestamp": "2026-02-05T10:10:22Z",
  "assigned_minutes": 1,
  "machine_id": 717,
  "machine_type": "Planet"
}

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": 717,
  "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

client_code

Integer

Response code (200 for success)

message

String

Response message

timestamp

String

Response timestamp (ISO 8601)

Success Response Example

{
    "retrieved_minutes": 1,
    "machine_id": 717,
    "machine_type": "Planet",
    "client_code": 200,
    "message": "OK",
    "timestamp": "2026-02-04T13:51:41Z"
}

Error Responses

Status

Description

400

Bad request (missing required parameters)

404

Machine not found

480

No usages left in machine

482

Usage retrieval failed

4710

Permission required

Body

machine_idintegerRequired

Machine ID to retrieve usage from

minutesintegerRequired

Number of minutes to retrieve (cannot exceed available usage)

Responses

200

Usage retrieved successfully

application/json

Response after retrieving usage from a machine

client_codeintegerOptionalExample: 200

messagestringOptionalExample: OK

timestampstring · date-timeOptionalExample: 2026-02-05T10:10:22Z

retrieved_minutesintegerOptional

Number of minutes retrieved

Example: 1

machine_idintegerOptional

Machine ID from which usage was retrieved

Example: 717

machine_typestringOptional

Machine performance type

Example: Planet

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

4710

Permission required

application/json

post

/usage/retrieve

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

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

{
  "client_code": 200,
  "message": "OK",
  "timestamp": "2026-02-05T10:10:22Z",
  "retrieved_minutes": 1,
  "machine_id": 717,
  "machine_type": "Planet"
}

PreviousImages

Last updated 20 days ago

hashtagList Total Account Usage

hashtagHeaders

hashtagResponse Fields

hashtagSuccess Response Example

hashtagList All Machines Usage

hashtagHeaders

hashtagResponse Fields

hashtagSuccess Response Example

hashtagList Machine Usages by ID

hashtagHeaders

hashtagPath Parameters

hashtagResponse Fields

hashtagSuccess Response Example

hashtagError Responses

hashtagAssign Machine Usage

hashtagHeaders

hashtagBody Parameters

hashtagRequest Body Example

hashtagResponse Fields

hashtagSuccess Response Example

hashtagError Responses

hashtagRetrieve Machine Usage

hashtagHeaders

hashtagBody Parameters

hashtagRequest Body Example

hashtagResponse Fields

hashtagSuccess Response Example

hashtagError Responses

List Total Account Usage

Headers

Response Fields

Success Response Example

List All Machines Usage

Headers

Response Fields

Success Response Example

List Machine Usages by ID

Headers

Path Parameters

Response Fields

Success Response Example

Error Responses

Assign Machine Usage

Headers

Body Parameters

Request Body Example

Response Fields

Success Response Example

Error Responses

Retrieve Machine Usage

Headers

Body Parameters

Request Body Example

Response Fields

Success Response Example

Error Responses