Перейти до вмісту
NimbusNexus

QoS policies

A QoS policy bundles a set of network-quality rules — bandwidth caps, DSCP packet marking, and minimum-bandwidth reservations — and applies them to one or more network ports. The most common rule is a bandwidth limit (cap throughput on a port at 100 Mbps, say, to prevent a runaway workload from saturating shared uplinks).

DSCP marking adds priority hints to packets leaving a port — useful when downstream networks (your office, a partner network) honor DSCP for traffic shaping. Minimum-bandwidth reservations guarantee a port gets at least N Mbps even under contention — useful for telephony and real-time workloads.

For typical workloads, the default (no QoS policy) is fine. Apply policies when you have a specific shaping requirement — usually compliance, latency-sensitive workloads, or noisy-neighbor mitigation.

What's next

Reference

POST/api/v1/bandwidth/resize

Bandwidth Resize

Resizes the bandwidth limit on a port, floating IP, or router gateway and recreates the billing order.

Request body

JSON body required.

Responses

  • 200Successful Response
  • 400Bad Request
  • 401Unauthorized
  • 403Forbidden
  • 404Not Found
  • 409Conflict
  • 422Validation error
  • 429Too Many Requests
  • 500Internal Server Error

https://api.nimbusnexus.net/api/v1/bandwidth/resize

GET/api/v1/qos/

List Qos Policies

admin_domain, admin_project are only for admin

Parameters

NameInRequiredDescription
admin_domainqueryno—
admin_projectqueryno—
projectqueryno—
descriptionqueryno—
project_idqueryno—
sharedqueryno—
is_defaultqueryno—
namequeryno—
idqueryno—

Responses

  • 200Successful Response
  • 400Bad Request
  • 401Unauthorized
  • 403Forbidden
  • 422Validation error
  • 429Too Many Requests
  • 500Internal Server Error

https://api.nimbusnexus.net/api/v1/qos/

POST/api/v1/qos/

Create Qos Policy

admin_domain, admin_project are only for admin

Request body

JSON body required.

Responses

  • 201Successful Response
  • 400Bad Request
  • 401Unauthorized
  • 403Forbidden
  • 404Not Found
  • 422Validation error
  • 429Too Many Requests
  • 500Internal Server Error

https://api.nimbusnexus.net/api/v1/qos/

GET/api/v1/qos/{policy_id}

Get Qos Policy

Returns the details of a single QoS policy by ID.

Parameters

NameInRequiredDescription
policy_idpathyes—

Responses

  • 200Successful Response
  • 400Bad Request
  • 401Unauthorized
  • 403Forbidden
  • 404Not Found
  • 422Validation error
  • 429Too Many Requests
  • 500Internal Server Error

https://api.nimbusnexus.net/api/v1/qos/{policy_id}

PUT/api/v1/qos/{policy_id}

Update Qos Policy

admin_domain, admin_project are only for admin

Parameters

NameInRequiredDescription
policy_idpathyes—

Request body

JSON body required.

Responses

  • 200Successful Response
  • 400Bad Request
  • 401Unauthorized
  • 403Forbidden
  • 404Not Found
  • 422Validation error
  • 429Too Many Requests
  • 500Internal Server Error

https://api.nimbusnexus.net/api/v1/qos/{policy_id}

DELETE/api/v1/qos/{policy_id}

Delete Qos Policy

Deletes a QoS policy by ID.

Parameters

NameInRequiredDescription
policy_idpathyes—

Responses

  • 204Successful Response
  • 400Bad Request
  • 401Unauthorized
  • 403Forbidden
  • 404Not Found
  • 409Conflict
  • 422Validation error
  • 429Too Many Requests
  • 500Internal Server Error

https://api.nimbusnexus.net/api/v1/qos/{policy_id}

GET/api/v1/qos_bandwidth_limit/{policy_id}/bandwidth_limit_rules

List Qos Bandwidth Limits

Lists the bandwidth limit rules attached to a QoS policy.

