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

Lists

APIs for managing lists

Get all lists

get

Get all lists defined in the system.

For more details on lists in XSOAR, see Lists.

Header parameters
authorizationstringRequired

api_key

Example: DCdIeow0xm73EwnxjPza1tdHTfZQv2eH7bTKlTPkgBHLj8aSjFzjgTE9bQUK1DidlWLrnYRhaYQ4PCIyNrNJbMUC6DOWi8ANIn1JWpMTE2neGvoDIRsKUbj6pJ1z7Gmr
x-xdr-auth-idstringRequired

api_key_id

Example: 2841
Responses
200

OK

application/json
idstringOptional
versionintegerOptional
cacheVersnintegerOptional
sequenceNumberintegerOptional
primaryTermintegerOptional
modifiedstringOptional
sizeInBytesintegerOptional
packIDstringOptional
packNamestringOptional
itemVersionstringOptional
fromServerVersionstringOptional
toServerVersionstringOptional
propagationLabelsstring[]Optional
definitionIdstringOptional
vcShouldIgnorebooleanOptional
vcShouldKeepItemLegacyProdMachinebooleanOptional
commitMessagestringOptional
shouldCommitbooleanOptional
allReadbooleanOptional
allReadWritebooleanOptional
previousAllReadbooleanOptional
previousAllReadWritebooleanOptional
namestringOptional
prevNamestringOptional
datastringOptional
lockedbooleanOptional
nameLockedbooleanOptional
systembooleanOptional
truncatedbooleanOptional
typestringOptional
tagsnullOptional
descriptionstringOptional
detachedbooleanOptional
get/xsoar/public/v1/lists
GET /xsoar/public/v1/lists HTTP/1.1
Host: api-yourfqdn
authorization: DCdIeow0xm73EwnxjPza1tdHTfZQv2eH7bTKlTPkgBHLj8aSjFzjgTE9bQUK1DidlWLrnYRhaYQ4PCIyNrNJbMUC6DOWi8ANIn1JWpMTE2neGvoDIRsKUbj6pJ1z7Gmr
x-xdr-auth-id: 2841
Accept: */*
200

OK

[
  {
    "id": "pre_process_rule_with_string",
    "version": 1,
    "cacheVersn": 0,
    "sequenceNumber": 22093058,
    "primaryTerm": 8,
    "modified": "2023-08-16T07:15:39.736816748Z",
    "sizeInBytes": 0,
    "packID": "",
    "packName": "",
    "itemVersion": "",
    "fromServerVersion": "",
    "toServerVersion": "",
    "propagationLabels": [
      "all"
    ],
    "definitionId": "",
    "vcShouldIgnore": false,
    "vcShouldKeepItemLegacyProdMachine": false,
    "commitMessage": "",
    "shouldCommit": false,
    "allRead": true,
    "allReadWrite": true,
    "previousAllRead": true,
    "previousAllReadWrite": true,
    "name": "pre_process_rule_with_string",
    "prevName": "pre_process_rule_with_string",
    "data": "dazVjAiG,HButncn7,2NoETt85",
    "locked": false,
    "nameLocked": false,
    "system": false,
    "truncated": false,
    "type": "plain_text",
    "tags": null,
    "description": "",
    "detached": false
  },
  {
    "id": "delete_list_public_api_list",
    "version": 1,
    "cacheVersn": 0,
    "sequenceNumber": 37440266,
    "primaryTerm": 12,
    "modified": "2024-01-16T17:10:04.554799873Z",
    "sizeInBytes": 0,
    "packID": "",
    "packName": "",
    "itemVersion": "",
    "fromServerVersion": "",
    "toServerVersion": "",
    "propagationLabels": [
      "all"
    ],
    "definitionId": "",
    "vcShouldIgnore": false,
    "vcShouldKeepItemLegacyProdMachine": false,
    "commitMessage": "",
    "shouldCommit": false,
    "allRead": true,
    "allReadWrite": true,
    "previousAllRead": true,
    "previousAllReadWrite": true,
    "name": "delete_list_public_api_list",
    "prevName": "delete_list_public_api_list",
    "data": "Y5PEIaYo,jc9hTzrj,kJRU1di8",
    "locked": false,
    "nameLocked": false,
    "system": false,
    "truncated": false,
    "type": "plain_text",
    "tags": null,
    "description": "",
    "detached": false
  }
]

Delete a list

post

Delete the list specified by its ID.

For more details on lists in XSOAR, see Lists.

Header parameters
authorizationstringRequired

api_key

Example: DCdIeow0xm73EwnxjPza1tdHTfZQv2eH7bTKlTPkgBHLj8aSjFzjgTE9bQUK1DidlWLrnYRhaYQ4PCIyNrNJbMUC6DOWi8ANIn1JWpMTE2neGvoDIRsKUbj6pJ1z7Gmr
x-xdr-auth-idstringRequired

api_key_id

Example: 2841
Body
idstringOptional
Responses
200

OK

application/json
objectOptional
post/xsoar/public/v1/lists/delete
POST /xsoar/public/v1/lists/delete HTTP/1.1
Host: api-yourfqdn
authorization: DCdIeow0xm73EwnxjPza1tdHTfZQv2eH7bTKlTPkgBHLj8aSjFzjgTE9bQUK1DidlWLrnYRhaYQ4PCIyNrNJbMUC6DOWi8ANIn1JWpMTE2neGvoDIRsKUbj6pJ1z7Gmr
x-xdr-auth-id: 2841
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "id": "my_test_list"
}
200

OK

{}

Create or update a list

post

Create a new list or update an existing one. To update an existing list, send the request with the id of the existing list and the lastest version

For more details on lists in XSOAR, see Lists.

Header parameters
authorizationstringRequired

api_key

Example: DCdIeow0xm73EwnxjPza1tdHTfZQv2eH7bTKlTPkgBHLj8aSjFzjgTE9bQUK1DidlWLrnYRhaYQ4PCIyNrNJbMUC6DOWi8ANIn1JWpMTE2neGvoDIRsKUbj6pJ1z7Gmr
x-xdr-auth-idstringRequired

api_key_id

Example: 2841
Body
propagationLabelsstring[]Optional
typestringOptional
allReadbooleanOptional
allReadWritebooleanOptional
namestringOptional
datastringOptional
commitMessagestringOptional
shouldPublishbooleanOptional
shouldCommitbooleanOptional
Responses
200

OK

application/json
idstringOptional
versionintegerOptional
cacheVersnintegerOptional
sequenceNumberintegerOptional
primaryTermintegerOptional
modifiedstringOptional
sizeInBytesintegerOptional
packIDstringOptional
packNamestringOptional
itemVersionstringOptional
fromServerVersionstringOptional
toServerVersionstringOptional
propagationLabelsstring[]Optional
definitionIdstringOptional
vcShouldIgnorebooleanOptional
vcShouldKeepItemLegacyProdMachinebooleanOptional
commitMessagestringOptional
shouldCommitbooleanOptional
allReadbooleanOptional
allReadWritebooleanOptional
previousAllReadbooleanOptional
previousAllReadWritebooleanOptional
namestringOptional
prevNamestringOptional
datastringOptional
lockedbooleanOptional
nameLockedbooleanOptional
systembooleanOptional
truncatedbooleanOptional
typestringOptional
tagsnullOptional
descriptionstringOptional
detachedbooleanOptional
post/xsoar/public/v1/lists/save
POST /xsoar/public/v1/lists/save HTTP/1.1
Host: api-yourfqdn
authorization: DCdIeow0xm73EwnxjPza1tdHTfZQv2eH7bTKlTPkgBHLj8aSjFzjgTE9bQUK1DidlWLrnYRhaYQ4PCIyNrNJbMUC6DOWi8ANIn1JWpMTE2neGvoDIRsKUbj6pJ1z7Gmr
x-xdr-auth-id: 2841
Content-Type: application/json
Accept: */*
Content-Length: 283

