Storage Rule

The storage rule resource.

Basehttps://rest.carbon.ms/storageRule

GET/storageRule

List storage rules

Retrieve a paginated list of storage rules. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GEThttps://rest.carbon.ms/storageRule

curl --request GET \
  --url 'https://rest.carbon.ms/storageRule?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'

Response

[
  {
    "id": "abc123def456",
    "companyId": "xyz789",
    "name": "Example",
    "message": "string",
    "severity": "string",
    "conditionAst": "string",
    "surfaces": [],
    "active": true
  }
]

GET/storageRule

Retrieve a storage rule

Fetch a single storage rule by filtering on `id`.

Query parameters

idstring

Match on the storage rule's `id`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/storageRule

curl --request GET \
  --url 'https://rest.carbon.ms/storageRule?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "name": "Example",
  "message": "string",
  "severity": "string",
  "conditionAst": "string",
  "surfaces": [],
  "active": true
}

POST/storageRule

Create a storage rule

Create a new storage rule.

Body parameters

companyIdstringrequired

References company.id

namestringrequired

descriptionstring

messagestringrequired

severitystringrequired

conditionAstobjectrequired

surfacestransactionSurfacerequired

activebooleanrequired

customFieldsobject

targetTypestorageRuleTargetTyperequired

appliesToAllbooleanrequired

filteredItemTypesarrayrequired

filteredItemGroupIdsarrayrequired

filteredItemMatchAllbooleanrequired

POSThttps://rest.carbon.ms/storageRule

curl --request POST \
  --url https://rest.carbon.ms/storageRule \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"companyId":"xyz789","name":"Example","description":"string","message":"string","severity":"string","conditionAst":"string","surfaces":[],"active":true,"targetType":"string","appliesToAll":true,"filteredItemTypes":[],"filteredItemGroupIds":[],"filteredItemMatchAll":true}'

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "name": "Example",
  "message": "string",
  "severity": "string",
  "conditionAst": "string",
  "surfaces": [],
  "active": true
}

PATCH/storageRule

Update a storage rule

Update an existing storage rule, matched on `id`.

Body parameters

companyIdstringrequired

References company.id

namestringrequired

descriptionstring

messagestringrequired

severitystringrequired

conditionAstobjectrequired

surfacestransactionSurfacerequired

activebooleanrequired

customFieldsobject

targetTypestorageRuleTargetTyperequired

appliesToAllbooleanrequired

filteredItemTypesarrayrequired

filteredItemGroupIdsarrayrequired

filteredItemMatchAllbooleanrequired

PATCHhttps://rest.carbon.ms/storageRule

curl --request PATCH \
  --url 'https://rest.carbon.ms/storageRule?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"companyId":"xyz789"}'

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "name": "Example",
  "message": "string",
  "severity": "string",
  "conditionAst": "string",
  "surfaces": [],
  "active": true
}

DELETE/storageRule

Delete a storage rule

Delete a storage rule, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the storage rule to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/storageRule

curl --request DELETE \
  --url 'https://rest.carbon.ms/storageRule?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

204 No Content