Reqeust limitation

[yuan ming]

Hi Atlassian Team,

I have a question about the 'X-RateLimit-Limit','X-RateLimit-Resource' and 'X-RateLimit-NearLimit' for response header.

I can't get the Rate limit response headers when I reqeust any rest api, I want to know how can I get it when I request rest api?

[Ben · Accepted solution]

Hi @yuan ming 

May I know if you're using access token for authentication? Only access token authentication supports the 'X-RateLimit-Limit','X-RateLimit-Resource' and 'X-RateLimit-NearLimit' response headers.

I'd also like to know which endpoint you're querying, as not all endpoints support these headers.

Cheers!

- Ben (Bitbucket Cloud Support)

[yuan ming]

Hi Ben,
I use the Oauth cusotmer to reqeust 'https://api.bitbucket.org/2.0/repositories/{workspace}/{repo_slug}/commit/{commit}/comments/{comment_id}' this restapi, if not, can you tell me which restapi support these response headers?

[Ben]

Hi @yuan ming 

OAuth Consumer will not work either, you need to use either Repository, Workspace or Project Access Tokens for this header to appear:

• https://support.atlassian.com/bitbucket-cloud/docs/access-tokens/#:~:text=bitbucket.org.-,Workspace%2C%20project%2C%20and%20repository%20access%20tokens,-Access%20tokens%20can

The /2.0/repositories endpoint you've specified does support that header, so should be visible when you use it (provided you're using RAT/WAT/PAT for authentication)

Cheers!

- Ben (Bitbucket Cloud Support)

[yuan ming]

Hi @Ben ,

For your answer is useful for me, and I have another question, How about I use Oauth Customer token to simulate user token or Atlassian API token？ can I use these token to get these request headers?

[Ben]

Hi @yuan ming 

Unfortunately, this will not work. Only repository/project/workspace access tokens return this header.

Cheers!

- Ben (Bitbucket Cloud Support)

[yuan ming]

got it, Thank you Ben

[Aron Gombas _Midori_]

@yuan ming 

The rate limit response headers you mentioned (X-RateLimit-Limit, X-RateLimit-Resource, X-RateLimit-NearLimit) are not necessarily returned on every single API response!

They typically start appearing when your usage is approaching the rate limit threshold. If your request volume is low, you may not see them at all in the response.

[yuan ming]

but when I request volume is approaching or exceeding the rate limit threshold and still can't see these response headers

[yuan ming]

I continued to request APIs and log request headers until I encountered an error of 429 too many requests, but I did not find these few request headers

[yuan ming]

these are all my response headers