Get your current rate limit status

This call returns information about your current rate limit. This is the number of API calls you can make in five minutes. This call also returns information about your current instance limit.

Request

https://api.sbgenomics.com/v2/rate_limit
https://eu-api.sbgenomics.com/v2/rate_limit

👍

Note that making this API call does not count against your rate limit.

Example request

GET /v2/rate_limit HTTP/1.1
Host: api.sbgenomics.com
X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74
curl -s -H "X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7" -H "content-type: application/json" -X GET "https://api.sbgenomics.com/v2/rate_limit"
from sevenbridges import Api

api = Api(url='https://api.sbgenomics.com/v2',
          token='3259c50e1ac5426ea8f1273259740f74')

# send GET request to SB API
rate_limit = api.rate_limit.get()

print(rate_limit.rate.remaining, rate_limit.rate.reset)
print(rate_limit.instance_limit.remaining, rate_limit.instance_limit.limit)

Header Fields

Name

Description

X-SBG-Auth-Token
required

Your Seven Bridges Platform authentication token.

Query parameters

Name

Data type

Description

fields

string

Selector specifying a subset of fields to include in the response.

Response

See a list of Seven Bridges Platform-specific response codes that may be contained in the body of the response.

Example response body

{
  "rate": {
    "limit": 1000,
    "remaining": 1000,
    "reset":  1489700093
  },
 "instance_limit" : {
    "limit": -1,
    "remaining": 9223372036854775807
 }
}
Interpreting the response body:

For rate:

  • limit indicates how many requests can be made in five minutes.
  • remaining indicates how many requests remain.
  • reset indicates the time in Unix epochs when the request rate limit will be reset.

For instance_limit:

  • limit indicates the total number of instances available to the user. For the first few months, instance limits are unlimited. This is indicated by a special limit of -1. Correspondingly, the remaining value is high.
  • remaining indicates the number of the instances that are available at the moment. For the first few months, instance limits are unlimited. This is indicated by a high remaining value. Correspondingly, the limit is set to a special value of -1.