Teams API Documentation

Create Computers

POST /organization-management/v1/seats

This endpoint allows you to create computer(s) with selected configurations.

Request Body

{
  "seat_plan_id": 999999, // Contact Vagon team to learn Plan ID options.
  "quantity": 1,
  "software_ids": [],
  "base_image_id": null,
  "permissions": {
    "public_internet_access": true,
    "can_download_from_vagon_workstation": true,
    "analytics_collection_enabled": false,
    "clipboard_enabled": true,
    "screen_recording_enabled": false,
    "input_recording_enabled": false
  }
}

Name

Type

Description

seat_plan_id

integer

Contact Vagon team to learn Plan ID options.

quantity

integer

Number of the computers

software_ids

array of integer

Apps to be preinstalled to computers, check List Preinstall Applications & Images endpoint

base_image_id

integer

Base image selection for computers, check List Preinstall Applications & Images endpoint

permissions.public_internet_access

boolean

Ability to access internet inside computers, default true

permissions.can_download_from_vagon_workstation

boolean

Ability to download files from computers, default true

permissions.analytics_collection_enabled

boolean

Enhanced app usage analytics for computers, default false

permissions.clipboard_enabled

boolean

Copy & paste functionality inside computers, default true

permissions.screen_recording_enabled

boolean

Session recording for computers, default false

permissions.input_recording_enabled

boolean

Mouse & keyboard action logging, default false

Headers

Name

Type

Description

Authorization*

HMAC {key}:{signature}:{nonce}:{timestamp}

Content-Type

application/json

{
    "client_code": 200,
    "timestamp": "2026-01-09T13:30:52Z"
}

List Preinstall Applications & Images

GET /organization-management/v1/software

List of the applications and base images that can be used while creating computers. Selected plan disk storage size should be larger than the total size of the selected images and the base image (golden image).

Only a single base image(golden image) can be selected at the same time.

Headers

Name

Type

Description

Authorization*

HMAC {key}:{signature}:{nonce}:{timestamp}

Content-Type

application/json

{
    "softwares": [
        {
            "id": "33",
            "type": "software",
            "attributes": {
                "id": 33,
                "name": "Blender",
                "size": 1.4
            }
        },
        {
            "id": "36",
            "type": "software",
            "attributes": {
                "id": 36,
                "name": "Cinema 4D",
                "size": 3.0
            }
        },
        {
            "id": "37",
            "type": "software",
            "attributes": {
                "id": 37,
                "name": "CLO3D",
                "size": 3.0
            }
        },
    ],
    "golden_images": [
        {
            "id": "94",
            "type": "golden_image",
            "attributes": {
                "id": 94,
                "name": "Video Production",
                "size": 59.0
            }
        },
        {
            "id": "95",
            "type": "golden_image",
            "attributes": {
                "id": 95,
                "name": "Unreal Engine Bundle",
                "size": 110.0
            }
        }
    ],
    "client_code": 200,
    "timestamp": "2026-01-14T15:01:30Z"
}

List Computers

GET /organization-management/v1/seats

Query Parameters

Name

Value

Description

page*

Page number (optional)

per_page*

100

Items per page (optional)

Headers

Name

Type

Description

Authorization*

HMAC {key}:{signature}:{nonce}:{timestamp}

Content-Type

application/json

{
  "seats": [
    {
      "id": "668",
      "type": "seat",
      "attributes": {
        "status": "active",
        "auto_stop_threshold": 900,
        "file_storage_size": 25,
        "disk_size": 75,
        "network_credit": 10637356601,
        "remaining_usage": 1514,
        "deposited_usage": 0,
        "name": "Computer #668",
        "friendly_status": "off",
        "permissions": {
            "public_internet_access": true,
            "can_download_from_vagon_workstation": true,
            "analytics_collection_enabled": false,
            "clipboard_enabled": true,
            "screen_recording_enabled": false,
            "input_recording_enabled": false
        },
        "user": {
          "id": "c336bb9a-d27e-449b-9a9f-1388c8e327ef",
          "type": "user",
          "attributes": {
            "email": "[email protected]",
            "name": "Jane Doe"
          }
        },
        "machine": {
          "id": "568",
          "type": "machine",
          "attributes": {
            "status": "stopped",
            "name": "Computer #668",
            "region": "dublin",
            "last_session_start_at": "2025-09-30T07:29:37.108Z",
            "machine_type": "Lake"
          }
        }
      }
    }
  ],
  "count": 1,
  "page": 1,
  "next_page": null,
  "client_code": 200,
  "timestamp": "2025-09-30T10:35:16Z"
}

Start Computer

POST /organization-management/v1/machines/{machine-id}/start

Name

Value

Description

machine_id

100

Can be got from List Computers endpoint.

Headers

Name

Type

Description

Authorization*

