Sign in

v2

latestOpenAPI 3.0.0raw.githubusercontent.com2026-06-027801.5 MB
Quality-of-Service on Demand v0.10.1

Get QoS session information

Querying for QoS session resource information details

get/qod/v0/sessions/{sessionId}

Path parameters

sessionIdstring uuid required

Session ID in UUID format

Session ID that was obtained from the createSession operation

Headers

x-rapidapi-hoststring required
Example:network-as-code.p-eu.rapidapi.com

The API's Host value as defined in the RapidAPI Hub.

Response

qosProfilestring string required

A unique name for identifying a specific QoS profile. This may follow different formats depending on the service providers implementation. Some options addresses:

  • A UUID style string
  • Support for predefined profiles QOS_S, QOS_M, QOS_L, and QOS_E
  • A searchable descriptive name
sessionIdstring uuid required

Session ID in UUID format

durationinteger required
startedAtinteger required

Timestamp of session start in seconds since Unix epoch

expiresAtinteger required

Timestamp of session expiration if the session was not deleted, in seconds since Unix epoch

qosStatus'REQUESTED' | 'AVAILABLE' | 'UNAVAILABLE' required

The current status of the requested QoS session. The status can be one of the following:

  • REQUESTED - QoS has been requested by creating a session
  • AVAILABLE - The requested QoS has been provided by the network
  • UNAVAILABLE - The requested QoS cannot be provided by the network due to some reason