> 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/broker-vm-tenant-side/broker-papi-tables.md).

# Additional References

## Action Statuses

Used by the [**Get Action Status**](/xdr-5-api/broker-vm-tenant-side/broker-vm-tenant-overview.md#getActionStatus) endpoint to describe the possible statuses for a Broker VM action.

| Status          | Meaning                                                  |
| --------------- | -------------------------------------------------------- |
| `SUBMITTED`     | Accepted by the tenant; not yet delivered to the broker. |
| `IN_PROGRESS`   | Delivered to the broker, being applied.                  |
| `COMPLETED`     | Successfully applied.                                    |
| `UP_TO_DATE`    | No-op; broker was already in the requested state.        |
| `FAILED`        | Could not be applied; inspect broker status for details. |
| `NOT_AVAILABLE` | Action ID unknown or expired from the actions table.     |

## Broker Applet Configuration Schemas

Used by the [**Applet Configuration**](/xdr-5-api/broker-vm-tenant-side/broker-vm-tenant-overview.md#getApplet) endpoints to list the supported applets and their corresponding configuration schemas.

| `applet_name`          | Purpose                                | Request schema             | GET response schema                   |
| ---------------------- | -------------------------------------- | -------------------------- | ------------------------------------- |
| `syslog`               | Syslog ingestion (UDP/TCP/secure\_TCP) | `SyslogConfig`             | `SyslogGetConfigResponse`             |
| `kafka`                | Kafka topic ingestion                  | `KafkaConfig`              | `KafkaGetConfigResponse`              |
| `db`                   | Database query ingestion               | `DbCollectorConfig`        | `DbCollectorGetConfigResponse`        |
| `ftp`                  | FTP / SFTP / FTPS file collection      | `FtpConfig`                | `FtpGetConfigResponse`                |
| `file`                 | Generic shared-folder log collection   | `FileConfig`               | `FileGetConfigResponse`               |
| `csv`                  | CSV-specific shared-folder collection  | `CsvConfig`                | `CsvGetConfigResponse`                |
| `wec`                  | Windows Event Collector                | `WecConfig`                | `WecGetConfigResponse`                |
| `netflow`              | Netflow data sources (UDP per-port)    | `NetflowConfig`            | `NetflowGetConfigResponse`            |
| `network_mapper`       | Network mapping / port scanning        | `NetworkMapperConfig`      | `NetworkMapperGetConfigResponse`      |
| `local_agent_settings` | Local agent proxy + content caching    | `LocalAgentSettingsConfig` | `LocalAgentSettingsGetConfigResponse` |

## Broker Log Bundle Status Codes

Used by the [**Get Log Bundle Status**](/xdr-5-api/broker-vm-tenant-side/broker-vm-tenant-overview.md#getLogBundleStatus) endpoint to explain the status codes returned when requesting a log bundle from a Broker VM.

| `code`                          | Meaning                                                                                                                    |
| ------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
| `LogRequestInProgress`          | Request submitted or pulled by the broker; not yet completed.                                                              |
| `LogRequestSucceeded`           | Bundle ready for download.                                                                                                 |
| `LogRequestTimedout`            | Broker did not produce the bundle in time.                                                                                 |
| `LogBundleCollectionInVMFailed` | The broker reported a failure during collection, or no usable request row exists (error / never requested / already GC'd). |


---

# 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/broker-vm-tenant-side/broker-papi-tables.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.