Activate a Rule

curl --request POST \
  --url https://tracer.sandbox.lerian.net/v1/rules/{id}/activate \
  --header 'Content-Type: <content-type>' \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://tracer.sandbox.lerian.net/v1/rules/{id}/activate"

headers = {
    "Content-Type": "<content-type>",
    "X-API-Key": "<api-key>"
}

response = requests.post(url, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': '<content-type>', 'X-API-Key': '<api-key>'}
};

fetch('https://tracer.sandbox.lerian.net/v1/rules/{id}/activate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://tracer.sandbox.lerian.net/v1/rules/{id}/activate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Content-Type: <content-type>",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://tracer.sandbox.lerian.net/v1/rules/{id}/activate"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Content-Type", "<content-type>")
	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://tracer.sandbox.lerian.net/v1/rules/{id}/activate")
  .header("Content-Type", "<content-type>")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://tracer.sandbox.lerian.net/v1/rules/{id}/activate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = '<content-type>'
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "ruleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "expression": "<string>",
  "scopes": [
    {
      "segmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "portfolioId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "merchantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "subType": "<string>"
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "activatedAt": "2023-11-07T05:31:56Z",
  "deactivatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z"
}

POST

rules

{id}

activate

Activate a Rule

curl --request POST \
  --url https://tracer.sandbox.lerian.net/v1/rules/{id}/activate \
  --header 'Content-Type: <content-type>' \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://tracer.sandbox.lerian.net/v1/rules/{id}/activate"

headers = {
    "Content-Type": "<content-type>",
    "X-API-Key": "<api-key>"
}

response = requests.post(url, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': '<content-type>', 'X-API-Key': '<api-key>'}
};

fetch('https://tracer.sandbox.lerian.net/v1/rules/{id}/activate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://tracer.sandbox.lerian.net/v1/rules/{id}/activate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Content-Type: <content-type>",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://tracer.sandbox.lerian.net/v1/rules/{id}/activate"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Content-Type", "<content-type>")
	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://tracer.sandbox.lerian.net/v1/rules/{id}/activate")
  .header("Content-Type", "<content-type>")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://tracer.sandbox.lerian.net/v1/rules/{id}/activate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = '<content-type>'
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "ruleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "expression": "<string>",
  "scopes": [
    {
      "segmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "portfolioId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "merchantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "subType": "<string>"
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "activatedAt": "2023-11-07T05:31:56Z",
  "deactivatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z"
}

Authorizations

X-API-Key

string

header

required

API Key authentication. Used by single-tenant deployments (MULTI_TENANT_ENABLED=false). Sent on every /v1/* request.

Headers

Content-Type

string

required

The type of media of the resource. Must be application/json.

X-API-Key

string

required

The API Key for authentication. This header is required for all endpoints except health checks.

X-Request-Id

string<uuid>

A unique identifier used to trace and track each request.

Path Parameters

string<uuid>

required

The unique identifier of the rule that you want to retrieve, update or delete.

Response

Indicates that the rule was successfully activated.

Validation rule.

ruleId

string<uuid>

Unique identifier for the rule.

name

string

Human-readable rule name (globally unique).

Maximum string length: 255

description

string

Rule purpose and logic explanation.

Maximum string length: 1000

expression

string

CEL expression that must evaluate to boolean.

Maximum string length: 5000

action

enum<string>

Action taken when rule expression evaluates to true.

Available options:

ALLOW,

DENY,

REVIEW

scopes

object[]

Scopes that determine which transactions this rule applies to.

Show child attributes

status

enum<string>

Rule lifecycle status.

Available options:

DRAFT,

ACTIVE,

INACTIVE,

DELETED

createdAt

string<date-time>

When the rule was created.

updatedAt

string<date-time>

When the rule was last modified.

activatedAt

string<date-time> | null

When rule was last activated (null if never activated).

deactivatedAt

string<date-time> | null

When rule was last deactivated (null if never deactivated).

deletedAt

string<date-time> | null

When rule was deleted (null if not deleted).

Delete a Rule

Deactivate a Rule

⌘I

Getting started

Validations API

Rules API

Limits API

Reservations API

Audit Events API

Error handling

Activate a Rule

Authorizations

Headers

Path Parameters

Response