{
  "propagationLabels": [
    "all"
  ],
  "type": "plain_text",
  "allRead": true,
  "allReadWrite": true,
  "name": "my_test_list",
  "orgList": {
    "propagationLabels": [
      "all"
    ],
    "type": "plain_text",
    "allRead": true,
    "allReadWrite": true
  },
  "data": "item1\nitem2",
  "commitMessage": "",
  "shouldPublish": true,
  "shouldCommit": true
}
200

OK

{
  "id": "my_test_list",
  "version": 1,
  "cacheVersn": 0,
  "sequenceNumber": 49601047,
  "primaryTerm": 12,
  "modified": "2024-04-17T08:33:23.445507693Z",
  "sizeInBytes": 636,
  "packID": "",
  "packName": "",
  "itemVersion": "",
  "fromServerVersion": "",
  "toServerVersion": "",
  "propagationLabels": [
    "all"
  ],
  "definitionId": "",
  "vcShouldIgnore": false,
  "vcShouldKeepItemLegacyProdMachine": false,
  "commitMessage": "",
  "shouldCommit": true,
  "allRead": true,
  "allReadWrite": true,
  "previousAllRead": true,
  "previousAllReadWrite": true,
  "name": "my_test_list",
  "prevName": "my_test_list",
  "data": "item1\nitem2",
  "locked": false,
  "nameLocked": false,
  "system": false,
  "truncated": false,
  "type": "plain_text",
  "tags": null,
  "description": "",
  "detached": false
}

Get the specified list

get

Download the list specified by list ID.

For more details on lists in XSOAR, see Lists.

Path parameters
list_idstringRequired
Header parameters
AuthorizationstringRequired

{api_key}

x-xdr-auth-idstringRequired

{api_key_id}

Responses
200

OK

application/json
string[]Optional
get/xsoar/public/v1/lists/download/{list_id}
GET /xsoar/public/v1/lists/download/{list_id} HTTP/1.1
Host: api-yourfqdn
Authorization: text
x-xdr-auth-id: text
Accept: */*
200

OK

[
  "item1",
  "item2"
]
PreviousJobs
NextMulti Tenant

Last updated

Was this helpful?