Skip to content

Does what changing the service name and GB limit in the panel does. Spends nothing; needs proxies:write.

If you send both, the traffic limit is applied first, then the name. meta.applied lists what was applied; on an error, details.applied shows which one was already applied.

If the limit is removed and the balance is enough, a service stopped by the limit resumes on its own. meta.resumed is true only if the service was actually stopped. A service suspended by an administrator does not resume this way.

If the gateway cannot apply the new limit right away, the limit is still saved, but 503 service_unavailable and details.sync_failed are returned; send the same request again.

Authorization

Authorizationstringrequired

Sent as Bearer <token>. This endpoint needs the proxies:write (Proxy settings) scope; a token without it gets 403.

Path parameters

idstringrequired

The service ID. Take it from the id field of the GET /orders response.

Body

namestring

Service name (up to 100 characters). null = clear. The < and > characters and control characters such as tab and line break are not allowed.

gb_limitnumber

Residential/Mobile: traffic limit (GB): 0 or 0.001-100000. null or 0 = no fixed limit.

Response

200
application/json
dataobject
metaobject