Vagon

https://docs.vagon.io
Admin
Vagon is a cloud platform providing scalable application streaming for Unreal Engine and Unity...
Tokens:349,798
Snippets:2,289
Trust Score:9.4
Update:23 hours ago
Show doc for...
Tokens:
Raw
### Start Machine - HTTP Request

Source: https://docs.vagon.io/teams/reference/machines

HTTP request example for POST /machines/{id}/start. Uses Host api.vagon.io and Accept */*.

```http
POST /organization-management/v1/machines/{id}/start HTTP/1.1
Host: api.vagon.io
Accept: */*
```

--------------------------------

### Success Response Example for Image Creation

Source: https://docs.vagon.io/teams/reference/images

Example 200 response from POST /images/install. Shows image attributes including size in bytes (with 5% buffer), status 'pending', source 'pre_installation', and nested software data.

```json
{
  "id": "1",
  "type": "image",
  "attributes": {
    "id": 1,
    "name": "Design Suite Template",
    "size": 107374182400,
    "status": "pending",
    "source": "pre_installation",
    "created_at": "2024-01-15T10:00:00Z",
    "updated_at": "2024-01-15T10:00:00Z",
    "softwares": {
      "data": [
        {
          "id": "1",
          "type": "software",
          "attributes": {
            "id": 1,
            "name": "Adobe Photoshop",
            "size": 5583457484
          }
        },
        {
          "id": "1",
          "type": "software",
          "attributes": {
            "id": 2,
            "name": "Blender",
            "size": 5583457484
          }
        }
      ]
    }
  }
}
```

--------------------------------

### Get Available Machine Performances - HTTP Request

Source: https://docs.vagon.io/teams/reference/machines

HTTP request example for GET /machines/{id}/available-machine-types. Uses Host api.vagon.io and Accept */*.

```http
GET /organization-management/v1/machines/{id}/available-machine-types HTTP/1.1
Host: api.vagon.io
Accept: */*
```

--------------------------------

### onInstalling

Source: https://docs.vagon.io/streams/integrations/client-side-communication/javascript-sdk

Prints out the message when application is on installing state.

```APIDOC
## onInstalling

### Description
Prints out the message when application is on installing state.

### Event Name
`onInstalling`

### Availability
Enterprise Plan only.
```

--------------------------------

### List Users - HTTP Request Example

Source: https://docs.vagon.io/teams/reference/users

Example HTTP request for the List Users endpoint. It uses GET /organization-management/v1/users with Host api.vagon.io and Accept */*.

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

--------------------------------

### GET Request Signing String (No Body)

Source: https://docs.vagon.io/teams/reference/authentication.md

Example signing string for a GET request with no body. The request_body component is an empty string, so the concatenation ends with the nonce.

```text
signing_string = "ak_live_abc123GET/organization-management/v1/machines1712567890123550e8400-e29b-41d4-a716-446655440000"
```

--------------------------------

### Success Response Example (Directory)

Source: https://docs.vagon.io/teams/reference/files.md

Example response for a directory creation, with upload_urls set to null and chunk_size not used. Directory creation is immediate and requires no upload.

```json
{
  "id": 124,
  "uid": "def456-ghi789-jkl012",
  "upload_urls": null,
  "chunk_size": 250,
  "client_code": 200,
  "message": "OK",
  "timestamp": "2026-02-05T10:00:00Z"
}
```

--------------------------------

### GET /organization-management/v1/usage/machines - HTTP Request

Source: https://docs.vagon.io/teams/reference/usages

HTTP request example for the all machines usage endpoint.

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

--------------------------------

### onInstalling event handler

Source: https://docs.vagon.io/streams/integrations/client-side-communication/javascript-sdk.md

Prints out the message when the application is in the installing state.

```javascript
window.Vagon.onInstalling(() => {
	console.log("Application Installing");
});
```

--------------------------------

### GET /organization-management/v1/usage/machines - Success Response Example

Source: https://docs.vagon.io/teams/reference/usages

Example JSON response for the all machines usage endpoint. Shows an array of machine usage objects with machine_id, machine_name, usage_minutes, machine_type, and usage_source.

```json
{
    "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"
}
```

--------------------------------

### Bulk Create & Assign Computers - Response Example

Source: https://docs.vagon.io/teams/reference/machines.md

Example JSON response showing per-row results with invitation status, machine_id, disk_size, template, and error for rejected rows. Includes summary counts and client_code.

