Sign in

v2

latestOpenAPI 3.0.0raw.githubusercontent.com2026-06-027801.5 MB
Quality-of-Service on Demand v1.0.0

Creates a new session

Create QoS Session to manage latency/throughput priorities

If the qosStatus in the API response is "AVAILABLE" and a notification callback is provided the API consumer will receive in addition to the response a QOS_STATUS_CHANGED event notification with qosStatus as AVAILABLE.

If the qosStatus in the API response is REQUESTED, the client will receive either

  • a QOS_STATUS_CHANGED event notification with qosStatus as AVAILABLE after the network notifies that it has created the requested session, or
  • a QOS_STATUS_CHANGED event notification with qosStatus as UNAVAILABLE and statusInfo as NETWORK_TERMINATED after the network notifies that it has failed to provide the requested session.

A QOS_STATUS_CHANGED event notification with qosStatus as UNAVAILABLE will also be send if the network terminates the session before the requested duration expired

NOTE: in case of a QOS_STATUS_CHANGED event with qosStatus as UNAVAILABLE and statusInfo as NETWORK_TERMINATED the resources of the QoS session are not directly released, but will get deleted automatically at earliest 360 seconds after the event. This behavior allows clients which are not receiving notification events but are polling to get the session information with the qosStatus UNAVAILABLE (the statusInfo parameter is not included in the current version but will be adding to SessionInfo in an upcoming release). Before a client can attempt to create a new QoD session for the same device and flow period they must release the session resources with an explicit delete operation if not yet automatically deleted.

post/quality-on-demand/v1/sessions

Headers

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

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

Request body

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
sinkstring uri

The address to which events about all status changes of the session (e.g. session termination) shall be delivered using the selected protocol.

durationinteger

Session duration in seconds. Maximal value of 24 hours is used if not set. After session is expired the, client will receive a QOS_STATUS_CHANGED event with

  • qosStatus as UNAVAILABLE, and,
  • statusInfo as DURATION_EXPIRED. See notification callback.

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
sinkstring uri

The address to which events about all status changes of the session (e.g. session termination) shall be delivered using the selected protocol.

sessionIdstring uuid required

Session ID in UUID format

durationinteger required
startedAtstring date-time

Date and time when the QoS status became "AVAILABLE". Not to be returned when qosStatus is "REQUESTED". Format must follow RFC 3339 and must indicate time zone (UTC or local).

expiresAtstring date-time

Date and time of the QoS session expiration. Format must follow RFC 3339 and must indicate time zone (UTC or local).

  • When qosStatus is "AVAILABLE", it is the limit time when the session is scheduled to finnish, if not terminated by other means.
  • When qosStatus is "UNAVAILABLE", it is the time when the session was terminated.
  • Not to be returned when qosStatus is "REQUESTED". When the session is extended, the value is the new expiration time of the session.
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
statusInfo'DURATION_EXPIRED' | 'NETWORK_TERMINATED' | 'DELETE_REQUESTED'

Reason for the new qosStatus. Currently statusInfo is only applicable when qosStatus is 'UNAVAILABLE'.

  • DURATION_EXPIRED - Session terminated due to requested duration expired
  • NETWORK_TERMINATED - Network terminated the session before the requested duration expired
  • DELETE_REQUESTED- User requested the deletion of the session before the requested duration expired