Traffic Pool

Get Global Traffic Pool Size

This endpoint retrieves the total size of the global traffic pool for a specified KVM VPS.
The api_host parameter, obtained from the "Create AUTH-session" response,
is dynamically set in the URL.

post/kvm/v2/get/pool_traffic

Request

Base URL
https://api_host.edisglobal.com
Auth
none required
TypeScript
https://skmtc.dev/edisglobal/apis/edis-global-management-api/docs/kvm/v2/get/pool_traffic/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body application/x-www-form-urlencoded

signaturestring

The session signature obtained from the "Create AUTH-session" call.

kvm_idstring

The unique identifier of the KVM VPS.

valid_untilstring

The expiration timestamp for the session, as obtained from the "Create AUTH-session" call.
Ensure that the session is valid and has not expired.

Example request

{
  "signature": "session_signature_12345",
  "kvm_id": "kvm_123456_789012",
  "valid_until": "1737476000"
}

Response

Global traffic pool size retrieved successfully.

statusstring

The status of the operation.

msgstring

Message indicating the status of the traffic pool.

available_pool_trafficstring

The available traffic pool size in GB.

Example response

{
  "status": "success",
  "msg": "traffic_pool exists",
  "available_pool_traffic": "5000"
}

Changes

No recorded changes to this operation across all 1 revision of this API.