```json
{
    "results": {
        "user@example.com": {
            "invitation": "created",
            "machine_id": 8085,
            "disk_size": 275,
            "template": "assigned: Design Template"
        },
        "taken@example.com": {
            "invitation": "skipped (already on a team)",
            "machine_id": null,
            "disk_size": null,
            "template": "User is already on a team.",
            "error": "User is already on a team."
        },
        "(no email #3)": {
            "invitation": "skipped (no email)",
            "machine_id": 8086,
            "disk_size": 275,
            "template": "assigned: Design Template"
        }
    },
    "summary": {
        "total": 3,
        "invalid": 1,
        "assigned": 2
    },
    "client_code": 200,
    "message": "OK",
    "timestamp": "2026-06-08T11:58:57Z"
}
```

--------------------------------

### GET /organization-management/v1/usage - HTTP Request

Source: https://docs.vagon.io/teams/reference/usages

HTTP request example for the total account usage endpoint.

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

--------------------------------

### Success Response Example (File)

Source: https://docs.vagon.io/teams/reference/files.md

Example response for a file creation, containing an id, uid, upload_urls array with part_number and presigned URL for each part, chunk_size, client_code, message, and timestamp.

```json
{
  "id": 6731,
  "uid": "string",
  "upload_urls": [
    {
      "part_number": 1,
      "url": "https://s3.amazonaws.com/bucket/file?uploadId=xyz&partNumber=1&X-Amz-Signature=..."
    },
    {
      "part_number": 2,
      "url": "https://s3.amazonaws.com/bucket/file?uploadId=xyz&partNumber=2&X-Amz-Signature=..."
    }
  ],
  "chunk_size": 250,
  "client_code": 200,
  "message": "OK",
  "timestamp": "2026-02-05T10:00:00Z"
}
```

--------------------------------

### Get Recent Administrative Logs - JSON Response Example

Source: https://docs.vagon.io/teams/reference/user-action-logs.md

Example JSON response from the Get Recent Administrative Logs endpoint. Shows the structure of the logs array with fields like id, action_type, user_id, user_email, machine_id, metadata, created_at, updated_at, and top-level fields count, start_date, end_date, note, client_code, message, timestamp.

```json
{
  "logs": [
    {
      "id": 1,
      "action_type": "machine_started",
      "user_id": 123,
      "user_email": "<user@example.com>",
      "machine_id": 456,
      "metadata": {
        "machine_type_id": 1,
        "machine_type_name": "Standard",
        "region": "dublin"
      },
      "created_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-01-01T00:00:00Z"
    }
  ],
  "count": 1,
  "start_date": "2024-01-01T00:00:00Z",
  "end_date": "2024-01-31T23:59:59Z",
  "note": null,
  "client_code": 200,
  "message": "Success",
  "timestamp": "2024-01-31T23:59:59Z"
}
```

--------------------------------

### Success Response Example for POST /usage/retrieve

Source: https://docs.vagon.io/teams/reference/usages

Example 200 response after successfully retrieving usage from a machine.

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

--------------------------------

### Response Example for Get Machine Sessions

Source: https://docs.vagon.io/teams/reference/machines

Example JSON response showing a list of machine sessions with attributes such as start_at, end_at, and duration. The response includes client_code, message, and timestamp fields.

```json
{
    "sessions": [
        {
            "id": "2000",
            "type": "machine_session",
            "attributes": {
                "start_at": "2026-01-23T11:02:41.902Z",
                "end_at": "2026-01-23T11:07:51.115Z",
                "duration": 6
            }
        },
        {
            "id": "1999",
            "type": "machine_session",
            "attributes": {
                "start_at": "2026-01-21T22:57:57.450Z",
                "end_at": "2026-01-21T22:59:58.408Z",
                "duration": 3
            }
        }
    ],
    "client_code": 200,
    "message": "OK",
    "timestamp": "2026-02-04T11:55:58Z"
}
```

--------------------------------

### List Softwares and Base Images Response Example

Source: https://docs.vagon.io/teams/reference/software

Example JSON response showing the structure of the software and base_images arrays. The client_code is 200 for success.

```json
{
  "client_code": 200,
  "message": "OK",
  "timestamp": "2026-02-05T10:10:22Z",
  "software": [
    {
      "id": 1,
      "name": "Blender",
      "size": 1.4
    }
  ],
  "base_images": [
    {
      "id": 4225,
      "name": "Windows 11 Pro",
      "size": 8153,
      "type": "base_image"
    }
  ]
}
```

--------------------------------

### Success Response Example for List Total Account Usage

Source: https://docs.vagon.io/teams/reference/usages.md

Example JSON response returned by the GET /usage endpoint when the request succeeds. Contains usage_minutes, machine_type, client_code, message, and timestamp fields.

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

--------------------------------

### GET /organization-management/v1/usage/machines - Test Response 200

Source: https://docs.vagon.io/teams/reference/usages

Example response from the 'Test it' section for the all machines usage endpoint.

```json
{
  "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
}
```
Tokens:
Raw