List existing rules

curl --request GET \
  --url https://api.dataspike.io/api/v3/transmon/rules/list/{event_type} \
  --header 'ds-api-token: <api-key>'

{
  "builtin_rules": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<unknown>",
      "status": "<unknown>",
      "event_type": "<unknown>",
      "rank": "<unknown>",
      "expression": "<unknown>",
      "causes": "<unknown>",
      "created_at": "2023-07-18T15:32:13Z",
      "updated_at": "2023-07-18T15:32:13Z",
      "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "action": "<unknown>"
    }
  ],
  "custom_rules": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<unknown>",
      "status": "<unknown>",
      "event_type": "<unknown>",
      "rank": "<unknown>",
      "expression": "<unknown>",
      "causes": "<unknown>",
      "created_at": "2023-07-18T15:32:13Z",
      "updated_at": "2023-07-18T15:32:13Z",
      "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "action": "<unknown>"
    }
  ]
}

GET

api

transmon

rules

list

{event_type}

List existing rules

curl --request GET \
  --url https://api.dataspike.io/api/v3/transmon/rules/list/{event_type} \
  --header 'ds-api-token: <api-key>'

{
  "builtin_rules": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<unknown>",
      "status": "<unknown>",
      "event_type": "<unknown>",
      "rank": "<unknown>",
      "expression": "<unknown>",
      "causes": "<unknown>",
      "created_at": "2023-07-18T15:32:13Z",
      "updated_at": "2023-07-18T15:32:13Z",
      "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "action": "<unknown>"
    }
  ],
  "custom_rules": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<unknown>",
      "status": "<unknown>",
      "event_type": "<unknown>",
      "rank": "<unknown>",
      "expression": "<unknown>",
      "causes": "<unknown>",
      "created_at": "2023-07-18T15:32:13Z",
      "updated_at": "2023-07-18T15:32:13Z",
      "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "action": "<unknown>"
    }
  ]
}

Authorizations

ds-api-token

string

header

required

Path Parameters

Response

List of rules

builtin_rules

object[]

required

Show child attributes

builtin_rules.id

string<uuid>

required

The rule id

builtin_rules.name

any

required

builtin_rules.status

any

required

builtin_rules.event_type

any

required

builtin_rules.rank

any

required

builtin_rules.expression

any

required

builtin_rules.causes

any

required

builtin_rules.created_at

string<datetime>

required

When balance has been created

Example:

"2023-07-18T15:32:13Z"

builtin_rules.updated_at

string<datetime>

required

When balance has been updated

Example:

"2023-07-18T15:32:13Z"

builtin_rules.organization_id

string<uuid>

The organization owns the rule of null for shared rule example

builtin_rules.action

any

custom_rules

object[]

required

Show child attributes

custom_rules.id

string<uuid>

required

The rule id

custom_rules.name

any

required

custom_rules.status

any

required

custom_rules.event_type

any

required

custom_rules.rank

any

required

custom_rules.expression

any

required

custom_rules.causes

any

required

custom_rules.created_at

string<datetime>

required

When balance has been created

Example:

"2023-07-18T15:32:13Z"

custom_rules.updated_at

string<datetime>

required

When balance has been updated

Example:

"2023-07-18T15:32:13Z"

custom_rules.organization_id

string<uuid>

The organization owns the rule of null for shared rule example

custom_rules.action

any

Delete existing rule Initiate Non-Document Verification

⌘I

API documentation

Authorizations

Path Parameters

Response