How to Use Teams API

Get Teams API Keys

Before starting API integration for Vagon Teams, you must have at least one Team Computer. API Key and Secret Key will be accessible on the Settings tab on your dashboard.

• API Public Key

• Secret Key

Authentication

The client must be authenticated by using API Public and Secret keys with HMAC authentication, by using the SHA256 algorithm.

• Every API call requires to be authenticated via the Authorization header.

• Header format Authorization: HMAC {key}:{signature}:{nonce}:{timestamp}

• Signature payload is calculated as payload = "{api key}{request method}{request path}{timestamp}{nonce}{request body}"

• request path shouldn't include the base API endpoint. For example; if you send a GET request to https://api.vagon.io/organization-management/v1/machines the request path should be organization-management/v1/machines

• Request body should be an empty string for GET requests.

• Signature is calculated as the signature = HMAC(SHA256, payload, api secret)

• Signature should be in HexaDecimal format

• The nonce is a random string value and the timestamp is the current UTC timestamp (milliseconds).

Machine Status List

friendly_status	description
off	Machine is stopped
creating	Machine is started at the first time
turning_on	Machine is turning on
ready	Machine is running, and ready to connect
turning_off	Machine is turning off, to be stopped
resizing_disk	Machine disk size is expanding
installing	Machine image/template assignment post process is in progress.
region_migration	Machine region migration is in progress
warming_up	Machine is getting ready at the first run
graceful_stopping	Machine is turning off gracefully, system is ensuring files are transferred before stopping.