Gérer les règles statiques personnalisées via l'API

Endpoints de gestion des règles statiques personnalisées

Accéder à toutes les règles personnalisées existantes

GET https://console.baleen.cloud/api/configs/custom-static-rules

Description fonctionnelle

Cet endpoint permet d'accéder à la liste des règles statiques personnalisées existantes.

Format de la requête

Headers

Paramètres

Aucun

Attributs

Aucun

Body

Aucun

Format de la réponse

200 OK

[
    {
        "conditions": [
            {
                "type": "isp",
                "value": "Microsoft Corporation",
                "key": null,
                "operator": "equals"
            }
        ],
        "category": "blocklisted_as",
        "id": "a7fc733e-92a0-4927-ba72-bfb538fca170",
        "priority": 4000001,
        "enabled": true,
        "description": "Microsoft Network"
    }
]

401 Unauthorized

403 Forbidden

404 Not Found

Objet

Description de l'objet custom-static-rule

Accéder à une règle personnalisée existante

GET https://console.baleen.cloud/api/configs/custom-static-rules/:customStaticRuleId

Description fonctionnelle

Cet endpoint permet d'accéder à une règle statique personnalisée existante.

Format de la requête

Headers

Paramètres

Aucun

Attributs

Nom	Requis	Type	Valeur par défaut	Description	Valeurs possibles
customStaticRuleId	Oui	String	Aucune	Identifiant de la règle personnalisée à accéder

Body

Aucun

Format de la réponse

200 OK

[
    {
        "conditions": [
            {
                "type": "isp",
                "value": "Microsoft Corporation",
                "key": null,
                "operator": "equals"
            }
        ],
        "category": "blocklisted_as",
        "id": "a7fc733e-92a0-4927-ba72-bfb538fca170",
        "priority": 4000001,
        "enabled": true,
        "description": "Microsoft Network"
    }
]

401 Unauthorized

403 Forbidden

404 Not Found

Objet

Description de l'objet custom-static-rule

Créer une nouvelle règle personnalisée

POST https://console.baleen.cloud/api/configs/custom-static-rules

Description fonctionnelle

Cet endpoint permet de créer une nouvelle règle personnalisée.

Format de la requête

Headers

Paramètres

Aucun

Attributs

Aucun

Body

{
    "conditions": [
        {
            "type": "uri",
            "value": "^/user.*\\\\\\\\.js$",
            "key": null,
            "operator": "equals"
        },
        {
            "type": "uri",
            "value": "^/user.*\\\\\\\\.js$",
            "key": null,
            "operator": "equals"
        }
    ],
    "category": "captcha",
    "priority": 1,
    "enabled": true,
    "description": "URI to be matched"
}

Format de la réponse

200 OK

201 Created

401 Unauthorized

403 Forbidden

404 Not Found

Objet

Description de l'objet custom-static-rule

Supprimer une règle personnalisée existante

DELETE https://console.baleen.cloud/api/configs/custom-static-rules/:customStaticRuleId

Description fonctionnelle

Cet endpoint permet de supprimer une règle statique personnalisée existante.

Format de la requête

Headers

Paramètres

Aucun

Attributs

Nom	Requis	Type	Valeur par défaut	Description	Valeurs possibles
customStaticRuleId	Oui	String	Aucune	Identifiant de la règle personnalisée à supprimer

Body

Aucun

Format de la réponse

200 OK

204 No content

401 Unauthorized

403 Forbidden

Objet

Aucun

Modifier une règle personnalisée existante

PATCH https://console.baleen.cloud/api/configs/custom-static-rules/:customStaticRuleId

Description fonctionnelle

Cet endpoint permet de modifier une règle statique personnalisée existante.

Format de la requête

Headers

Paramètres

Aucun

Attributs

Nom	Requis	Type	Valeur par défaut	Description	Valeurs possibles
customStaticRuleId	Oui	String	Aucune	Identifiant de la règle personnalisée à modifier

Body

Format de la réponse

200 OK

204 No content

401 Unauthorized

403 Forbidden

Objet

Description de l'objet custom-static-rule

Nom	Requis	Type	Valeur par défaut	Description	Valeurs possibles
conditions	Oui	Array		Ensemble de conditions de la règle
category	Oui	String
id	Oui (non attendu en cas de création)	String	Aucune	Identifiant unique de la règle
priority	Non
enabled	Oui	Boolean		Booléen indiquant le statut de la règle	True False
description	Non	String	Aucune	Libellé correspondant au nom de la règle

Description de l'objet conditions

Nom	Requis	Type	Valeur par défaut	Description	Valeurs possibles
type	Oui	String	Aucune	Fingerprint concerné par la condition	"ip" "userAgent" "isp" "country" "ja3" "uri" "asn" "header"
key	Non (attendu pour une condition portant sur un fingerprint de type "header")	String	null	Clé du fingerprint concerné par la condition
operator	Oui				"equals" "match"
value	Oui	String		Valeur du fingerprint concerné