Skip to main content

Quotas

SDK methods for the Quotas module, accessed via soat.quotas. See the Quotas module docs for permissions and data model, and each method's REST page for the full request/response schema.

soat.quotas.listQuotas()​

List quotas

  • Method: GET
  • Path: /api/v1/quotas
await soat.quotas.listQuotas({
  query: { /* + optional */ },
});

→ Request & response schema

soat.quotas.createQuota()​

Create a quota

  • Method: POST
  • Path: /api/v1/quotas
await soat.quotas.createQuota({
  body: { scope, metric, window, limit, /* + optional */ },
});

→ Request & response schema

soat.quotas.getQuota()​

Get a quota

  • Method: GET
  • Path: /api/v1/quotas/{quota_id}
await soat.quotas.getQuota({
  path: { quota_id },
});

→ Request & response schema

soat.quotas.updateQuota()​

Update a quota

  • Method: PATCH
  • Path: /api/v1/quotas/{quota_id}
await soat.quotas.updateQuota({
  path: { quota_id },
  body: { /* + optional */ },
});

→ Request & response schema

soat.quotas.deleteQuota()​

Delete a quota

  • Method: DELETE
  • Path: /api/v1/quotas/{quota_id}
await soat.quotas.deleteQuota({
  path: { quota_id },
});

→ Request & response schema