Validation Rules API

Base URL: https://validation-rules.sls.epilot.io
API Docs: https://docs.epilot.io/api/validation-rules

Quick Start

# List available operations
epilot validation-rules

# Call an operation
epilot validation-rules getValidationRules

Common Flags

Flag	Description
`-p key=value`	Set a named parameter
`-d '{...}'`	Request body JSON
`-H 'Key: Value'`	Custom header
`-t, --token <token>`	Bearer token for authentication
`--profile <name>`	Use a named profile
`-s, --server <url>`	Override server base URL
`-i, --include`	Include response headers in output
`--json`	Output raw JSON (no formatting)
`-v, --verbose`	Verbose output (show request details)
`--jsonata <expr>`	JSONata expression to transform response
`--definition <file>`	Override OpenAPI spec file/URL
`--guided`	Prompt for all parameters interactively
`--no-interactive`	Disable interactive prompts

Operations

Validation Rules

getValidationRules — Gets all validation rules by organization Id
createValidationRule — Creates a new validation rule
getValidationRuleById — Retrieves a specific validation rule by its ID
updateValidationRule — Updates an existing validation rule partially by ID
deleteValidationRule — Deletes a validation rule by ID
addUsedByReference — Adds a single reference to the usedBy array of a validation rule
removeUsedByReference — Removes a specific reference from the usedBy array of a validation rule

`getValidationRules`

Gets all validation rules by organization Id

GET /v1/validation-rules

Sample Call

epilot validation-rules getValidationRules

With JSONata filter:

epilot validation-rules getValidationRules --jsonata 'results[0]'

Sample Response

{
  "results": [
    {
      "title": "string",
      "placeholder": "string",
      "used_by": [
        {
          "type": "journey",
          "schema_slug": "string",
          "source_id": "string"
        }
      ],
      "rule": {
        "type": "regex",
        "conditions": {
          "all": [
            {
              "fact": "inputValue",
              "operator": "regexMatch",
              "value": "string",
              "params": {
                "errorMessage": "string"
              }
            },
            {
              "all": [
                {
                  "fact": "inputValue",
                  "operator": "regexMatch",
                  "value": "string",
                  "params": {
                    "errorMessage": "string"
                  }
                }
              ]
            }
          ]
        }
      },
      "_schema_version": "string",
      "_id": "string",
      "_organization_id": "string",
      "created_at": "string",
      "updated_at": "string",
      "created_by": "string",
      "updated_by": "string"
    }
  ]
}

`createValidationRule`

Creates a new validation rule

POST /v1/validation-rules

Request Body

Sample Call

epilot validation-rules createValidationRule

With request body:

epilot validation-rules createValidationRule \
  -d '{
  "title": "string",
  "placeholder": "string",
  "used_by": [
    {
      "type": "journey",
      "schema_slug": "string",
      "source_id": "string"
    }
  ],
  "rule": {
    "type": "regex",
    "conditions": {
      "all": [
        {
          "fact": "inputValue",
          "operator": "regexMatch",
          "value": "string",
          "params": {
            "errorMessage": "string"
          }
        },
        {
          "all": [
            {
              "fact": "inputValue",
              "operator": "regexMatch",
              "value": "string",
              "params": {
                "errorMessage": "string"
              }
            }
          ]
        }
      ]
    }
  }
}'

Using stdin pipe:

cat body.json | epilot validation-rules createValidationRule

With JSONata filter:

epilot validation-rules createValidationRule --jsonata '$'

Sample Response

{
  "title": "string",
  "placeholder": "string",
  "used_by": [
    {
      "type": "journey",
      "schema_slug": "string",
      "source_id": "string"
    }
  ],
  "rule": {
    "type": "regex",
    "conditions": {
      "all": [
        {
          "fact": "inputValue",
          "operator": "regexMatch",
          "value": "string",
          "params": {
            "errorMessage": "string"
          }
        },
        {
          "all": [
            {
              "fact": "inputValue",
              "operator": "regexMatch",
              "value": "string",
              "params": {
                "errorMessage": "string"
              }
            }
          ]
        }
      ]
    }
  },
  "_schema_version": "string",
  "_id": "string",
  "_organization_id": "string",
  "created_at": "string",
  "updated_at": "string",
  "created_by": "string",
  "updated_by": "string"
}

