`bird organization workspaces rate-limits update`

Usage

Esempio di codice

bird organization workspaces rate-limits update <workspace-id> <policy-key> [flags]

Only relevant to organizations with several workspaces, or one left with a single workspace that kept a workspace limit after a deletion, which still applies. Set or replace a workspace's own limit for one rate-limit policy. The limit is not reserved capacity: the organization limit still applies, and a workspace limit can exceed it. Current usage is kept, so a limit below it refuses the workspace's next requests immediately; confirm a lower value with the user before setting it. Fails with a conflict until workspace usage has been measured for long enough; call organization.workspaces.rate_limits.list for the ready time.

Build the request from flags, a JSON WorkspaceRateLimitCapUpdate body via --body-file ("-" reads stdin), or both — a flag overrides the matching body field. Run --example to print a ready-to-edit body, or --dry-run to print the resolved request without sending it.

Procedure

Step 2 of 2 of "Set a workspace rate limit". Previous: bird organization workspaces rate-limits list.

Examples

Esempio di codice

# print the body shape (no credentials needed)
bird organization workspaces rate-limits update --example

# the body it prints:

Esempio di codice

{
  "reason": "Keep the staging workspace from using the shared sending limit.",
  "value": 300
}

Options

Request

Name	Description
`--body-file`	Read the JSON request body from this file; "-" reads stdin
`--example`	Print a complete example request body, then exit
`--dry-run`	Print the resolved request without sending it, then exit
`--idempotency-key`	Deduplication key; a retry with the same key won't act twice

Options

Name	Description
`--value <n>`	Maximum policy units the workspace can use per rolling window. It can exceed the organization limit; both limits apply. (required; or in --body-file)
`--reason`	Why the workspace limit is being set. (required; or in --body-file)
`--expires-at`	When the workspace limit stops applying. Must be in the future. null or omitted means no expiry.
`--response-schema`	Print the fields this command returns, then exit

Name	Description
`bird organization workspaces rate-limits delete`	Remove a workspace rate limit
`bird organization workspaces rate-limits list`	List rate limits for a workspace in the organization

Continua con la documentazione, le guide e gli esempi per questo argomento.

Ottieni un brief di implementazione

Risorse correlate