Skip to content

Commit

Permalink
Document Prefect Cloud API rate limits (PrefectHQ#8529)
Browse files Browse the repository at this point in the history
Co-authored-by: Bill Palombi <bill@prefect.io>
  • Loading branch information
Terrence Dorsey and billpalombi committed Feb 15, 2023
1 parent 1c7de02 commit b41ca38
Show file tree
Hide file tree
Showing 3 changed files with 50 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/api-ref/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,6 @@ Prefect 2 provides a number of programmatic workflow interfaces. Each API is doc
The Prefect REST API documentation for a local instance run with with `prefect server start` is available at <a href="http://localhost:4200/docs" target="_blank">http://localhost:4200/docs</a> or the `/docs` endpoint of the [`PREFECT_API_URL`](/concepts/settings/#prefect_api_url) you have configured to access the server.

The Prefect REST API documentation for locally run open-source Prefect servers is also available in the [Prefect REST API Reference](/api-ref/rest-api-reference/).

!!! info "Prefect Cloud API rate limits"
The Prefect Cloud API enforces rate limits, restricting the number of requests that a single client can make in a given time period. It ensures that, when you make an API call, you get a response. See [Prefect Cloud API Rate Limits](/ui/rate-limits/) for details.
46 changes: 46 additions & 0 deletions docs/ui/rate-limits.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
description: Prefect Cloud API rate limits.
tags:
- API
- Prefect Cloud
- rate limits
---

# Prefect Cloud API Rate Limits

API rate limits restrict the number of requests that a single client can make in a given time period. They ensure Prefect Cloud's stability, so that when you make an API call, you always get a response.

!!! info "Prefect Cloud rate limits are subject to change"
The following rate limits are in effect currently, but are subject to change. Contact Prefect support at [help@prefect.io](mailto:help@prefect.io) if you have questions about current rate limits.

Prefect Cloud enforces the following rate limits:

- Flow and task creation rate limits
- Log service rate limits
- Service-wide rate limits (applicable to all requests)

## Flow and task creation rate limits

Prefect Cloud limits creation of flow and task runs to:

- 2,000 per minute per account

The Prefect Cloud API will return a `429` response with an appropriate `Retry-After` header if these limits are triggered.

## Log service rate limits

Prefect Cloud limits the number of logs accepted:

- 700 logs per minute for personal accounts
- 10,000 logs per minute for organization accounts

## Service-wide rate limits

Prefect Cloud also enforces service-wide rate limiting for all API routes. This is intended to protect against high request volumes that may degrade service for all users.

Service-wide rate limits include:

- 5,000 requests per minute per API key
- 10,000 requests per minute per client IP

The Prefect Cloud API will return a `429` response if these limits are triggered.
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,7 @@ nav:
- Single Sign-on (SSO): ui/sso.md
- Audit Log: ui/audit-log.md
- Troubleshooting: ui/troubleshooting.md
- Prefect Cloud API Rate Limits: ui/rate-limits.md
- Integrations:
- Collections Catalog: collections/catalog.md
- Using Collections: collections/usage.md
Expand Down

0 comments on commit b41ca38

Please sign in to comment.