Parameters

NameInRequiredDescription
policy_idpathyes—
admin_domainqueryno—
admin_projectqueryno—
max_kbpsqueryno—
max_burst_kbpsqueryno—
directionqueryno—
idqueryno—
sort_keyqueryno—
sort_dirqueryno—

Responses

  • 200Successful Response
  • 400Bad Request
  • 401Unauthorized
  • 403Forbidden
  • 404Not Found
  • 422Validation error
  • 429Too Many Requests
  • 500Internal Server Error

https://api.nimbusnexus.net/api/v1/qos_bandwidth_limit/{policy_id}/bandwidth_limit_rules

POST/api/v1/qos_bandwidth_limit/{policy_id}/bandwidth_limit_rules

Create Qos Bandwidth Limit

Creates a bandwidth limit rule on a QoS policy.

Parameters

NameInRequiredDescription
policy_idpathyes—

Request body

JSON body required.

Responses

  • 201Successful Response
  • 400Bad Request
  • 401Unauthorized
  • 403Forbidden
  • 404Not Found
  • 409Conflict
  • 422Validation error
  • 429Too Many Requests
  • 500Internal Server Error

https://api.nimbusnexus.net/api/v1/qos_bandwidth_limit/{policy_id}/bandwidth_limit_rules

PUT/api/v1/qos_bandwidth_limit/{policy_id}/bandwidth_limit_rules/{rule_id}

Update Qos Bandwidth Limit

Updates an existing bandwidth limit rule on a QoS policy.

Parameters

NameInRequiredDescription
policy_idpathyes—
rule_idpathyes—

Request body

JSON body required.

Responses

  • 200Successful Response
  • 400Bad Request
  • 401Unauthorized
  • 403Forbidden
  • 404Not Found
  • 409Conflict
  • 422Validation error
  • 429Too Many Requests
  • 500Internal Server Error

https://api.nimbusnexus.net/api/v1/qos_bandwidth_limit/{policy_id}/bandwidth_limit_rules/{rule_id}

GET/api/v1/qos_dscp_rules/{policy_id}/dscp_marking_rules

List Qos Dscp Marking Rules

Lists the DSCP marking rules attached to a QoS policy.

Parameters

NameInRequiredDescription
policy_idpathyes—
admin_domainqueryno—
admin_projectqueryno—
dscp_markqueryno—
idqueryno—
sort_keyqueryno—
sort_dirqueryno—

Responses

  • 200Successful Response
  • 400Bad Request
  • 401Unauthorized
  • 403Forbidden
  • 404Not Found
  • 422Validation error
  • 429Too Many Requests
  • 500Internal Server Error

https://api.nimbusnexus.net/api/v1/qos_dscp_rules/{policy_id}/dscp_marking_rules

POST/api/v1/qos_dscp_rules/{policy_id}/dscp_marking_rules

Create Qos Dscp Marking Rules

Creates a DSCP marking rule on a QoS policy.

Parameters

NameInRequiredDescription
policy_idpathyes—

Request body

JSON body required.

Responses

  • 201Successful Response
  • 400Bad Request
  • 401Unauthorized
  • 403Forbidden
  • 404Not Found
  • 409Conflict
  • 422Validation error
  • 429Too Many Requests
  • 500Internal Server Error

https://api.nimbusnexus.net/api/v1/qos_dscp_rules/{policy_id}/dscp_marking_rules

PUT/api/v1/qos_dscp_rules/{policy_id}/dscp_marking_rules/{dscp_rule_id}

Update Qos Dscp Marking Rules

Updates an existing DSCP marking rule on a QoS policy.

Parameters

NameInRequiredDescription
policy_idpathyes—
dscp_rule_idpathyes—

Request body

JSON body required.

Responses

  • 200Successful Response
  • 400Bad Request
  • 401Unauthorized
  • 403Forbidden
  • 404Not Found
  • 409Conflict
  • 422Validation error
  • 429Too Many Requests
  • 500Internal Server Error

