Create approval rule

Create a new approval rule for the organization.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Human-readable rule name.

Length1 <= length

ruleType*string

Type of rule: table name match, column name match, or cost threshold.

Value in"table" | "column" | "cost"

pattern*string

Pattern to match. Table/column name for table/column rules. Unused for cost rules.

threshold?|

Cost threshold. Required for cost rules, ignored for table/column rules.

enabled?boolean

Whether the rule is active. Defaults to true.

Response Body

`application/json`

curl -X POST "http://localhost:3001/api/v1/admin/approval/rules" \  -H "Content-Type: application/json" \  -d '{    "name": "Require approval for PII tables",    "ruleType": "table",    "pattern": "users"  }'

{
  "rule": {
    "id": "string",
    "orgId": "string",
    "name": "string",
    "ruleType": "table",
    "pattern": "string",
    "threshold": 0,
    "enabled": true,
    "createdAt": "string",
    "updatedAt": "string"
  }
}

{
  "error": "string",
  "message": "string",
  "requestId": "string"
}

{
  "property1": null,
  "property2": null
}

{
  "property1": null,
  "property2": null
}

{
  "error": "string",
  "message": "string",
  "requestId": "string"
}

{
  "error": "string",
  "message": "string",
  "requestId": "string"
}

Create approval rule

Request Body

Response Body

201application/json

400application/json

401application/json

403application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`