> For the complete documentation index, see [llms.txt](https://cortex-docs.paloaltonetworks.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://cortex-docs.paloaltonetworks.com/xdr-5-api/agent-configuration-settings/models.md).

# Models

## The ErrorResponse object

```json
{"openapi":"3.0.3","info":{"title":"Agent Configuration Settings API","version":"1.0.0"},"components":{"schemas":{"ErrorResponse":{"type":"object","description":"Standard error response returned when a request fails.","properties":{"reply":{"type":"object","description":"Error details container.","properties":{"err_code":{"type":"integer","description":"Numeric error code identifying the type of error."},"err_msg":{"type":"string","description":"Human-readable error message describing what went wrong."},"err_extra":{"type":"string","description":"Additional context about the error, if available."}}}}}}}}
```

## The BaseResponse object

```json
{"openapi":"3.0.3","info":{"title":"Agent Configuration Settings API","version":"1.0.0"},"components":{"schemas":{"BaseResponse":{"type":"object","description":"Standard success response for configuration update operations.","properties":{"reply":{"type":"boolean","description":"Indicates whether the operation completed successfully."}}}}}}
```

## The ContentManagementResponse object

```json
{"openapi":"3.0.3","info":{"title":"Agent Configuration Settings API","version":"1.0.0"},"components":{"schemas":{"ContentManagementResponse":{"type":"object","description":"Current content management configuration settings.","properties":{"reply":{"type":"object","properties":{"enable_bandwidth_control":{"type":"boolean","description":"Indicates whether bandwidth control is currently enabled for agent network consumption during content updates and package downloads."},"bandwidth_in_mbps":{"type":"integer","description":"The current maximum bandwidth in Mbps allocated for content downloads."},"enable_minor_content_version_updates":{"type":"boolean","description":"Indicates whether automatic minor content updates between major content releases are enabled."}}}}}}}}
```

## The SetContentManagementRequest object

```json
{"openapi":"3.0.3","info":{"title":"Agent Configuration Settings API","version":"1.0.0"},"components":{"schemas":{"SetContentManagementRequest":{"type":"object","description":"Request payload for updating agent content management settings.","properties":{"request_data":{"type":"object","required":["enable_bandwidth_control","bandwidth_in_mbps"],"properties":{"enable_bandwidth_control":{"type":"boolean","description":"Enables bandwidth control for the agent network consumption during content updates and package downloads."},"bandwidth_in_mbps":{"type":"integer","minimum":20,"maximum":10000,"description":"Defines the maximum bandwidth allocated for agent content downloads in megabits per second (Mbps). Must be between 20 and 10000 Mbps."},"enable_minor_content_version_updates":{"type":"boolean","default":true,"description":"Enables delivery of minor content updates between major content releases. When `true`, the agents receive more frequent content updates to improve their ability to protect against emerging threats. When `false`, agents receive updates only during major content releases."}}}}}}}}
```

## The AgentStatusResponse object

```json
{"openapi":"3.0.3","info":{"title":"Agent Configuration Settings API","version":"1.0.0"},"components":{"schemas":{"AgentStatusResponse":{"type":"object","description":"Current agent status timeout configuration.","properties":{"reply":{"type":"object","properties":{"license_revocation_after_lost_connection":{"type":"integer","description":"Indicates the current number of days after which the license is revoked when an agent loses connection to Cortex."},"agent_deletion_retention":{"type":"integer","description":"Indicates the number of days to retain agent data before deletion from the Cortex database after loss of connection."}}}}}}}}
```

## The SetAgentStatusRequest object

```json
{"openapi":"3.0.3","info":{"title":"Agent Configuration Settings API","version":"1.0.0"},"components":{"schemas":{"SetAgentStatusRequest":{"type":"object","description":"Request payload for updating agent status timeout configuration.","properties":{"request_data":{"type":"object","required":["license_revocation_after_lost_connection","agent_deletion_retention"],"properties":{"license_revocation_after_lost_connection":{"type":"integer","minimum":2,"maximum":60,"description":"Number of days after which the license is revoked when an agent loses connection to Cortex. Day one is counted as the first 24 hours with no connection.","default":30},"agent_deletion_retention":{"type":"integer","minimum":3,"maximum":360,"description":"Number of days to retain agent data before deletion from the Cortex database after loss of connection. Ensure that this value is greater than the `license_revocation_after_lost_connection` period. Day one is counted as the first 24 hours with no connection.","default":180}}}}}}}}
```

## The AgentAutoUpgradeResponse object

```json
{"openapi":"3.0.3","info":{"title":"Agent Configuration Settings API","version":"1.0.0"},"components":{"schemas":{"AgentAutoUpgradeResponse":{"type":"object","description":"Current agent auto-upgrade configuration.","properties":{"reply":{"type":"object","properties":{"amount_of_parallel_upgrades":{"type":"integer","description":"The current maximum number of agents that can be upgraded simultaneously."}}}}}}}}
```

## The SetAgentAutoUpgradeRequest object

```json
{"openapi":"3.0.3","info":{"title":"Agent Configuration Settings API","version":"1.0.0"},"components":{"schemas":{"SetAgentAutoUpgradeRequest":{"type":"object","description":"Request payload for updating agent auto-upgrade configuration.","properties":{"request_data":{"type":"object","required":["amount_of_parallel_upgrades"],"properties":{"amount_of_parallel_upgrades":{"type":"integer","minimum":1,"maximum":2000,"description":"Specify the desired maximum number of agents to upgrade simultaneously."}}}}}}}}
```

## The WildfireAnalysisResponse object

```json
{"openapi":"3.0.3","info":{"title":"Agent Configuration Settings API","version":"1.0.0"},"components":{"schemas":{"WildfireAnalysisResponse":{"type":"object","description":"Current WildFire analysis configuration.","properties":{"reply":{"type":"object","properties":{"enable_wildfire_analysis_scoring_for_benign_verdicts":{"type":"boolean","description":"Indicates whether WildFire analysis scoring is currently applied to files that received a benign verdict."}}}}}}}}
```

## The SetWildfireAnalysisRequest object

```json
{"openapi":"3.0.3","info":{"title":"Agent Configuration Settings API","version":"1.0.0"},"components":{"schemas":{"SetWildfireAnalysisRequest":{"type":"object","description":"Request payload for updating WildFire analysis configuration.","properties":{"request_data":{"type":"object","required":["enable_wildfire_analysis_scoring_for_benign_verdicts"],"properties":{"enable_wildfire_analysis_scoring_for_benign_verdicts":{"type":"boolean","description":"Set to `true` to enable WildFire analysis scoring for files that received a benign verdict."}}}}}}}}
```

## The InformativeBTPIssuesResponse object

```json
{"openapi":"3.0.3","info":{"title":"Agent Configuration Settings API","version":"1.0.0"},"components":{"schemas":{"InformativeBTPIssuesResponse":{"type":"object","description":"Current informative BTP issues display configuration.","properties":{"reply":{"type":"object","properties":{"display_unique_and_informative_btp_rules":{"type":"boolean","description":"Indicates whether unique and informative Behavioral Threat Protection (BTP) rules are currently displayed in the console."}}}}}}}}
```

## The SetInformativeBTPIssuesRequest object

```json
{"openapi":"3.0.3","info":{"title":"Agent Configuration Settings API","version":"1.0.0"},"components":{"schemas":{"SetInformativeBTPIssuesRequest":{"type":"object","description":"Request payload for updating informative BTP issues display configuration.","properties":{"request_data":{"type":"object","required":["display_unique_and_informative_btp_rules"],"properties":{"display_unique_and_informative_btp_rules":{"type":"boolean","description":"Set to `true` to display unique and informative Behavioral Threat Protection (BTP) rules in the console."}}}}}}}}
```

## The LogCollectionResponse object

```json
{"openapi":"3.0.3","info":{"title":"Agent Configuration Settings API","version":"1.0.0"},"components":{"schemas":{"LogCollectionResponse":{"type":"object","description":"Current Cortex XDR log collection configuration.","properties":{"reply":{"type":"object","properties":{"allow_logs_collection":{"type":"boolean","description":"Indicates whether agents are currently allowed to collect and send diagnostic logs."}}}}}}}}
```

## The SetLogCollectionRequest object

```json
{"openapi":"3.0.3","info":{"title":"Agent Configuration Settings API","version":"1.0.0"},"components":{"schemas":{"SetLogCollectionRequest":{"type":"object","description":"Request payload for updating Cortex XDR log collection configuration.","properties":{"request_data":{"type":"object","required":["allow_logs_collection"],"properties":{"allow_logs_collection":{"type":"boolean","description":"Set to `true` to allow agents to collect and send diagnostic logs."}}}}}}}}
```

## The ActionCenterExpirationResponse object

```json
{"openapi":"3.0.3","info":{"title":"Agent Configuration Settings API","version":"1.0.0"},"components":{"schemas":{"ActionCenterExpirationResponse":{"type":"object","description":"Current action center expiration settings. Keys represent action types and values represent the current expiration durations in hours.","properties":{"reply":{"type":"object","additionalProperties":{"type":"integer","description":"The current expiration duration in hours for the specified action type."}}}}}}}
```

## The SetActionCenterExpirationRequest object

```json
{"openapi":"3.0.3","info":{"title":"Agent Configuration Settings API","version":"1.0.0"},"components":{"schemas":{"SetActionCenterExpirationRequest":{"type":"object","description":"Request payload for updating action center expiration settings. Specify action types as keys and desired expiration durations in hours as values.","properties":{"request_data":{"type":"object","additionalProperties":{"type":"integer","description":"Specify the desired expiration duration in hours for the action type."}}}}}}}
```

## The CriticalEnvironmentVersionsResponse object

```json
{"openapi":"3.0.3","info":{"title":"Agent Configuration Settings API","version":"1.0.0"},"components":{"schemas":{"CriticalEnvironmentVersionsResponse":{"type":"object","description":"Current critical environment versions configuration.","properties":{"reply":{"type":"object","properties":{"enabled_critical_environment_versions":{"type":"boolean","description":"Indicates whether version enforcement is currently enabled for agents in critical environments."}}}}}}}}
```

## The SetCriticalEnvironmentVersionsRequest object

```json
{"openapi":"3.0.3","info":{"title":"Agent Configuration Settings API","version":"1.0.0"},"components":{"schemas":{"SetCriticalEnvironmentVersionsRequest":{"type":"object","description":"Request payload for updating critical environment versions configuration.","properties":{"request_data":{"type":"object","required":["enabled_critical_environment_versions"],"properties":{"enabled_critical_environment_versions":{"type":"boolean","description":"Set to `true` to enable version enforcement for agents in critical environments."}}}}}}}}
```

## The AdvancedAnalysisResponse object

```json
{"openapi":"3.0.3","info":{"title":"Agent Configuration Settings API","version":"1.0.0"},"components":{"schemas":{"AdvancedAnalysisResponse":{"type":"object","description":"Current advanced analysis configuration.","properties":{"reply":{"type":"object","properties":{"automatically_upload_defined_issue_data_files":{"type":"boolean","description":"Indicates whether defined issue data files are currently uploaded automatically for analysis."},"automatically_apply_advanced_analysis_exceptions":{"type":"boolean","description":"Indicates whether advanced analysis exceptions are currently applied automatically."}}}}}}}}
```

## The SetAdvancedAnalysisRequest object

```json
{"openapi":"3.0.3","info":{"title":"Agent Configuration Settings API","version":"1.0.0"},"components":{"schemas":{"SetAdvancedAnalysisRequest":{"type":"object","description":"Request payload for updating advanced analysis configuration.","properties":{"request_data":{"type":"object","required":["automatically_upload_defined_issue_data_files","automatically_apply_advanced_analysis_exceptions"],"properties":{"automatically_upload_defined_issue_data_files":{"type":"boolean","description":"Set to `true` to automatically upload defined issue data files for analysis."},"automatically_apply_advanced_analysis_exceptions":{"type":"boolean","description":"Set to `true` to automatically apply advanced analysis exceptions."}}}}}}}}
```

## The EndpointAdministrationCleanupResponse object

```json
{"openapi":"3.0.3","info":{"title":"Agent Configuration Settings API","version":"1.0.0"},"components":{"schemas":{"EndpointAdministrationCleanupResponse":{"type":"object","description":"Current endpoint administration cleanup configuration.","properties":{"reply":{"type":"object","properties":{"periodic_duplicate_cleanup":{"type":"boolean","description":"Indicates whether periodic cleanup of duplicate endpoints is currently enabled."},"host_name":{"type":"boolean","nullable":true,"description":"Indicates whether hostname is currently used as a criterion for identifying duplicate endpoints. Null when periodic cleanup is disabled."},"ip":{"type":"boolean","nullable":true,"description":"Indicates whether IP address is currently used as a criterion for identifying duplicate endpoints. Null when periodic cleanup is disabled."},"mac":{"type":"boolean","nullable":true,"description":"Indicates whether MAC address is currently used as a criterion for identifying duplicate endpoints. Null when periodic cleanup is disabled."},"time_interval_hours":{"type":"integer","enum":[1,6,24,168],"nullable":true,"description":"The current time interval in hours between cleanup runs. Null when periodic cleanup is disabled.\nValid values: `1` (hourly), `6` (every 6 hours), `24` (daily), `168` (weekly).\n"}}}}}}}}
```

## The SetEndpointAdministrationCleanupRequest object

```json
{"openapi":"3.0.3","info":{"title":"Agent Configuration Settings API","version":"1.0.0"},"components":{"schemas":{"SetEndpointAdministrationCleanupRequest":{"type":"object","description":"Request payload for updating endpoint administration cleanup configuration.","properties":{"request_data":{"type":"object","required":["periodic_duplicate_cleanup"],"properties":{"periodic_duplicate_cleanup":{"type":"boolean","description":"Set to `true` to enable periodic cleanup of duplicate endpoints."},"host_name":{"type":"boolean","nullable":true,"description":"Set to `true` to use hostname as a criterion for identifying duplicate endpoints. Set to null to ignore this criterion."},"ip":{"type":"boolean","nullable":true,"description":"Set to `true` to use IP address as a criterion for identifying duplicate endpoints. Set to null to ignore this criterion."},"mac":{"type":"boolean","nullable":true,"description":"Set to `true` to use MAC address as a criterion for identifying duplicate endpoints. Set to null to ignore this criterion."},"time_interval_hours":{"type":"integer","enum":[1,6,24,168],"nullable":true,"description":"Specify the desired time interval in hours between cleanup runs. Set to null when disabling periodic cleanup.\nValid values: `1` (hourly), `6` (every 6 hours), `24` (daily), `168` (weekly).\n"}}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://cortex-docs.paloaltonetworks.com/xdr-5-api/agent-configuration-settings/models.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.