Ctrlk
BlogSupport
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Disable Prevention Rule Public APIs

Get Disable Prevention Rules

post

Returns a list of Disable Prevention rules based on filters, sorting, and pagination.

Header parameters
AuthorizationstringRequired

{api_key}

Example: UCoWpG4rkNzgCp2dsh8m02iVpZsskwKHz7N1tErPcUV3Wmf59Gc9kytmgOv0pDWoem3PBlORyRIPiir4OcYdWUOWAM3JyTgoCxQf4nQoTlKmFRKz9Bj5vIjluw66p9WP
x-xdr-auth-idstringRequired

{api_key_id}

Example: 241
Body
Responses
200

OK

application/json
post/public_api/v1/disable_prevention/fetch
POST /public_api/v1/disable_prevention/fetch HTTP/1.1
Host: api-yourfqdn
Authorization: UCoWpG4rkNzgCp2dsh8m02iVpZsskwKHz7N1tErPcUV3Wmf59Gc9kytmgOv0pDWoem3PBlORyRIPiir4OcYdWUOWAM3JyTgoCxQf4nQoTlKmFRKz9Bj5vIjluw66p9WP 
x-xdr-auth-id: 241
Content-Type: application/json
Accept: */*
Content-Length: 184

{
  "request_data": {
    "search_from": 0,
    "search_to": 100,
    "sort": {
      "field": "rule_id",
      "keyword": "asc"
    },
    "filters": [
      {
        "field": "rule_id",
        "operator": "eq",
        "value": "1bce99ee792e4f0682d7c9bde0aaf44e"
      }
    ]
  }
}
200

OK

{
  "reply": {
    "data": [
      {
        "rule_id": "1bce99ee792e4f0682d7c9bde0aaf44e",
        "rule_name": "DPR",
        "description": "Prevention rules using API",
        "platform": "linux",
        "conditions": {
          "hash": "3b7d28f7a6c1e9b0f4a5c2d9e8f1a0b6c7d4e5f8091a2b3c4d5e6f7a8b9c0d1 ",
          "path": "/*",
          "signer": "trusted company.inc",
          "command": "command line argument",
          "sign_thumbprint": "certificate thumbprint"
        },
        "module_ids": [
          56
        ],
        "profile_ids": [
          96
        ],
        "scope": "profile",
        "status": "enabled",
        "created_by": "Jane Doe",
        "user_email": "jane.doe@example.com",
        "modification_time": 1764475578200,
        "associated_targets": [
          "endpoint != AFDSFDS"
        ]
      }
    ],
    "filter_count": 1,
    "total_count": 4
  }
}

Get Disable Prevention Modules

post

Returns a list of available modules for a specific platform.

Header parameters
AuthorizationstringRequired

{api_key}

Example: UCoWpG4rkNzgCp2dsh8m02iVpZsskwKHz7N1tErPcUV3Wmf59Gc9kytmgOv0pDWoem3PBlORyRIPiir4OcYdWUOWAM3JyTgoCxQf4nQoTlKmFRKz9Bj5vIjluw66p9WP
x-xdr-auth-idstringRequired

{api_key_id}

Example: 241
Body
Responses
200

OK

application/json
post/public_api/v1/disable_prevention/get_modules
POST /public_api/v1/disable_prevention/get_modules HTTP/1.1
Host: api-yourfqdn
Authorization: UCoWpG4rkNzgCp2dsh8m02iVpZsskwKHz7N1tErPcUV3Wmf59Gc9kytmgOv0pDWoem3PBlORyRIPiir4OcYdWUOWAM3JyTgoCxQf4nQoTlKmFRKz9Bj5vIjluw66p9WP 
x-xdr-auth-id: 241
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "request_data": {
    "platform": "windows"
  }
}
200

OK

{
  "reply": [
    {
      "module_id": 1,
      "name": "DLL Security",
      "description": "Memory Corruption Exploit",
      "profile_type": "Exploit",
      "conditions_definition": {
        "properties": {
          "hash": {
            "type": "string",
            "description": "Hash"
          },
          "path": {
            "type": "string",
            "description": "Files / Folders",
            "minLength": 1
          },
          "command": {
            "type": "string",
            "description": "Command Line",
            "minLength": 1
          },
          "signer": {
            "type": "string",
            "description": "Signer Name",
            "minLength": 1
          },
          "sign_thumbprint": {
            "type": "string",
            "description": "Certificate Thumbprint",
            "minLength": 1
          }
        }
      },
      "additionalProperties": false,
      "minProperties": 1
    }
  ]
}

Add Disable Prevention Rule

post

Creates a new Disable Prevention rule.

Header parameters
AuthorizationstringRequired

{api_key}

Example: UCoWpG4rkNzgCp2dsh8m02iVpZsskwKHz7N1tErPcUV3Wmf59Gc9kytmgOv0pDWoem3PBlORyRIPiir4OcYdWUOWAM3JyTgoCxQf4nQoTlKmFRKz9Bj5vIjluw66p9WP
x-xdr-auth-idstringRequired

{api_key_id}

Example: 241
Body
Responses
200

OK

application/json
replystringOptional

Returns the Disable Prevention Rule ID.

Example: 330fc8dec96a4810af886af328e73264
post/public_api/v1/disable_prevention/add
POST /public_api/v1/disable_prevention/add HTTP/1.1
Host: api-yourfqdn
Authorization: UCoWpG4rkNzgCp2dsh8m02iVpZsskwKHz7N1tErPcUV3Wmf59Gc9kytmgOv0pDWoem3PBlORyRIPiir4OcYdWUOWAM3JyTgoCxQf4nQoTlKmFRKz9Bj5vIjluw66p9WP 
x-xdr-auth-id: 241
Content-Type: application/json
Accept: */*
Content-Length: 356

