User Guides Developer Guides API Reference Changelog
⌘ K

View Rate limit

View Rate limit

GET https://api.ocamba.com/v2/ocamba/developer/app/{id}/rate-limits/{rate_limit_id}/developer/app/{id}/rate-limits/{rate_limit_id}

Retrieves the details of an Rate limits if a valid identifier was provided.

path Parameters
Arrow
Name
Description
idstringrequired
Unique identifier for the object defined as a path parameter.


Example: 12345
query Parameters
Arrow
Name
Description
fieldsstring
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /v2/ocamba/RESOURCE_NAME?fields=id,name

See "Tips" for the list of filterable parameters.


Example: fields=field1,field2,field3
viewstring
Ocamba API returns full representation of the resource using the “view=full” query parameter. If not specified, the default view will be used.

Note that the “fields” parameter has precedence over the “view” parameter.


Example: view=full/default

Response examples

>
200 - OK
200 - OK response
application/json
Name
Description
items[ rate-limit ]
An array of all items.
Rate limit
Name
Description
app_idstring
A unique app identifier generated by the Ocamba platform.


Example: 1001
create_timestring
Timezone: GMT.


Example: 2021-10-29 12:47:00
descriptionstring
Rate limit description


Example: Default rate limits
idstring
A unique identifier generated by the Ocamba platform.


Example: 101
metadatarate-limit-metadata
Define limits
Rate limit metadata
Name
Description
defaultobject

Name
Description
daynumber (integer)
Maximum number of requests allowed per day.


Example: 10
hournumber (integer)
Maximum number of requests allowed per hour.


Example: 10
minutenumber (integer)
Maximum number of requests allowed per minute.


Example: 10
parallelnumber (integer)
Maximum number of concurrent requests allowed at the same time.


Example: 10
secondnumber (integer)
Maximum number of requests allowed per second.


Example: 10
resource-nameobject

Name
Description
methodobject

Name
Description
daynumber (integer)
Maximum number of requests allowed per day.


Example: 1000
hournumber (integer)
Maximum number of requests allowed per hour.


Example: 350
minutenumber (integer)
Maximum number of requests allowed per minute.


Example: 55
parallelnumber (integer)
Maximum number of concurrent requests allowed at the same time.


Example: 22
secondnumber (integer)
Maximum number of requests allowed per second.


Example: 10
namestring
Rate limit name.


Example: C
update_timestring
Timezone: GMT.


Example: 2021-10-30 14:27:26
totalinteger
A total number of items.


Example: 1
>
500 - Internal Server Error
500 - Internal Server Error response
application/json
Name
Description
codeinteger
Http response status code.


Example: 500
messagestring
The human readable message that describes how to deal with error.


Example: Internal server error.
titlestring
The error title.


Example: Internal server error.
Response examples
Copied
Arrow
200 Arrow
  • 200
  • 500
{
  "total": 1,
  "items": [
    {
      "id": "101",
      "app_id": "1001",
      "name": "C",
      "metadata": {
        "default": {
          "second": 10,
          "minute": 10,
          "hour": 10,
          "day": 10,
          "parallel": 10
        },
        "resource-name": {
          "method": {
            "second": 10,
            "minute": 55,
            "hour": 350,
            "day": 1000,
            "parallel": 22
          }
        }
      },
      "description": "Default rate limits",
      "create_time": "2021-10-29 12:47:00",
      "update_time": "2021-10-30 14:27:26"
    }
  ]
}

{
  "code": 500,
  "title": "Internal server error.",
  "message": "Internal server error."
}
Tip
1
1 If you don't know the rate limit id, list the rate limits to find it.
2