Update Rate limit
Update Rate limit
PATCH
https://api.ocamba.com/v2/ocamba/developer/app/{id}/rate-limits/{rate_limit_id}/developer/app/{id}/rate-limits/{rate_limit_id}
Updates a specific Rate limit by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
Name
Descriptionidstringrequired
Unique identifier for the object defined as a path parameter.Example: 12345
Name
Descriptiondescriptionstring
Rate limit descriptionExample: Default rate limits
metadatarate-limit-metadata
Define limitsRate limit metadata
Name
Descriptiondefaultobject
Name
Descriptiondaynumber (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
Descriptionmethodobject
Name
Descriptiondaynumber (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
Response examples
>
204 - No Content
204 - No Content response
application/json
>
400 - Bad Request
400 - Bad Request response
application/json
>
500 - Internal Server Error
500 - Internal Server Error response
application/json
Request examples
Copied
200
{
"name": "B",
"metadata": {
"default": {
"second": 10,
"minute": 150,
"parallel": 10,
"hour": 250,
"day": 0
}
}
}
Response examples
Copied
400
{
"code": 400,
"title": "Bad request.",
"message": "The request body is not valid.",
"trace_id": "99a84211-f73d-4ff8-acdf-eb3e06bb9d62"
}
{
"code": 500,
"title": "Internal server error.",
"message": "Internal server error."
}
Note
1
1 At least one of the updatable fields should be sent via HTTP body in order to change the current state of the rate limit.
2 Updatable fields are name and metadata.
Tip
1
1 If you don't know the Rate limit 'id', list the rate limits to find it.