Site Admin - Rate Limiting

Welcome to Our New API Docs! This is the new home for all things API (previously at Canvas LMS REST API Documentation).

Site Admin - Rate Limiting

What it Does

Rate Limiting - add

Allows user to create new rate limit settings for external tools and integrations.

Rate Limiting - edit

Allows user to modify existing rate limit settings, including changing rate limit values and comments.

Rate Limiting - delete

Allows user to remove rate limit settings for external tools and integrations.

Rate Limiting - view

Allows user to view all rate limit settings and their details.

Additional Considerations

Site Admin Only

This permission is only available to Site Admin users and requires the api_rate_limits feature flag to be enabled.

External Tools

Rate limiting settings apply to external tools and integrations that use OAuth client configurations with throttling parameters.

UTID Integration

This feature supports UTID (Unified Tool ID) based rate limiting for partner tools and products.

---

This documentation is generated directly from the Canvas LMS source code, available on Github.