API reference
Every endpoint of the Limitry API, by area. Each one shows the same call in TypeScript, Python, the CLI and curl, with its fields.
- To try a call in your browser, use the interactive reference.
- For tools that read OpenAPI, the document is at https://api.limitry.com/v1/openapi.json.
- Before your first call, see Authentication and Errors and rate limits.
Checks
Section titled “Checks”- Check whether a subject may act:
limitry.checks.create()
Reservations
Section titled “Reservations”- Commit a reservation:
limitry.reservations.commit() - Extend a reservation:
limitry.reservations.extend() - Release a reservation:
limitry.reservations.release()
Limits
Section titled “Limits”- Archive a limit:
limitry.limits.archive() - Create a limit:
limitry.limits.create() - Get a limit:
limitry.limits.get() - Add credits to a balance:
limitry.limits.grants.create() - List a balance’s grants:
limitry.limits.grants.list() - List limits:
limitry.limits.list() - Restore an archived limit:
limitry.limits.restore() - Sync limits from a list:
limitry.limits.sync() - Change a limit:
limitry.limits.update()
Subjects
Section titled “Subjects”- Get a subject:
limitry.subjects.get() - Reset a subject’s limits:
limitry.subjects.reset() - Set a subject’s anchor:
limitry.subjects.update()
- Get a limit’s usage over time:
limitry.usage.query() - Get where a subject stands:
limitry.usage.standing() - List who is using a limit now:
limitry.usage.subjects()
Workspace
Section titled “Workspace”- Get the current workspace:
limitry.workspace.get() - List pending invitations:
limitry.workspace.invitations.list() - List workspace members:
limitry.workspace.members.list() - List teams:
limitry.workspace.teams.list() - Get your plan’s usage this period:
limitry.workspace.usage()
Webhooks
Section titled “Webhooks”- List event types:
limitry.workspace.eventTypes.list() - List an endpoint’s deliveries:
limitry.workspace.webhookDeliveries.list() - Redeliver an event:
limitry.workspace.webhookDeliveries.redeliver() - Add a webhook endpoint:
limitry.workspace.webhookEndpoints.create() - Remove a webhook endpoint:
limitry.workspace.webhookEndpoints.delete() - Re-enable a webhook endpoint:
limitry.workspace.webhookEndpoints.enable() - Get a webhook endpoint:
limitry.workspace.webhookEndpoints.get() - List webhook endpoints:
limitry.workspace.webhookEndpoints.list() - Send a test event:
limitry.workspace.webhookEndpoints.test()
Approvals
Section titled “Approvals”- List the actions you can ask approval for:
limitry.workspace.approvalActions.list() - Ask a person to approve an action:
limitry.workspace.approvalRequests.create() - Check an approval request:
limitry.workspace.approvalRequests.get() - Redeem an approved request:
limitry.workspace.approvalRequests.redeem()
Audit events
Section titled “Audit events”- List workspace audit events:
limitry.workspace.auditEvents.list()
Personal access tokens
Section titled “Personal access tokens”- Get the current user:
limitry.user.me() - Revoke the token making this request:
limitry.user.revokeToken()