Update List

Route

/v2/lists/{list_id}

Description

Update an existing policy configuration list. Only provided fields will be updated, others remain unchanged. Values can be added, removed, or replaced.

Method

PATCH

Inputs

Parameter	Type	Required	Description
list_id	string	Yes	Unique identifier of the list to update
name	string	No	Updated list name (max 100 characters)
description	string	No	Updated list description (max 500 characters)
values	array[string]	No	Updated list values (replaces all existing values)
add_values	array[string]	No	Values to add to existing list
remove_values	array[string]	No	Values to remove from existing list

Path Parameters

• list_id: The unique identifier of the list (provided in the URL path)

Request Examples

Update name and description

{
  "name": "Updated Office Extensions",
  "description": "Updated list of Microsoft Office file extensions"
}

Add values to existing list

{
  "add_values": [".pptm", ".xlsm", ".docm"]
}

Remove specific values

{
  "remove_values": [".old", ".tmp"]
}

Replace all values

{
  "values": [".docx", ".xlsx", ".pptx", ".pdf"]
}

Output

Field	Type	Description
id	string	Unique list identifier
name	string	Updated list name
description	string	Updated list description
type	string	List type
values	array[string]	Updated list values
value_count	integer	Total number of values in updated list
created_at	string	Creation timestamp (ISO 8601)
updated_at	string	Last update timestamp (ISO 8601)

Rate Limit

• 60 requests per minute per API key
• 5 concurrent requests per endpoint

Example Response

{
  "id": "list-123",
  "name": "Updated Office Extensions",
  "description": "Updated list of Microsoft Office file extensions",
  "type": "file_extension",
  "values": [".docx", ".xlsx", ".pptx", ".pptm", ".xlsm", ".docm"],
  "value_count": 6,
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T11:45:00Z"
}

Usage Notes

• Cannot use values with add_values or remove_values in the same request
• add_values and remove_values can be used together
• Duplicate values are automatically removed
• Maximum 1000 values per list