Retrieve Matching Policy (Beta)

Get Matching Policy

curl --request GET \
  --url https://api.flare.io/firework/v4/matching-policies/{policy_uuid} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.flare.io/firework/v4/matching-policies/{policy_uuid}"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.flare.io/firework/v4/matching-policies/{policy_uuid}', 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://api.flare.io/firework/v4/matching-policies/{policy_uuid}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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://api.flare.io/firework/v4/matching-policies/{policy_uuid}"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.flare.io/firework/v4/matching-policies/{policy_uuid}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "uuid": "<string>",
  "name": "<string>",
  "policy_type": "INCLUDED_KEYWORDS",
  "value": {
    "keywords": [
      "<string>"
    ]
  },
  "created_at": "2023-11-07T05:31:56Z",
  "last_updated_at": "2023-11-07T05:31:56Z"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

GET

firework

matching-policies

{policy_uuid}

Get Matching Policy

curl --request GET \
  --url https://api.flare.io/firework/v4/matching-policies/{policy_uuid} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.flare.io/firework/v4/matching-policies/{policy_uuid}"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.flare.io/firework/v4/matching-policies/{policy_uuid}', 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://api.flare.io/firework/v4/matching-policies/{policy_uuid}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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://api.flare.io/firework/v4/matching-policies/{policy_uuid}"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.flare.io/firework/v4/matching-policies/{policy_uuid}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "uuid": "<string>",
  "name": "<string>",
  "policy_type": "INCLUDED_KEYWORDS",
  "value": {
    "keywords": [
      "<string>"
    ]
  },
  "created_at": "2023-11-07T05:31:56Z",
  "last_updated_at": "2023-11-07T05:31:56Z"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Required API key permission: Read Tenant

The Retrieve Matching Policy endpoint is still in beta and is subject to change.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

policy_uuid

string<uuid>

required

Response

Successful Response

uuid

string<uuid4>

required

The UUID of the matching policy

name

string

required

The name of the matching policy

policy_type

enum<string>

required

The type of the matching policy

Available options:

INCLUDED_KEYWORDS,

EXCLUDED_KEYWORDS,

LUCENE_QUERY,

ASTP_COOKIES,

ASTP_DOMAIN

value

KeywordsValue · object

required

The value of the matching policy depending on its type

KeywordsValue
LuceneValue
AstpCookiesReadValue
AstpDomainValue

Show child attributes

created_at

string<date-time>

required

The date and time the matching policy was created

last_updated_at

string<date-time>

required

The date and time the matching policy was last updated

Authentication API

Events API

Global Search API

Account and Session Takeover Prevention (ASTP) API

Management API

Entities API

Threat-Flow API

Sandbox API

Deprecated APIs

Retrieve Matching Policy (Beta)

Authorizations

Path Parameters

Response