Scripts

APIs for managing scripts

Get a script

post

Get a script by filtering based on its name or ID. The script's YAML is returned in a ZIP file.

Requires the granular RBAC permission for this feature.

Header parameters

AuthorizationstringRequired

{api_key}

x-xdr-auth-idstringRequired

{api_key_id}

Body

Responses

200

OK

application/zip

objectOptional

post/public_api/v1/scripts/get

POST /public_api/v1/scripts/get HTTP/1.1
Host: api-yourfqdn
Authorization: text
x-xdr-auth-id: text
Content-Type: application/json
Accept: */*
Content-Length: 69

{
  "request_data": {
    "filter": {
      "field": "name",
      "value": "PhishingScript"
    }
  }
}

200

OK

{}

Insert or update a script

post

Update or add a script by passing the YAML in a ZIP file.

Requires the granular RBAC permission for this feature.

Header parameters

AuthorizationstringRequired

{api_key}

x-xdr-auth-idstringRequired

{api_key_id}

Body

filestring · binaryOptional

The script in YAML in a zipped file.

Responses

200

OK

application/json

objects_countintegerOptional

The number of scripts identified and attempted to be added.

post/public_api/v1/scripts/insert

POST /public_api/v1/scripts/insert HTTP/1.1
Host: api-yourfqdn
Authorization: text
x-xdr-auth-id: text
Content-Type: multipart/form-data
Accept: */*
Content-Length: 17

{
  "file": "binary"
}

200

OK

{
  "objects_count": 1,
  "objects": {
    "failures_items": [
      {
        "error": "text",
        "id": "text"
      }
    ]
  }
}

Delete a script

post

Delete a script by filtering based on its name or ID.

Requires the granular RBAC permission for this feature.

Header parameters

AuthorizationstringRequired

{api_key}

x-xdr-auth-idstringRequired

{api_key_id}

Body

Responses

200

OK

application/json

objects_countintegerOptional

The number of scripts identified and attempted to be deleted.

post/public_api/v1/scripts/delete

POST /public_api/v1/scripts/delete HTTP/1.1
Host: api-yourfqdn
Authorization: text
x-xdr-auth-id: text
Content-Type: application/json
Accept: */*
Content-Length: 72

{
  "request_data": {
    "filters": {
      "field": "name",
      "value": "Phishingplaybook"
    }
  }
}

200

OK

{
  "objects_count": 1,
  "objects": {
    "failures_items": [
      {
        "error": "text",
        "id": "text"
      }
    ],
    "succeeded_items": [
      {
        "id": "text"
      }
    ]
  }
}