https://api.nimbusnexus.net/api/v1/qos_dscp_rules/{policy_id}/dscp_marking_rules/{dscp_rule_id}

DELETE/api/v1/qos_dscp_rules/{policy_id}/dscp_marking_rules/{dscp_rule_id}

Delete Qos Dscp Marking Rules

Deletes a DSCP marking rule from a QoS policy.

Parameters

NameInRequiredDescription
policy_idpathyes—
dscp_rule_idpathyes—

Responses

  • 204Successful Response
  • 400Bad Request
  • 401Unauthorized
  • 403Forbidden
  • 404Not Found
  • 409Conflict
  • 422Validation Error
  • 429Too Many Requests
  • 500Internal Server Error

https://api.nimbusnexus.net/api/v1/qos_dscp_rules/{policy_id}/dscp_marking_rules/{dscp_rule_id}

GET/api/v1/qos_minimum_bandwidth_rule/{policy_id}/minimum_bandwidth_rules

List Qos Minimum Bandwidth Rules

Lists the minimum bandwidth rules attached to a QoS policy.

Parameters

NameInRequiredDescription
policy_idpathyes—
admin_domainqueryno—
admin_projectqueryno—
directionqueryno—
min_kbpsqueryno—
idqueryno—
sort_keyqueryno—
sort_dirqueryno—

Responses

  • 200Successful Response
  • 400Bad Request
  • 401Unauthorized
  • 403Forbidden
  • 404Not Found
  • 422Validation error
  • 429Too Many Requests
  • 500Internal Server Error

https://api.nimbusnexus.net/api/v1/qos_minimum_bandwidth_rule/{policy_id}/minimum_bandwidth_rules

POST/api/v1/qos_minimum_bandwidth_rule/{policy_id}/minimum_bandwidth_rules

Create Qos Minimum Bandwidth Rule

Creates a minimum bandwidth rule on a QoS policy.

Parameters

NameInRequiredDescription
policy_idpathyes—

Request body

JSON body required.

Responses

  • 201Successful Response
  • 400Bad Request
  • 401Unauthorized
  • 403Forbidden
  • 404Not Found
  • 409Conflict
  • 422Validation error
  • 429Too Many Requests
  • 500Internal Server Error

https://api.nimbusnexus.net/api/v1/qos_minimum_bandwidth_rule/{policy_id}/minimum_bandwidth_rules

PUT/api/v1/qos_minimum_bandwidth_rule/{policy_id}/minimum_bandwidth_rules/{rule_id}

Update Qos Minimum Bandwidth Rule

Updates an existing minimum bandwidth rule on a QoS policy.

Parameters

NameInRequiredDescription
policy_idpathyes—
rule_idpathyes—

Request body

JSON body required.

Responses

  • 200Successful Response
  • 400Bad Request
  • 401Unauthorized
  • 403Forbidden
  • 404Not Found
  • 409Conflict
  • 422Validation error
  • 429Too Many Requests
  • 500Internal Server Error

https://api.nimbusnexus.net/api/v1/qos_minimum_bandwidth_rule/{policy_id}/minimum_bandwidth_rules/{rule_id}

DELETE/api/v1/qos_minimum_bandwidth_rule/{policy_id}/minimum_bandwidth_rules/{rule_id}

Delete Qos Minimum Bandwidth Rule

Deletes a minimum bandwidth rule from a QoS policy.

Parameters

NameInRequiredDescription
policy_idpathyes—
rule_idpathyes—

Responses

  • 204Successful Response
  • 400Bad Request
  • 401Unauthorized
  • 403Forbidden
  • 404Not Found
  • 409Conflict
  • 422Validation Error
  • 429Too Many Requests
  • 500Internal Server Error

https://api.nimbusnexus.net/api/v1/qos_minimum_bandwidth_rule/{policy_id}/minimum_bandwidth_rules/{rule_id}

Need to make a real call? Try these endpoints in the live Swagger UI →