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

Create a quota scope.

POST/v1/quota_scopes
Authorization
AuthorizationBearer token · headerrequired

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

Header parameters
Idempotency-Keystringrequired

A stable key for this logical request; reuse it when retrying.

min length 1 · max length 128 · matches ^[!-~]+$
Request body
requiredapplication/json
messages_per_dayinteger<int32> | null
providerProviderrequired

The provider behind a connection (connections.provider).

Allowed:smtpgooglemicrosoftsessendgridmailgunnorbelys
recipients_per_dayinteger<int32> | null
scope_keystringrequired

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

window_limitinteger<int32> | null

Units a short window allows; with window_unit and window_seconds, or none of them.

window_secondsinteger<int32> | null
window_unitWindowUnit | null
Show properties
One of:
WindowUnit
string
null
null
Responses
201

The quota scope.

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.

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:manage.

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.

409

The workspace has a scope of this provider and key (conflict).

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

The body 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
Bodyapplication/json
Request
curl -X POST 'https://api.norbelys.com/v1/quota_scopes' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Idempotency-Key: string' \
  -H 'Content-Type: application/json' \
  -d '{
  "messages_per_day": 50000,
  "provider": "ses",
  "scope_key": "123456789012:eu-west-1",
  "window_limit": 14,
  "window_seconds": 1,
  "window_unit": "recipients"
}'
Response
{
  "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"
}