Skip to content

Commit 33e3690

Browse files
fix: REST API receiver auth field docs (#3012)
fix auth field inconsistencies
1 parent e7cac20 commit 33e3690

1 file changed

Lines changed: 13 additions & 9 deletions

File tree

receiver/restapireceiver/README.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -53,14 +53,14 @@ Use `auth_mode: none` for public APIs that don't require authentication. No addi
5353

5454
| Field | Type | Default | Required | Description |
5555
|-------|------|---------|----------|-------------|
56-
| `apikey_header_name` | string | | `true` | Header name for API key (required if `auth_mode` is `apikey`) |
57-
| `apikey_value` | string | | `true` | API key value (required if `auth_mode` is `apikey`) |
56+
| `header_name` | string | | `true` | Header name for API key (required if `auth_mode` is `apikey`) |
57+
| `value` | string | | `true` | API key value (required if `auth_mode` is `apikey`) |
5858

5959
#### Bearer Token
6060

6161
| Field | Type | Default | Required | Description |
6262
|-------|------|---------|----------|-------------|
63-
| `bearer_token` | string | | `true` | Bearer token value (required if `auth_mode` is `bearer`) |
63+
| `token` | string | | `true` | Bearer token value (required if `auth_mode` is `bearer`) |
6464

6565
#### Basic Auth
6666

@@ -159,8 +159,9 @@ receivers:
159159
url: "https://api.example.com/events"
160160
max_poll_interval: 10m
161161
auth_mode: apikey
162-
apikey_header_name: "X-API-Key"
163-
apikey_value: "your-api-key-here"
162+
apikey:
163+
header_name: "X-API-Key"
164+
value: "your-api-key-here"
164165
```
165166
166167
### Bearer Token Authentication
@@ -171,7 +172,8 @@ receivers:
171172
url: "https://api.example.com/metrics"
172173
max_poll_interval: 5m
173174
auth_mode: bearer
174-
bearer_token: "your-bearer-token-here"
175+
bearer:
176+
token: "your-bearer-token-here"
175177
```
176178
177179
### Basic Authentication with Pagination
@@ -253,7 +255,8 @@ receivers:
253255
response_field: "items"
254256
max_poll_interval: 15m
255257
auth_mode: bearer
256-
bearer_token: "token"
258+
bearer:
259+
token: "token"
257260
pagination:
258261
mode: timestamp
259262
timestamp:
@@ -278,8 +281,9 @@ receivers:
278281
response_field: "metrics"
279282
max_poll_interval: 1m
280283
auth_mode: apikey
281-
apikey_header_name: "X-API-Key"
282-
apikey_value: "your-api-key-here"
284+
apikey:
285+
header_name: "X-API-Key"
286+
value: "your-api-key-here"
283287
metrics:
284288
name_field: "metric_name"
285289
description_field: "metric_description"

0 commit comments

Comments
 (0)