Skip to content

Commit 145455a

Browse files
Adds description for name field (#18857)
1 parent a45ff79 commit 145455a

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

src/content/docs/logs/get-started/api-configuration.mdx

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@ The `{dataset_id}` argument indicates the log category (such as `http_requests`
2424
| `GET` | Retrieve all jobs for a dataset | [Documentation](/api/resources/logpush/subresources/datasets/subresources/jobs/methods/get/) |
2525
| `GET` | Retrieve all available fields for a dataset | [Documentation](/api/resources/logpush/subresources/datasets/subresources/fields/methods/get/) |
2626
| `PUT` | Update job | [Documentation](/api/resources/logpush/subresources/jobs/methods/update/) |
27-
| `PUT` | Update job name. | [Documentation](/api/resources/logpush/subresources/jobs/methods/update/) |
2827
| `DELETE` | Delete job | [Documentation](/api/resources/logpush/subresources/jobs/methods/delete/) |
2928
| `POST` | Check whether destination exists | [Documentation](/api/resources/logpush/subresources/validate/methods/destination/) |
3029
| `POST` | Get ownership challenge | [Documentation](/api/resources/logpush/subresources/ownership/methods/validate/) |
@@ -169,6 +168,10 @@ Response
169168

170169
:::
171170

171+
## Name
172+
173+
A human-readable, optional job name that does not need to be unique. We recommend choosing a meaningful name, such as the domain name, to help you easily identify and manage your job. You can update the name later if needed.
174+
172175
## Kind
173176

174177
The kind parameter (optional) is used to differentiate between Logpush and Edge Log Delivery jobs. For Logpush jobs, this parameter can be left empty or omitted. For Edge Log Delivery jobs, set `"kind": "edge"`. Currently, Edge Log Delivery is only supported for the `http_requests` dataset.

0 commit comments

Comments
 (0)