Noodle Seed
ReferenceCLI reference

noodle policy

Manage policy admission and commercial plans.

Manage policy admission and commercial plans.

Usage

noodle policy status|list|effective|simulate|suspend|resume|usage|apply|show|deny|quota|rate|delete|plan

Subcommands

  • status — Show whether the controls capability is enabled.
    • --service <url> — Control-plane service URL.
    • --auth-token <token> — Control-plane authentication token.
    • --json — Emit one JSON result envelope.
  • list — List policy assignments in scope.
    • --org <slug> — Organization-scoped policy target.
    • --service <url> — Control-plane service URL.
    • --auth-token <token> — Control-plane authentication token.
    • --json — Emit one JSON result envelope.
  • effective — Show the effective policy for a scope.
    • --org <slug> — Organization-scoped policy target.
    • --app <slug> — Application-scoped policy target.
    • --env <slug> — Environment-scoped policy target.
    • --deployment <id> — Deployment-scoped policy target.
    • --operation <name> — Operation-scoped policy target.
    • --service <url> — Control-plane service URL.
    • --auth-token <token> — Control-plane authentication token.
    • --json — Emit one JSON result envelope.
  • simulate — Simulate a candidate assignment against context.
    • --org <slug> — Organization-scoped policy target.
    • --app <slug> — Application-scoped policy target.
    • --env <slug> — Environment-scoped policy target.
    • --deployment <id> — Deployment-scoped policy target.
    • --operation <name> — Operation-scoped policy target.
    • --file <path> — Optional candidate assignment JSON file.
    • --service <url> — Control-plane service URL.
    • --auth-token <token> — Control-plane authentication token.
    • --json — Emit one JSON result envelope.
  • suspend — Suspend all admission in a scope.
    • --org <slug> — Organization-scoped policy target.
    • --app <slug> — Application-scoped policy target.
    • --env <slug> — Environment-scoped policy target.
    • --deployment <id> — Deployment-scoped policy target.
    • --operation <name> — Operation-scoped policy target.
    • --reason <text> — Operator reason recorded with the policy mutation.
    • --expected-version <n> — Expected policy version used for optimistic concurrency. (minimum 0)
    • --idempotency-key <key> — Private replay key for a policy mutation.
    • --service <url> — Control-plane service URL.
    • --auth-token <token> — Control-plane authentication token.
    • --json — Emit one JSON result envelope.
  • resume — Remove a scope suspension.
    • --org <slug> — Organization-scoped policy target.
    • --app <slug> — Application-scoped policy target.
    • --env <slug> — Environment-scoped policy target.
    • --deployment <id> — Deployment-scoped policy target.
    • --operation <name> — Operation-scoped policy target.
    • --reason <text> — Operator reason recorded with the policy mutation.
    • --expected-version <n> — Expected policy version used for optimistic concurrency. (minimum 0)
    • --idempotency-key <key> — Private replay key for a policy mutation.
    • --service <url> — Control-plane service URL.
    • --auth-token <token> — Control-plane authentication token.
    • --json — Emit one JSON result envelope.
  • usage — Show current usage and quota consumption.
    • --org <slug> — Organization-scoped policy target.
    • --service <url> — Control-plane service URL.
    • --auth-token <token> — Control-plane authentication token.
    • --json — Emit one JSON result envelope.
  • apply — Apply a policy assignment read from a file.
    • --org <slug> — Organization-scoped policy target.
    • --file <path> — Policy assignment JSON file. (required)
    • --expected-version <n> — Expected policy version used for optimistic concurrency. (minimum 0)
    • --idempotency-key <key> — Private replay key for a policy mutation.
    • --service <url> — Control-plane service URL.
    • --auth-token <token> — Control-plane authentication token.
    • --json — Emit one JSON result envelope.
  • show <id> — Show one policy assignment.
    • --org <slug> — Organization-scoped policy target.
    • --history — Show the version history for the assignment.
    • --service <url> — Control-plane service URL.
    • --auth-token <token> — Control-plane authentication token.
    • --json — Emit one JSON result envelope.
  • deny protocol|discovery|read|execute — Deny a policy category in a scope.
    • --org <slug> — Organization-scoped policy target.
    • --app <slug> — Application-scoped policy target.
    • --env <slug> — Environment-scoped policy target.
    • --deployment <id> — Deployment-scoped policy target.
    • --operation <name> — Operation-scoped policy target.
    • --reason <text> — Operator reason recorded with the policy mutation.
    • --expected-version <n> — Expected policy version used for optimistic concurrency. (minimum 0)
    • --idempotency-key <key> — Private replay key for a policy mutation.
    • --service <url> — Control-plane service URL.
    • --auth-token <token> — Control-plane authentication token.
    • --json — Emit one JSON result envelope.
  • quota protocol|discovery|read|execute — Set a quota rule.
    • --org <slug> — Organization-scoped policy target.
    • --app <slug> — Application-scoped policy target.
    • --env <slug> — Environment-scoped policy target.
    • --deployment <id> — Deployment-scoped policy target.
    • --operation <name> — Operation-scoped policy target.
    • --limit <n> — Quota or rate limit. (required; minimum 0)
    • --window <duration> — Quota window or token refill duration. (required)
    • --reason <text> — Operator reason recorded with the policy mutation.
    • --expected-version <n> — Expected policy version used for optimistic concurrency. (minimum 0)
    • --idempotency-key <key> — Private replay key for a policy mutation.
    • --service <url> — Control-plane service URL.
    • --auth-token <token> — Control-plane authentication token.
    • --json — Emit one JSON result envelope.
  • rate protocol|discovery|read|execute — Set a token-bucket rate rule.
    • --org <slug> — Organization-scoped policy target.
    • --app <slug> — Application-scoped policy target.
    • --env <slug> — Environment-scoped policy target.
    • --deployment <id> — Deployment-scoped policy target.
    • --operation <name> — Operation-scoped policy target.
    • --limit <n> — Quota or rate limit. (required; minimum 0)
    • --window <duration> — Quota window or token refill duration. (required)
    • --burst <n> — Optional token-bucket burst capacity. (minimum 0)
    • --partition subject|route — Rate-limit partition key.
    • --reason <text> — Operator reason recorded with the policy mutation.
    • --expected-version <n> — Expected policy version used for optimistic concurrency. (minimum 0)
    • --idempotency-key <key> — Private replay key for a policy mutation.
    • --service <url> — Control-plane service URL.
    • --auth-token <token> — Control-plane authentication token.
    • --json — Emit one JSON result envelope.
  • delete <id> — Delete one policy assignment.
    • --org <slug> — Organization-scoped policy target.
    • --reason <text> — Operator reason recorded with the policy mutation.
    • --expected-version <n> — Expected policy version used for optimistic concurrency. (minimum 0)
    • --idempotency-key <key> — Private replay key for a policy mutation.
    • --service <url> — Control-plane service URL.
    • --auth-token <token> — Control-plane authentication token.
    • --json — Emit one JSON result envelope.
  • plan show — Show the organization commercial plan.
    • --org <slug> — Organization-scoped policy target. (required)
    • --service <url> — Control-plane service URL.
    • --auth-token <token> — Control-plane authentication token.
    • --json — Emit one JSON result envelope.
  • plan set free|pro|scale|enterprise — Set the organization commercial plan.
    • --org <slug> — Organization-scoped policy target. (required)
    • --reason <text> — Operator reason recorded with the policy mutation. (required)
    • --external-ref <ref> — External commercial reference associated with the plan. (1-256 characters)
    • --expected-version <n> — Expected policy version used for optimistic concurrency. (minimum 0)
    • --idempotency-key <key> — Private replay key for a policy mutation. (at least 1 characters)
    • --service <url> — Control-plane service URL.
    • --auth-token <token> — Control-plane authentication token.
    • --json — Emit one JSON result envelope.
  • plan suspend — Suspend the organization commercial plan.
    • --org <slug> — Organization-scoped policy target. (required)
    • --reason <text> — Operator reason recorded with the policy mutation. (required)
    • --external-ref <ref> — External commercial reference associated with the plan. (1-256 characters)
    • --expected-version <n> — Expected policy version used for optimistic concurrency. (minimum 0)
    • --idempotency-key <key> — Private replay key for a policy mutation. (at least 1 characters)
    • --service <url> — Control-plane service URL.
    • --auth-token <token> — Control-plane authentication token.
    • --json — Emit one JSON result envelope.

Run noodle policy --help for the latest options and details.

On this page