> 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/cortex-xdr-5.x/reference-and-developer-docs/role-based-access-control/configuration-permissions/public-api.md).

# Public API

Configure permissions for the Cortex XDR public API.

Controls access to API key management for external integrations. This includes creating, viewing, editing, and revoking API keys that allow external systems to interact with Cortex XDR in **Settings → Configurations → Integrations → API Keys**. The Public API permissions also manage access to the Compute Unit Usage page.

### Error Handling

Any API call attempting to fetch, list, or modify stored secrets using a restricted key will return a 403 Forbidden error with an Insufficient permissions message. This ensures that automated workflows, scripts, and CLI interactions follow a strict least-privilege model.

| Permission | Description                                                                                                                                                                                                                                                                                                                               | Roles Example                                                                                                                                 |
| ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| None       | <p>The user cannot see the API Keys page or view or manage the Compute Unit Usage page.</p><ul><li><strong>Access level</strong>: 403 Forbidden</li><li><strong>Capabilities</strong>: All credential endpoints are blocked. Automated workflows, scripts, and CLI interactions cannot view, list, or reference stored secrets.</li></ul> | SOC Tier-1 Analyst: No need for API or Compute Unit Usage page access.                                                                        |
| View       | The user can view the list of existing API keys but cannot create, edit, or delete them. The user can view the Compute Unit Usage page, but cannot edit the daily compute unit limit.                                                                                                                                                     | <ul><li>SOC Tier-2 and 3 Analysts: May need to verify API integrations.</li><li>Threat Hunter: Review API integrations for hunting.</li></ul> |
| View/Edit  | The user has full control over API keys, including creating, editing, and deleting them. The user can view the Compute Unit Usage page and edit the daily compute unit limit.                                                                                                                                                             | Security Engineer: Develop and manage API integrations. Manage daily usage of compute units.                                                  |

#### Required and recommended permissions

As API keys are often used to bridge data between modules, consider the following dependencies:

| Permission   | Permission Level | Reason                                                                                                     |
| ------------ | ---------------- | ---------------------------------------------------------------------------------------------------------- |
| Audit        | View             | Strongly recommended to track API key creation, modification, and deletion events for security compliance. |
| Integrations | View             | Recommended to understand which integrations use API keys for data collection.                             |
| Credentials  | View             | Recommended to view credentials that may be associated with API-based integrations.                        |


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://cortex-docs.paloaltonetworks.com/cortex-xdr-5.x/reference-and-developer-docs/role-based-access-control/configuration-permissions/public-api.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.