HMAC {key}:{signature}:{nonce}:{timestamp}

Content-Type

application/json

{
  "client_code": 200,
  "timestamp": "2025-09-30T11:19:55Z"
}

List Available Performance Types

GET /organization-management/v1/machines/{seat-id}/available-machine-types

Path Parameters

Name

Value

Description

seat_id

100

Can be got from List Computers endpoint.

Headers

Name

Type

Description

Authorization*

HMAC {key}:{signature}:{nonce}:{timestamp}

Content-Type

application/json

{
  "client_code": 200,
  "timestamp": "2025-09-30T11:19:55Z"
}

Set Performance Type

POST /organization-management/v1/machines/{machine-id}/machine-type

Path Parameters

Name

Value

Description

machine_type_id*

Parameter options can be got via Get Available Performance Types endpoint. Check link for the performance specs & pricings.

Headers

Name

Type

Description

Authorization*

HMAC {key}:{signature}:{nonce}:{timestamp}

Content-Type

application/json

{
  "client_code": 200,
  "timestamp": "2025-09-30T11:19:55Z"
}

Stop Computer

POST /organization-management/v1/machines/{machine-id}/stop

Path Parameters

Name

Value

Description

machine_id

100

Can be got from List Computers endpoint.

Request Body

{
    "gracefully": true
}

Name

Type

Description

gracefully

boolean

optional, use to prevent any file interruptions.

Headers

Name

Type

Description

Authorization*

HMAC {key}:{signature}:{nonce}:{timestamp}

Content-Type

application/json

{
  "client_code": 200,
  "timestamp": "2025-09-30T11:19:55Z"
}

Get Access Link for Team Computer

POST /organization-management/v1/machines/{machine-id}/access

Path Parameters

Name

Value

Description

machine_id

100

Can be got from List Computers endpoint.

Headers

Name

Type

Description

Authorization*

HMAC {key}:{signature}:{nonce}:{timestamp}

Content-Type

application/json

Request Body

Name

Type

Description

expires_in

integer

minutes

{
  "id": "1",
  "type": "machine_external_access",
  "attributes": {
    "uid": "62ba2d60-5ee2-46c7-aa64-957da90ef117",
    "expires_at": "2024-10-01T04:00:06.307Z",
    "connection_link": "https://app.vagon.io/team/session/62ba2d60-5ee2-46c7-aa64-957da90ef117"
  },
  "client_code": 200,
  "timestamp": "2025-09-30T11:20:06Z"
}

Reset Computer to Initial State

POST /organization-management/v1/machines/{machine-id}/reset

Reset all files and data inside the computer, and revert it to the initial machine image state.

Path Parameters

Name

Value

Description

machine_id

100

Can be got from List Computers endpoint.

Headers

Name

Type

Description

Authorization*

HMAC {key}:{signature}:{nonce}:{timestamp}

Content-Type

application/json

{
    "client_code": 200,
    "timestamp": "2026-01-14T15:13:17Z"
}

List Files & Folders in Computer

POST /organization-management/v1/seats/{seat-id}/list-content

Path Parameters

Name

Value

Description

seat_id

100

Can be got from List Computers endpoint.

Headers

Name

Type

Description

Authorization*

HMAC {key}:{signature}:{nonce}:{timestamp}

Content-Type

application/json

Request Body

{
  "path": "C:\\Users"
}

Name

Type

Description

path

string

"C:\\Users"

{
  "content": [
    {
      "path": "C:\\Sample Folder",
      "name": "Sample Folder",
      "is_directory": true
    },
    {
      "path": "",
      "name": "sample.json",
      "is_directory": false
    }
  ],
  "client_code": 200,
  "timestamp": "2025-10-08T11:31:48Z"
}

List Individual Files & Folders in Vagon Files

GET /organization-management/v1/seats/{seat-id}/files

Query Parameters

Name

Value

Description

parent_id

Parent folder ID (0 for root)

page

Page number (optional)

per_page

Items per page (optional)

Search query (optional)

Path Parameters

Name

Value

Description

seat_id

100

Can be got from List Computers endpoint.

Headers

Name

Type

Description

Authorization*

HMAC {key}:{signature}:{nonce}:{timestamp}

Content-Type

application/json

