Skip to content
Norbelys
Esc
↑↓navigate↵open⌘Jpreview

List the workspace's quota scopes, newest first by default.

GET/v1/quota_scopes
Authorization
AuthorizationBearer token · headerrequired

An API key (nb_live_…, nb_test_…), a workspace token (nbs_…) or a CLI token (nbc_…).

Query parameters
limitinteger<int64>

Scopes per page, 1 to 100 (default 20).

cursorstring

The next_cursor of the previous page.

orderstring

desc (default) or asc.

includestring

total_count adds an exact count up to 10,000.

providerstring

Only scopes of this provider.

Responses
200

A page of quota scopes.

dataobject[]required

At most limit rows, 100 at most.

max items 100
Show properties
Array of object
created_atTimestamprequired
idId_QuotaScoperequired
matches ^qsc_[0-9a-f]{32}$
messages_per_dayinteger<int32> | null

Messages a rolling day across its connections.

paused_detailstring | null

What the provider said.

paused_untilTimestamp | null
Show properties
One of:
Timestamp
string<date-time>
null
null
providerstringrequired

The provider of the account; new values may be added.

recipients_per_dayinteger<int32> | null

Recipients a rolling day across its connections.

scope_keystringrequired

The account: a project id, a tenant id, account:region, a relay host.

updated_atTimestamprequired
versioninteger<int64>required

The scope's version, also the response's ETag: updated_at in microseconds since the Unix epoch. An update sent with it in If-Match applies only to this version. A pause the provider imposes moves it too.

webhookWebhookObject | null
Show properties
One of:
WebhookObject
idId_ProviderWebhookrequired
matches ^pwh_[0-9a-f]{32}$
key_setbooleanrequired

Whether its verification material is set: SendGrid's verification key, Mailgun's signing key, the SNS topic for SES; callbacks are refused until it is.

urlstringrequired

The URL to configure at the provider (an SES connection's quota scope names the one its account subscribes).

null
null
window_limitinteger<int32> | null

Units a short window allows (SES: its maximum send rate).

window_secondsinteger<int32> | null

The short window's length, in seconds.

window_unitstring | null

What one submission is charged: requests, recipients or units.

metaMetarequired

The page metadata.

Show properties
has_morebooleanrequired
next_cursorstring | null
total_countinteger<int64> | null

With ?include=total_count: exact up to 10,000.

total_count_cappedboolean | null

With ?include=total_count: true when the count stopped at 10,000.

400

The cursor is not valid for this request.

codestringrequired

The code from the closed registry; programs branch on it, never on the text. New codes may be added.

detailstringrequired

What went wrong, for a person; never an internal cause.

errorsFieldError[]

With validation_failed only: every invalid field.

Show properties
Array of FieldError
codestringrequired

What is wrong (required, range, length, format, invalid, …).

detailstringrequired

A safe, human-readable explanation.

pointerstringrequired

RFC 6901 pointer into the body, or ?name for a query parameter.

instancestringrequired

The request's path.

request_idstringrequired

The request's id, also in X-Request-Id: what support needs to find the request.

retry_afterinteger<int64> | null

With 429 and 503: the seconds to wait, as in Retry-After.

min 0
statusinteger<int32>required

The HTTP status.

min 0
titlestringrequired

Fixed per code.

typestringrequired

https://docs.norbelys.com/errors/<code>, a page that explains the code.

401

No valid credential.

codestringrequired

The code from the closed registry; programs branch on it, never on the text. New codes may be added.

detailstringrequired

What went wrong, for a person; never an internal cause.

errorsFieldError[]

With validation_failed only: every invalid field.

Show properties
Array of FieldError
codestringrequired

What is wrong (required, range, length, format, invalid, …).

detailstringrequired

A safe, human-readable explanation.

pointerstringrequired

RFC 6901 pointer into the body, or ?name for a query parameter.

instancestringrequired

The request's path.

request_idstringrequired

The request's id, also in X-Request-Id: what support needs to find the request.

retry_afterinteger<int64> | null

With 429 and 503: the seconds to wait, as in Retry-After.

min 0
statusinteger<int32>required

The HTTP status.

min 0
titlestringrequired

Fixed per code.

typestringrequired

https://docs.norbelys.com/errors/<code>, a page that explains the code.

403

The credential lacks connections:read.

codestringrequired

The code from the closed registry; programs branch on it, never on the text. New codes may be added.

detailstringrequired

What went wrong, for a person; never an internal cause.

errorsFieldError[]

With validation_failed only: every invalid field.

Show properties
Array of FieldError
codestringrequired

What is wrong (required, range, length, format, invalid, …).

detailstringrequired

A safe, human-readable explanation.

pointerstringrequired

RFC 6901 pointer into the body, or ?name for a query parameter.

instancestringrequired

The request's path.

request_idstringrequired

The request's id, also in X-Request-Id: what support needs to find the request.

retry_afterinteger<int64> | null

With 429 and 503: the seconds to wait, as in Retry-After.

min 0
statusinteger<int32>required

The HTTP status.

min 0
titlestringrequired

Fixed per code.

typestringrequired

https://docs.norbelys.com/errors/<code>, a page that explains the code.

422

A parameter is invalid.

codestringrequired

The code from the closed registry; programs branch on it, never on the text. New codes may be added.

detailstringrequired

What went wrong, for a person; never an internal cause.

errorsFieldError[]

With validation_failed only: every invalid field.

Show properties
Array of FieldError
codestringrequired

What is wrong (required, range, length, format, invalid, …).

detailstringrequired

A safe, human-readable explanation.

pointerstringrequired

RFC 6901 pointer into the body, or ?name for a query parameter.

instancestringrequired

The request's path.

request_idstringrequired

The request's id, also in X-Request-Id: what support needs to find the request.

retry_afterinteger<int64> | null

With 429 and 503: the seconds to wait, as in Retry-After.

min 0
statusinteger<int32>required

The HTTP status.

min 0
titlestringrequired

Fixed per code.

typestringrequired

https://docs.norbelys.com/errors/<code>, a page that explains the code.

Try it
Server
Authorization
Parameters
Request
curl -X GET 'https://api.norbelys.com/v1/quota_scopes' \
  -H 'Authorization: Bearer YOUR_TOKEN'
Response
{
  "data": [
    {
      "created_at": "2019-08-24T14:15:22Z",
      "id": "qsc_0190f8a2b4c87a10b6d2e4f6a8c0e2f4",
      "messages_per_day": 0,
      "paused_detail": "string",
      "paused_until": "2019-08-24T14:15:22Z",
      "provider": "string",
      "recipients_per_day": 0,
      "scope_key": "string",
      "updated_at": "2019-08-24T14:15:22Z",
      "version": 0,
      "webhook": {
        "id": "pwh_0190f8a2b4c87a10b6d2e4f6a8c0e2f4",
        "key_set": true,
        "url": "string"
      },
      "window_limit": 0,
      "window_seconds": 0,
      "window_unit": "string"
    }
  ],
  "meta": {
    "has_more": true,
    "next_cursor": "string",
    "total_count": 0,
    "total_count_capped": true
  }
}