`getValidationRuleById`

Retrieves a specific validation rule by its ID

GET /v1/validation-rules/{ruleId}

Parameters

Name	In	Type	Required	Description
`ruleId`	path	string	Yes	The unique identifier of the validation rule to retrieve.

Sample Call

epilot validation-rules getValidationRuleById \
  -p ruleId=123e4567-e89b-12d3-a456-426614174000

Using positional args for path parameters:

epilot validation-rules getValidationRuleById 123e4567-e89b-12d3-a456-426614174000

With JSONata filter:

epilot validation-rules getValidationRuleById -p ruleId=123e4567-e89b-12d3-a456-426614174000 --jsonata '$'

Sample Response

{
  "title": "string",
  "placeholder": "string",
  "used_by": [
    {
      "type": "journey",
      "schema_slug": "string",
      "source_id": "string"
    }
  ],
  "rule": {
    "type": "regex",
    "conditions": {
      "all": [
        {
          "fact": "inputValue",
          "operator": "regexMatch",
          "value": "string",
          "params": {
            "errorMessage": "string"
          }
        },
        {
          "all": [
            {
              "fact": "inputValue",
              "operator": "regexMatch",
              "value": "string",
              "params": {
                "errorMessage": "string"
              }
            }
          ]
        }
      ]
    }
  },
  "_schema_version": "string",
  "_id": "string",
  "_organization_id": "string",
  "created_at": "string",
  "updated_at": "string",
  "created_by": "string",
  "updated_by": "string"
}

`updateValidationRule`

Updates an existing validation rule partially by ID

PATCH /v1/validation-rules/{ruleId}

Parameters

Name	In	Type	Required	Description
`ruleId`	path	string	Yes	The unique identifier of the validation rule to update.

Request Body

Sample Call

epilot validation-rules updateValidationRule \
  -p ruleId=123e4567-e89b-12d3-a456-426614174000

With request body:

epilot validation-rules updateValidationRule \
  -p ruleId=123e4567-e89b-12d3-a456-426614174000 \
  -d '{
  "title": "string",
  "placeholder": "string",
  "used_by": [
    {
      "type": "journey",
      "schema_slug": "string",
      "source_id": "string"
    }
  ],
  "rule": {
    "type": "regex",
    "conditions": {
      "all": [
        {
          "fact": "inputValue",
          "operator": "regexMatch",
          "value": "string",
          "params": {
            "errorMessage": "string"
          }
        },
        {
          "all": [
            {
              "fact": "inputValue",
              "operator": "regexMatch",
              "value": "string",
              "params": {
                "errorMessage": "string"
              }
            }
          ]
        }
      ]
    }
  }
}'

Using positional args for path parameters:

epilot validation-rules updateValidationRule 123e4567-e89b-12d3-a456-426614174000

Using stdin pipe:

cat body.json | epilot validation-rules updateValidationRule -p ruleId=123e4567-e89b-12d3-a456-426614174000

With JSONata filter:

epilot validation-rules updateValidationRule -p ruleId=123e4567-e89b-12d3-a456-426614174000 --jsonata '$'

Sample Response

{
  "title": "string",
  "placeholder": "string",
  "used_by": [
    {
      "type": "journey",
      "schema_slug": "string",
      "source_id": "string"
    }
  ],
  "rule": {
    "type": "regex",
    "conditions": {
      "all": [
        {
          "fact": "inputValue",
          "operator": "regexMatch",
          "value": "string",
          "params": {
            "errorMessage": "string"
          }
        },
        {
          "all": [
            {
              "fact": "inputValue",
              "operator": "regexMatch",
              "value": "string",
              "params": {
                "errorMessage": "string"
              }
            }
          ]
        }
      ]
    }
  },
  "_schema_version": "string",
  "_id": "string",
  "_organization_id": "string",
  "created_at": "string",
  "updated_at": "string",
  "created_by": "string",
  "updated_by": "string"
}

`deleteValidationRule`

Deletes a validation rule by ID

DELETE /v1/validation-rules/{ruleId}

Parameters

Name	In	Type	Required	Description
`ruleId`	path	string	Yes	The unique identifier of the validation rule to delete.

Sample Call

epilot validation-rules deleteValidationRule \
  -p ruleId=123e4567-e89b-12d3-a456-426614174000