{
    "files": [
        {
            "id": "1507",
            "type": "file",
            "attributes": {
                "name": "Computer #592 Folder",
                "size": 0,
                "content_type": "directory",
                "uid": "0c642b3a-b7af-44c1-8e73-ab229a277138",
                "region": "dublin",
                "status": "upload_completed",
                "object_type": "root",
                "path": null,
                "parent_id": null,
                "last_modified_date": null,
                "organization_seat_id": 592,
                "file_storage_size": 26843545600,
                "file_storage_usage": 0
            }
        }
    ],
    "current": {
        "id": "1507",
        "type": "file",
        "attributes": {
            "name": "Computer #592 Folder",
            "size": 0,
            "content_type": "directory",
            "uid": "0c642b3a-b7af-44c1-8e73-ab229a277138",
            "region": "dublin",
            "status": "upload_completed",
            "object_type": "root",
            "path": null,
            "parent_id": null,
            "last_modified_date": null,
            "organization_seat_id": 592,
            "file_storage_size": 26843545600,
            "file_storage_usage": 0
        }
    },
    "count": 1,
    "page": 1,
    "next_page": null,
    "client_code": 200,
    "timestamp": "2026-01-09T13:22:41Z"
}

List Shared Files & Folders in Vagon Files

GET /organization-management/v1/files

Query Parameters

Name

Value

Description

parent_id

Parent folder ID (0 for root)

page

Page number (optional)

per_page

Items per page (optional)

Search query (optional)

Headers

Name

Type

Description

Authorization*

HMAC {key}:{signature}:{nonce}:{timestamp}

Content-Type

application/json

{
    "files": [
        {
            "id": "1508",
            "type": "file",
            "attributes": {
                "name": "Teams Shared Folder",
                "size": 0,
                "content_type": "directory",
                "uid": "fd54f58c-5b4c-4dca-95d0-99ed7a7ea2bc",
                "region": "dublin",
                "status": "upload_completed",
                "object_type": "root",
                "path": null,
                "parent_id": null,
                "last_modified_date": null,
                "organization_seat_id": null,
                "file_storage_size": 5368709120,
                "file_storage_usage": 0
            }
        },
        {
            "id": "1507",
            "type": "file",
            "attributes": {
                "name": "Computer #592 Folder",
                "size": 0,
                "content_type": "directory",
                "uid": "0c642b3a-b7af-44c1-8e73-ab229a277138",
                "region": "dublin",
                "status": "upload_completed",
                "object_type": "root",
                "path": null,
                "parent_id": null,
                "last_modified_date": null,
                "organization_seat_id": 592,
                "file_storage_size": 26843545600,
                "file_storage_usage": 0
            }
        }
    ],
    "current": {
        "id": "1508",
        "type": "file",
        "attributes": {
            "name": "Teams Shared Folder",
            "size": 0,
            "content_type": "directory",
            "uid": "fd54f58c-5b4c-4dca-95d0-99ed7a7ea2bc",
            "region": "dublin",
            "status": "upload_completed",
            "object_type": "root",
            "path": null,
            "parent_id": null,
            "last_modified_date": null,
            "organization_seat_id": null,
            "file_storage_size": 5368709120,
            "file_storage_usage": 0
        }
    },
    "count": 2,
    "page": 1,
    "next_page": null,
    "client_code": 200,
    "timestamp": "2026-01-09T13:23:50Z"
}

Generate Download Link for a File

GET /organization-management/v1/files/{file-id}/download

This endpoint only works for the files inside Vagon Files and Shared Vagon Files Folders.

Name

Value

Description

file_id

250

File id of the file would like to download.

Headers

Name

Type

Description

Authorization*

HMAC {key}:{signature}:{nonce}:{timestamp}

Content-Type

application/json

{
    "url": "https://sb-vagon-file-manager-dublin.s3.eu-west-1.amazonaws.com/323/592/1767965315/image%20%2822%29.png?response-content-disposition=attachment%3B%20filename%3Dimage-22.png&x-amz-checksum-mode=ENABLED&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIASKYTEWIYPSXYJGRJ%2F20260109%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20260109T132853Z&X-Amz-Expires=900&X-Amz-Security-Token=IQoJb3JpZ2luX2V",
    "name": "image.png",
    "content_type": "image/png",
    "client_code": 200,
    "timestamp": "2026-01-09T13:28:53Z"
}

Delete File from Vagon Files

DELETE /organization-management/v1/files/{file-id}

This endpoint only works for the files inside Vagon Files and Shared Vagon Files Folders.

Path Parameters

Name

Value

Description

file_id

250

File id of the file would like to download.

Headers

Name

Type

Description

Authorization*

HMAC {key}:{signature}:{nonce}:{timestamp}

Content-Type

application/json

{
    "client_code": 200,
    "timestamp": "2026-01-09T13:30:52Z"
}

Get Administrative Logs

GET /organization-management/v1/user-action-logs

Get administrative and user-level action logs for the last 30 days. This feature is available upon request.

Query Parameters

Name

Type / Value

Description

start_date

2026-01-01T00:00:00Z

(Required) Start date. ISO 8601 format (e.g., 2024-01-01T00:00:00Z)

end_date

2026-01-31T23:59:59Z

(Required) End date. ISO 8601 format. Must be after start_date.

action_type

(Optional) Action type filter. e.g., machine_started, machine_stopped, file_downloaded

