Skip to content

Commit 1ebd18c

Browse files
authored
docs: Document AGENT_CONTROL_RUNTIME_TOKEN_HEADER (#42)
## Describe your changes Added `AGENT_CONTROL_RUNTIME_TOKEN_HEADER` to the **Configuration** page. ## Jira ticket https://splunk.atlassian.net/browse/O11YDOCS-8543 ## Checklist before requesting a review - [X] - Is this ready for review? If not, raise as a draft PR - [X] - This deployed to a staging environment correctly - [X] - I have reviewed my changes - [x] - I have reviewed the deployed version of my changes - [X] - I have tested any code that is added or updated - [ ] - I have verified all images and videos are clear, with appropriate zoom - [ ] - I have verified all images and videos match production (or dev for unreleased features) - [ ] - I have tested that the content matches the functionality in production (or dev for unreleased features) - [x] - All checks have passed - [X] - This references a feature that is public. If not, add a note and we can schedule the merge for after the feature release
1 parent 752a7fa commit 1ebd18c

1 file changed

Lines changed: 32 additions & 0 deletions

File tree

‎core/configuration.mdx‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ icon: "gear"
1010
|----------|---------|-------------|
1111
| `AGENT_CONTROL_URL` | `http://localhost:8000` | Server URL |
1212
| `AGENT_CONTROL_API_KEY` | — | API key for authentication |
13+
| `AGENT_CONTROL_RUNTIME_TOKEN_HEADER` | `Authorization` | Header used to send runtime tokens. Must match the server setting. |
1314

1415
For server database configuration, use the `AGENT_CONTROL_DB_*` variables in the server section below.
1516

@@ -27,6 +28,37 @@ For server database configuration, use the `AGENT_CONTROL_DB_*` variables in the
2728
| `API_VERSION` | `v1` | API version prefix |
2829
| `API_PREFIX` | `/api` | API path prefix |
2930

31+
### Runtime Token
32+
33+
| Variable | Default | Description |
34+
|----------|---------|-------------|
35+
| `AGENT_CONTROL_RUNTIME_TOKEN_HEADER` | `Authorization` | Header from which the server reads runtime tokens. Must match the SDK setting. |
36+
37+
By default, the SDK sends the runtime token in the `Authorization` header as `Authorization: Bearer <runtime-token>`.
38+
39+
If a gateway reserves `Authorization` for its own identity credential, configure the server and SDK to use a dedicated header:
40+
41+
```bash
42+
export AGENT_CONTROL_RUNTIME_TOKEN_HEADER="X-Agent-Control-Runtime-Token"
43+
```
44+
45+
With this setting, Agent Control SDK 8.5.0 or later sends the runtime token in `X-Agent-Control-Runtime-Token` as a raw token without a `Bearer` prefix. `Authorization` remains available for gateway authentication.
46+
47+
You can alternatively set the header when initializing the SDK:
48+
49+
```python
50+
agent_control.init(
51+
agent_name="my-agent",
52+
runtime_token_header="X-Agent-Control-Runtime-Token",
53+
)
54+
```
55+
56+
If `runtime_token_header` is not provided, the SDK uses `AGENT_CONTROL_RUNTIME_TOKEN_HEADER`. If neither is configured, it defaults to `Authorization`.
57+
58+
<Note>
59+
Upgrading to version 8.5.0 or later does not change the default header. A dedicated header is used only after you configure the environment variable or the SDK option.
60+
</Note>
61+
3062
### CORS
3163

3264
| Variable | Default | Description |

0 commit comments

Comments
 (0)