{
  "request_data": {
    "rule_name": "My MacOS Rule",
    "description": "Data prevention rule for MacOS",
    "platform": "macos",
    "module_ids": [
      38
    ],
    "conditions": {
      "hash": "2cf24dba5fb0a30e26e83b2ac5b9e29e1b161e5c1fa7425e73043362938b9824",
      "path": "/usr/",
      "signer": "Trusted Company Inc.",
      "command": "command line argument"
    },
    "profile_ids": [
      96
    ],
    "status": "enabled",
    "scope": "profile"
  }
}
200

OK

{
  "reply": "330fc8dec96a4810af886af328e73264"
}

Edit Disable Prevention Rule

post

Updates an existing Disable Prevention rule.

Header parameters
AuthorizationstringRequired

{api_key}

Example: UCoWpG4rkNzgCp2dsh8m02iVpZsskwKHz7N1tErPcUV3Wmf59Gc9kytmgOv0pDWoem3PBlORyRIPiir4OcYdWUOWAM3JyTgoCxQf4nQoTlKmFRKz9Bj5vIjluw66p9WP
x-xdr-auth-idstringRequired

{api_key_id}

Example: 241
Body
Responses
200

OK

application/json
replystringOptional

Returns the Disable Prevention Rule ID.

Example: 330fc8dec96a4810af886af328e73264
post/public_api/v1/disable_prevention/edit
POST /public_api/v1/disable_prevention/edit HTTP/1.1
Host: api-yourfqdn
Authorization: UCoWpG4rkNzgCp2dsh8m02iVpZsskwKHz7N1tErPcUV3Wmf59Gc9kytmgOv0pDWoem3PBlORyRIPiir4OcYdWUOWAM3JyTgoCxQf4nQoTlKmFRKz9Bj5vIjluw66p9WP 
x-xdr-auth-id: 241
Content-Type: application/json
Accept: */*
Content-Length: 401

{
  "request_data": {
    "rule_name": "My MacOS Rule",
    "description": "Data prevention rule for MacOS",
    "platform": "macos",
    "module_ids": [
      38
    ],
    "conditions": {
      "hash": "2cf24dba5fb0a30e26e83b2ac5b9e29e1b161e5c1fa7425e73043362938b9824",
      "path": "/usr/",
      "signer": "Trusted Company Inc.",
      "command": "command line argument"
    },
    "profile_ids": [
      96
    ],
    "status": "enabled",
    "scope": "profile",
    "rule_id": "5bfb2a15ca2a4525a4e69f11792dfe61"
  }
}
200

OK

{
  "reply": "330fc8dec96a4810af886af328e73264"
}

Delete Disable Prevention Rules

post

Deletes one or more Disable Prevention rules based on the provided rule ID.

Header parameters
AuthorizationstringRequired

{api_key}

Example: UCoWpG4rkNzgCp2dsh8m02iVpZsskwKHz7N1tErPcUV3Wmf59Gc9kytmgOv0pDWoem3PBlORyRIPiir4OcYdWUOWAM3JyTgoCxQf4nQoTlKmFRKz9Bj5vIjluw66p9WP
x-xdr-auth-idstringRequired

{api_key_id}

Example: 241
Body
Responses
200

OK

application/json
replystringOptional

Describes the result of the API operation.

Example: 1 rule was deleted.
post/public_api/v1/disable_prevention/delete
POST /public_api/v1/disable_prevention/delete HTTP/1.1
Host: api-yourfqdn
Authorization: UCoWpG4rkNzgCp2dsh8m02iVpZsskwKHz7N1tErPcUV3Wmf59Gc9kytmgOv0pDWoem3PBlORyRIPiir4OcYdWUOWAM3JyTgoCxQf4nQoTlKmFRKz9Bj5vIjluw66p9WP 
x-xdr-auth-id: 241
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "request_data": {
    "rule_ids": [
      "00e2308ad4a54fca8b478766ee9de57e"
    ]
  }
}
200

OK

{
  "reply": "1 rule was deleted."
}
PreviousDisable Prevention Rule overview
NextModels

Last updated

Was this helpful?