user_email

(Optional) Filter by user email

organization_machine_id

(Optional) Filter by machine ID

Headers

Name

Type

Description

Authorization*

HMAC {key}:{signature}:{nonce}:{timestamp}

Content-Type

application/json

{
    "logs": [
        {
            "id": "222",
            "type": "user_action_log",
            "attributes": {
                "id": 222,
                "action_type": "machine_stopped",
                "metadata": {},
                "user_id": null,
                "user_email": null,
                "organization_machine_id": 570,
                "created_at": "2026-01-14T13:54:27.176Z",
                "updated_at": "2026-01-14T13:54:27.176Z"
            }
        },
        {
            "id": "221",
            "type": "user_action_log",
            "attributes": {
                "id": 221,
                "action_type": "machine_started",
                "metadata": {
                    "machine_type_id": 7,
                    "machine_type_name": "Sand"
                },
                "user_id": 525,
                "user_email": "[email protected]",
                "organization_machine_id": 570,
                "created_at": "2026-01-14T13:50:18.256Z",
                "updated_at": "2026-01-14T13:50:18.256Z"
            }
        },
        {
            "id": "220",
            "type": "user_action_log",
            "attributes": {
                "id": 220,
                "action_type": "machine_created",
                "metadata": {
                    "disk_size": 75,
                    "seat_plan_id": 209,
                    "seat_plan_name": "Creative Works Plan",
                    "file_storage_size": 25
                },
                "user_id": 525,
                "user_email": "[email protected]",
                "organization_machine_id": 575,
                "created_at": "2026-01-14T13:49:56.091Z",
                "updated_at": "2026-01-14T13:49:56.091Z"
            }
        },
        {
            "id": "122",
            "type": "user_action_log",
            "attributes": {
                "id": 122,
                "action_type": "initial_connection_initiated",
                "metadata": {
                    "connection_type": "external_access"
                },
                "user_id": null,
                "user_email": null,
                "organization_machine_id": 570,
                "created_at": "2026-01-14T11:06:31.865Z",
                "updated_at": "2026-01-14T11:06:31.865Z"
            }
        },
        {
            "id": "121",
            "type": "user_action_log",
            "attributes": {
                "id": 121,
                "action_type": "machine_external_access_created",
                "metadata": {
                    "expires_at": "2026-01-14T12:06:27Z"
                },
                "user_id": 525,
                "user_email": "[email protected]",
                "organization_machine_id": 570,
                "created_at": "2026-01-14T11:06:27.602Z",
                "updated_at": "2026-01-14T11:06:27.602Z"
            }
        },
    ]
}

Last updated 1 month ago

hashtagCreate Computers

hashtagRequest Body

hashtagHeaders

hashtagList Preinstall Applications & Images

hashtagHeaders

hashtagList Computers

hashtagQuery Parameters

hashtagHeaders

hashtagStart Computer

hashtagHeaders

hashtagList Available Performance Types

hashtagPath Parameters

hashtagHeaders

hashtagSet Performance Type

hashtagPath Parameters

hashtagHeaders

hashtagStop Computer

hashtagPath Parameters

hashtagRequest Body

hashtagHeaders

hashtagGet Access Link for Team Computer

hashtagPath Parameters

hashtagHeaders

hashtagRequest Body

hashtagReset Computer to Initial State

hashtagPath Parameters

hashtagHeaders

hashtagList Files & Folders in Computer

hashtagPath Parameters

hashtagHeaders

hashtagRequest Body

hashtagList Individual Files & Folders in Vagon Files

hashtagQuery Parameters

hashtagPath Parameters

hashtagHeaders

hashtagList Shared Files & Folders in Vagon Files

hashtagQuery Parameters

hashtagHeaders

hashtagGenerate Download Link for a File

hashtagHeaders

hashtagDelete File from Vagon Files

hashtagPath Parameters

hashtagHeaders

hashtagGet Administrative Logs

hashtagQuery Parameters

hashtagHeaders

Create Computers

Request Body

Headers

List Preinstall Applications & Images

Headers

List Computers

Query Parameters

Headers

Start Computer

Headers

List Available Performance Types

Path Parameters

Headers

Set Performance Type

Path Parameters

Headers

Stop Computer

Path Parameters

Request Body

Headers

Get Access Link for Team Computer

Path Parameters

Headers

Request Body

Reset Computer to Initial State

Path Parameters

Headers

List Files & Folders in Computer

Path Parameters

Headers

Request Body

List Individual Files & Folders in Vagon Files

Query Parameters

Path Parameters

Headers

List Shared Files & Folders in Vagon Files

Query Parameters

Headers

Generate Download Link for a File

Headers

Delete File from Vagon Files

Path Parameters

Headers

Get Administrative Logs

Query Parameters

Headers