Read a rule set and one definition version
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id |
path | string | Yes | — |
version |
query | integer | No | Defaults to the latest version. min 1 |
Request
This endpoint has no request body.
curl "$MONICHEK_API/rule-sets/{id}" \
-H "Authorization: Bearer $MONICHEK_API_KEY"const res = await fetch(`${MONICHEK_API}/rule-sets/{id}`, {
method: "GET",
headers: {
Authorization: `Bearer ${MONICHEK_API_KEY}`,
},
});
const data = await res.json();import os
import requests
res = requests.get(
f"{os.environ['MONICHEK_API']}/rule-sets/{id}",
headers={"Authorization": f"Bearer {os.environ['MONICHEK_API_KEY']}"},
)
print(res.json())$ch = curl_init(getenv('MONICHEK_API') . '/rule-sets/{id}');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('MONICHEK_API_KEY'),
],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Replace {id} with the resource id.
Responses
200 OK
set definition and version history (used by the Add-to-set step)
application/json
{
"object": "string",
"id": "id_01M3R...",
"name": "Ada Okafor",
"applies_to": "string",
"version": 1,
"state": "string",
"definition": {
"rules": [
{
"rule_id": "rul_01M3R...",
"version": 1,
"enabled": true
}
],
"resolution": "string",
"fail_mode": "string",
"segments": [
{}
]
},
"versions": [
{}
]
}Response fields
| Field | Type | Required | Description | ||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
object |
string | No | — | ||||||||||||||||||||||||||||||||||||
id |
string | No | — | ||||||||||||||||||||||||||||||||||||
name |
string | No | — | ||||||||||||||||||||||||||||||||||||
applies_to |
string | No | — | ||||||||||||||||||||||||||||||||||||
version |
integer | No | — | ||||||||||||||||||||||||||||||||||||
state |
string | No | — | ||||||||||||||||||||||||||||||||||||
definition |
object | No | Show 4 nested fields
|
||||||||||||||||||||||||||||||||||||
versions |
array of object | No | — |
Error responses
| Status | Meaning | Body |
|---|---|---|
| 404 | Not Found | RFC 9457 problem |
Errors use the RFC 9457 problem format with a stable code.