Create a rate limit bucket

POST
/v1/risk/limit_buckets

At most 100 buckets per environment; names are unique in it.

Authorization

bearerAuth
headerAuthorizationBearer <token>

A secret API key from the dashboard: coss_live_… for production environments, coss_test_… for sandbox environments.

Header Parameters

Coss-Version?"2026-10-10"

The API version (a date) to use for this request. Defaults to your organization's version, pinned to the latest one when it first used the API and upgraded from the dashboard. The SDK always sends the version it was built for.

Value in"2026-10-10"

Request Body

application/json
  1. body
name*string

Unique in the environment; can't be changed.

Match^[a-z0-9][a-z0-9._-]{0,63}$
limit*integer

Tokens added per period_seconds.

Range1 <= value <= 1000000
period_seconds*integer

1 second to 1 day.

Range1 <= value <= 86400
burst?integer

How many requests a key can make at once. Defaults to limit.

Range1 <= value <= 1000000
on_failure?string

The answer while COSS can't count. Defaults to allow.

Value in"allow""deny"

Response Body

The new bucket.

application/json
  1. response
object*"risk_limit_bucket"
Value in"risk_limit_bucket"
id*string
name*string

What POST /v1/risk/limits names it by.

limit*integer

Tokens added per period_seconds.

period_seconds*integer
burst*integer

The bucket's size: how many requests a key can make at once.

on_failure*string

The answer while COSS can't count (its store is unavailable): allow (fail open) or deny.

Value in"allow""deny"
created_at*string
Formatdate-time
updated_at*string
Formatdate-time
import { Coss } from "coss";const coss = new Coss({  apiKey: process.env.COSS_API_KEY,  baseUrl: "https://api.coss.com",});const { data, error } = await coss.risk.limitBuckets.create({  name: "password_reset",  limit: 5,  period_seconds: 3600,});
{  "object": "risk_limit_bucket",  "id": "rsklb_01k7c8m4q2f3e9v6t5r1n0p8yz",  "name": "password_reset",  "limit": 5,  "period_seconds": 3600,  "burst": 5,  "on_failure": "allow",  "created_at": "2026-01-15T09:30:00.000Z",  "updated_at": "2026-01-15T09:30:00.000Z"}