d2l/rate-limits/d2l-rate-limits.yml at main · api-evangelist/d2l · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
specificationVersion: '0.1'
id: d2l-rate-limits
name: D2L Brightspace API Rate Limits
description: >
  The Brightspace API implements a token-bucket credit scheme for rate limiting.
  Each API call consumes credits from the caller's available bucket. When the
  bucket is exhausted, the API returns HTTP 429 Too Many Requests. Credits
  are replenished on a per-minute basis. D2L reserves the right to dynamically
  adjust credit costs per route at its discretion.
url: https://community.d2l.com/brightspace/kb/articles/1195-rate-limiting-and-api-response-headers
limits:
  - name: API Credit Bucket
    description: >
      Each caller is allocated a token bucket of 50,000 API credits per minute.
      Credits replenish continuously up to the bucket maximum. When credits
      are depleted, subsequent calls receive a 429 Too Many Requests response
      until the bucket refills.
    scope: per-application-per-tenant
    bucketSize: 50000
    bucketUnit: credits
    replenishRate: 50000
    replenishPeriod: minute

  - name: Default API Call Cost
    description: >
      Each standard API call costs 10 credits from the caller's bucket.
      Under default conditions, this permits approximately 5,000 API calls
      per minute. D2L may dynamically adjust the credit cost for specific
      API routes without prior notice.
    costPerCall: 10
    unit: credits
    effectiveCallsPerMinute: 5000
    notes: >
      Credit costs per route may vary. D2L reserves the right to adjust
      credit costs dynamically for any API route.

responseHeaders:
  - name: X-D2L-API-Credits-Consumed
    description: Number of credits consumed by the just-completed API call.
  - name: X-D2L-API-Credits-Remaining
    description: Number of credits remaining in the caller's bucket after this call.
  - name: Retry-After
    description: >
      When a 429 response is returned, this header indicates how many seconds
      to wait before retrying.

errorCodes:
  - code: 429
    message: Too Many Requests
    description: >
      Returned when the caller's credit bucket has been exhausted. Wait for
      the bucket to replenish before making additional API calls. Check the
      Retry-After response header for guidance on when to retry.