Webtask

Documentation

HTTP API: Rate limits

You can query and reset rate limits

For customized documentation and ready to run samples, please log in.

Querying rate limits

You can query current values of the container or token rate limits.

To query webtask container rate limits, send an HTTP GET request to /api/limits/container/{webtask_container}. The request must be authenticated with a webtask token that has permissions to operate on the specified webtask container. For example:

curl https://webtask.it.auth0.com/api/limits/container/{webtask_container} -H "Authorization: Bearer {webtask_token}"

To query webtask token rate limits, send an HTTP GET request to /api/limits/token/{webtask_token_jti}. The request must be authenticated with a webtask token that has a matching JTI claim, or an unrestricted, administrative webtask token. For example:

curl https://webtask.it.auth0.com/api/limits/token/{webtask_token_jti} -H "Authorization: Bearer {webtask_token}"

On success, both HTTP APIs return an HTTP 200 response with application/json response body that contains a JSON object specifying the current remaining rate limits per time period. A rate limit value of 0 (zero) means the limit is not tracked.

Resetting rate limits

You can reset container or token rate limits. Only the owner of an unrestricted, administrative token is authorized to reset rate limits.

To reset webtask container rate limits, send an HTTP DELETE request to /api/limits/container/{webtask_container}. The request must be authenticated with an administrative webtask token. For example:

curl https://webtask.it.auth0.com/api/limits/container/{webtask_container} -H "Authorization: Bearer {administrative_webtask_token}"

To delete webtask token rate limits, send an HTTP DELETE request to /api/limits/token/{webtask_token_jti}. The request must be authenticated with an administrative webtask token. For example:

curl https://webtask.it.auth0.com/api/limits/token/{webtask_token_jti} -H "Authorization: Bearer {administrative_webtask_token}"

On success, both HTTP APIs return an HTTP 200 response.