Skip to content

[Logs] Adds description for name field #18857

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 19, 2024
Merged

[Logs] Adds description for name field #18857

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 4 additions & 1 deletion src/content/docs/logs/get-started/api-configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ The `{dataset_id}` argument indicates the log category (such as `http_requests`
| `GET` | Retrieve all jobs for a dataset | [Documentation](/api/resources/logpush/subresources/datasets/subresources/jobs/methods/get/) |
| `GET` | Retrieve all available fields for a dataset | [Documentation](/api/resources/logpush/subresources/datasets/subresources/fields/methods/get/) |
| `PUT` | Update job | [Documentation](/api/resources/logpush/subresources/jobs/methods/update/) |
| `PUT` | Update job name. | [Documentation](/api/resources/logpush/subresources/jobs/methods/update/) |
| `DELETE` | Delete job | [Documentation](/api/resources/logpush/subresources/jobs/methods/delete/) |
| `POST` | Check whether destination exists | [Documentation](/api/resources/logpush/subresources/validate/methods/destination/) |
| `POST` | Get ownership challenge | [Documentation](/api/resources/logpush/subresources/ownership/methods/validate/) |
Expand Down Expand Up @@ -169,6 +168,10 @@ Response

:::

## Name

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.

## Kind

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.
Expand Down
Loading