Create Rate limit

Create Rate limit

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

Creates a new Rate limit object


Name
Description
descriptionstring
Rate limit description


Example: Default rate limits

idstring
A unique identifier generated by the Ocamba platform.


Example: 101

metadatarate-limit-metadatarequired
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

namestringrequired
Rate limit name.


Example: C

Response examples

>
201 - Created
201 - Created response
application/json
>
400 - Bad Request
400 - Bad Request response
application/json
>
500 - Internal Server Error
500 - Internal Server Error response
application/json
200 Arrow
{       
  "name": "Test",
  "metadata": {            
    "default": {
      "second": 10,
      "minute": 150,
      "hour": 250,
      "parallel": 10
    },
    "campaigns": {
      "GET": {
          "second": 30,
          "minute": 250,
          "parallel": 20
      },
      "POST": {
          "second": 30,
          "minute": 250,
          "parallel": 20
      }
    }               
  },
  "description": "Example description"
}
201 Arrow
{
  "id": "1001",
  "app_id": "1001",
  "name": "Test",
  "metadata": {            
    "default": {
      "second": 10,
      "minute": 150,
      "hour": 250,
      "parallel": 10
    }
  },
  "campaigns": {
    "GET": {
        "second": 30,
        "minute": 250,
        "parallel": 20
    },
    "POST": {
        "second": 30,
        "minute": 250,
        "parallel": 20
    }
  },  
  "description": "Example description",
  "create_time": "2025-04-28 07:08:09",
  "update_time": "2025-04-28 12:30:46"             
}
{
  "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 Mandatory fields are name and metadata.
2