Vagon
HomePricingGo to Dashboard
Vagon Teams
Vagon Teams
  • Introduction
    • Vagon Teams
    • How to Use Vagon Teams
  • Basics
    • Team Members
    • Team Computers
    • Access to Team Computers
    • Team Subscription & Payments
    • Teams Features
  • Features
    • Monthly Computer Plans
    • Teams File Systems
    • Computer Templates
    • Computer Permissions
    • Session Stats
    • Application Usage Monitoring
  • Reference
    • How to Use Teams API
    • Teams API Documentation
Powered by GitBook
On this page
  • List of Team Computers
  • Start Team Computer
  • Stop Team Computer
  • Get Access Link for Team Computer
  1. Reference

Teams API Documentation

List of Team Computers

GET /organization-management/v1/seats

Query Parameters

Name
Type
Description

page*

1

per_page*

100

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": false,
          "can_download_from_vagon_workstation": true,
          "can_download_from_vagon_files": true,
          "can_upload_to_vagon_files": true,
          "analytics_collection_enabled": true,
          "clipboard_enabled": false
        },
        "user": {
          "id": "c336bb9a-d27e-449b-9a9f-1388c8e327ef",
          "type": "user",
          "attributes": {
            "email": "jane@amazingdesign.co",
            "name": "Jane Doe"
          }
        },
        "machine": {
          "id": "568",
          "type": "machine",
          "attributes": {
            "status": "stopped",
            "name": "Computer #668",
            "region": "dublin",
            "last_session_start_at": "2024-09-30T07:29:37.108Z",
            "machine_type": "Lake"
          }
        }
      }
    }
  ],
  "count": 1,
  "page": 1,
  "next_page": null,
  "client_code": 200,
  "timestamp": "2024-09-30T10:35:16Z"
}
{
  "message": "Not Found",
  "client_code": 404,
  "timestamp": "2024-03-27T10:11:43Z"
}

Start Team Computer

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

Query Parameters

Name
Type
Description

page*

1

per_page*

100

Headers

Name
Type
Description

Authorization*

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

Content-Type

application/json

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

Stop Team Computer

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

Query Parameters

Name
Type
Description

page*

1

per_page*

100

Headers

Name
Type
Description

Authorization*

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

Content-Type

application/json

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

Get Access Link for Team Computer

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

Query Parameters

Name
Type
Description

page*

1

per_page*

100

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": "2024-09-30T11:20:06Z"
}
PreviousHow to Use Teams API

Last updated 6 months ago