Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 24 additions & 1 deletion aigw/support/rotate-credentials.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -242,14 +242,37 @@ Create the new credential at the destination, update the AI Gateway configuratio

For [hybrid deployments](/aigw/self-hosting/hybrid-deployments/architecture), rotate every secret in your deployment configuration:

- **`PORTKEY_CLIENT_AUTH`**: the credential your gateway uses to sync with the AI Gateway control plane. Contact Palo Alto Networks support to have it reissued, then update your deployment and restart the gateway.
- **`PORTKEY_CLIENT_AUTH`**: the credential your gateway uses to sync with the AI Gateway control plane. See [Rotate the gateway client auth key](#rotate-the-gateway-client-auth-key).
- **Log store credentials:** for example `LOG_STORE_ACCESS_KEY` and `LOG_STORE_SECRET_KEY` (S3, GCS HMAC, or Azure storage).
- **Cache and database credentials:** Redis, and any database your deployment uses.
- **Provider keys and other values in your environment files, Helm values, or Kubernetes secrets.**
- **Test keys:** replace the `PORTKEY_API_KEY` and `OPENAI_API_KEY` values from any smoke-test scripts.

Redeploy the gateway after updating secrets and confirm it registers and serves requests.

### Rotate the gateway client auth key

<Steps>
<Step title="Open the gateway deployment">
In Strata Cloud Manager, go to **AI Security > AI Gateway > Admin Settings > Gateway Registration** and open the deployment.
</Step>
<Step title="Rotate the key">
Under **Gateway Authentication**, click **Rotate Key**. Optionally, set a **Grace period (hours)** from 0 to 24. This is how long the previous key keeps working. Leave it empty to use the default. Click **Confirm Rotation**.
<Frame>
<img src="/images/support/gateway-rotate-key-grace-period.png" alt="Rotate Key dialog with the Grace period (hours) field" />
</Frame>
</Step>
<Step title="Copy the new key">
Copy the new key and click **Done**. The key is shown only once.
<Frame>
<img src="/images/support/gateway-rotate-key-copy.png" alt="New gateway auth key shown once with a copy button" />
</Frame>
</Step>
<Step title="Update every deployed gateway and Data Service">
Update `PORTKEY_CLIENT_AUTH` to the new key for every gateway and optional Data Service instance that uses this deployment. If your deployment references a secret store, update the underlying credential while preserving secret references and any other fields in the secret. Restart all consuming services so they load the new key before the grace period ends. Services still using the old key lose control-plane authentication once it expires.
</Step>
</Steps>

## After rotating

1. **Confirm the old credentials fail.** Wait at least a few minutes for gateway sync and caches to refresh, then send a request with each old AI Gateway API key through every gateway, including self-hosted ones. Expect a `401`.
Expand Down
Loading