Using positional args for path parameters:

epilot validation-rules deleteValidationRule 123e4567-e89b-12d3-a456-426614174000

With JSONata filter:

epilot validation-rules deleteValidationRule -p ruleId=123e4567-e89b-12d3-a456-426614174000 --jsonata '$'

`addUsedByReference`

Adds a single reference to the usedBy array of a validation rule

POST /v1/validation-rules/{ruleId}/used-by

Parameters

Name	In	Type	Required	Description
`ruleId`	path	string	Yes	The unique identifier of the validation rule to update.

Request Body

Sample Call

epilot validation-rules addUsedByReference \
  -p ruleId=123e4567-e89b-12d3-a456-426614174000 \
  -d '{"type":"journey","schema_slug":"string","source_id":"string"}'

Using positional args for path parameters:

epilot validation-rules addUsedByReference 123e4567-e89b-12d3-a456-426614174000

Using stdin pipe:

cat body.json | epilot validation-rules addUsedByReference -p ruleId=123e4567-e89b-12d3-a456-426614174000

With JSONata filter:

epilot validation-rules addUsedByReference -p ruleId=123e4567-e89b-12d3-a456-426614174000 --jsonata '$'

Sample Response

{
  "title": "string",
  "placeholder": "string",
  "used_by": [
    {
      "type": "journey",
      "schema_slug": "string",
      "source_id": "string"
    }
  ],
  "rule": {
    "type": "regex",
    "conditions": {
      "all": [
        {
          "fact": "inputValue",
          "operator": "regexMatch",
          "value": "string",
          "params": {
            "errorMessage": "string"
          }
        },
        {
          "all": [
            {
              "fact": "inputValue",
              "operator": "regexMatch",
              "value": "string",
              "params": {
                "errorMessage": "string"
              }
            }
          ]
        }
      ]
    }
  },
  "_schema_version": "string",
  "_id": "string",
  "_organization_id": "string",
  "created_at": "string",
  "updated_at": "string",
  "created_by": "string",
  "updated_by": "string"
}

`removeUsedByReference`

Removes a specific reference from the usedBy array of a validation rule

DELETE /v1/validation-rules/{ruleId}/used-by

Parameters

Name	In	Type	Required	Description
`ruleId`	path	string	Yes	The unique identifier of the validation rule to update.

Request Body

Sample Call

epilot validation-rules removeUsedByReference \
  -p ruleId=123e4567-e89b-12d3-a456-426614174000 \
  -d '{"type":"journey","schema_slug":"string","source_id":"string"}'

Using positional args for path parameters:

epilot validation-rules removeUsedByReference 123e4567-e89b-12d3-a456-426614174000

Using stdin pipe:

cat body.json | epilot validation-rules removeUsedByReference -p ruleId=123e4567-e89b-12d3-a456-426614174000

With JSONata filter:

epilot validation-rules removeUsedByReference -p ruleId=123e4567-e89b-12d3-a456-426614174000 --jsonata '$'

Sample Response

{
  "title": "string",
  "placeholder": "string",
  "used_by": [
    {
      "type": "journey",
      "schema_slug": "string",
      "source_id": "string"
    }
  ],
  "rule": {
    "type": "regex",
    "conditions": {
      "all": [
        {
          "fact": "inputValue",
          "operator": "regexMatch",
          "value": "string",
          "params": {
            "errorMessage": "string"
          }
        },
        {
          "all": [
            {
              "fact": "inputValue",
              "operator": "regexMatch",
              "value": "string",
              "params": {
                "errorMessage": "string"
              }
            }
          ]
        }
      ]
    }
  },
  "_schema_version": "string",
  "_id": "string",
  "_organization_id": "string",
  "created_at": "string",
  "updated_at": "string",
  "created_by": "string",
  "updated_by": "string"
}

Validation Rules API

Quick Start​

Common Flags​

Operations​

getValidationRules​

createValidationRule​

getValidationRuleById​

updateValidationRule​

deleteValidationRule​

addUsedByReference​

removeUsedByReference​

Quick Start

Common Flags

Operations

`getValidationRules`

`createValidationRule`

`getValidationRuleById`

`updateValidationRule`

`deleteValidationRule`

`addUsedByReference`

`removeUsedByReference`