Skip to content
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

Add API delete curl examples #6680

Merged
merged 5 commits into from
Jul 14, 2022
Merged

Add API delete curl examples #6680

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4ae21a5
Add API delete curl examples
KMiller-Grafana Jul 14, 2022
9e87261
Update docs/sources/api/_index.md
KMiller-Grafana Jul 14, 2022
ce32ec6
Update docs/sources/api/_index.md
KMiller-Grafana Jul 14, 2022
949eaba
Update docs/sources/api/_index.md
KMiller-Grafana Jul 14, 2022
14825bf
Update docs/sources/api/_index.md
KMiller-Grafana Jul 14, 2022
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
38 changes: 34 additions & 4 deletions docs/sources/api/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1036,6 +1036,10 @@ Query parameters:

A 204 response indicates success.

The query parameter can also include filter operations. For example `query={foo="bar"} |= "other"` will filter out lines that contain the string "other" for the streams matching the stream selector `{foo="bar"}`.

#### Examples

URL encode the `query` parameter. This sample form of a cURL command URL encodes `query={foo="bar"}`:

```bash
Expand All @@ -1044,7 +1048,13 @@ curl -g -X POST \
-H 'X-Scope-OrgID: 1'
```

The query parameter can also include filter operations. For example `query={foo="bar"} |= "other"` will filter out lines that contain the string "other" for the streams matching the stream selector `{foo="bar"}`.
The same example deletion request for Grafana Enterprise Logs uses Basic Authentication and specifies the tenant name as a user; `Tenant1` is the tenant name in this example. The password in this example is an access policy token that has been defined in the API_TOKEN environment variable. The token must be for an access policy with `logs:delete` scope for the tenant specified in the user field:

```bash
curl -u "Tenant1:$API_TOKEN" \
-g -X POST \
'http://127.0.0.1:3100/loki/api/v1/delete?query={foo="bar"}&start=1591616227&end=1591619692'
Copy link
Contributor

@MichelHollands MichelHollands Jul 15, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We've found out that running these kinds of post requests in bash causes problems with escaping the &, = and characters. The --data-urlencode parameter for curl is preferred. https://github.com/grafana/deployment_tools/blob/master/docs/loki/support-escalation.md#manual-operational-tasks has an example. Perhaps we should use that format.

```

### List log deletion requests

Expand All @@ -1062,15 +1072,25 @@ List the existing delete requests using the following API:
GET /loki/api/v1/delete
```

Sample form of a cURL command:
This endpoint returns both processed and unprocessed deletion requests. It does not list canceled requests, as those requests will have been removed from storage.

#### Examples

Example cURL command:

```
curl -X GET \
<compactor_addr>/loki/api/v1/delete \
-H 'X-Scope-OrgID: <orgid>'
```

This endpoint returns both processed and unprocessed requests. It does not list canceled requests, as those requests will have been removed from storage.
The same example deletion request for Grafana Enterprise Logs uses Basic Authentication and specifies the tenant name as a user; `Tenant1` is the tenant name in this example. The password in this example is an access policy token that has been defined in the API_TOKEN environment variable. The token must be for an access policy with `logs:delete` scope for the tenant specified in the user field.

```bash
curl -u "Tenant1:$API_TOKEN" \
-X GET \
<compactor_addr>/loki/api/v1/delete
```

### Request cancellation of a delete request

Expand All @@ -1096,14 +1116,24 @@ Query parameters:

A 204 response indicates success.

Sample form of a cURL command:
#### Examples

Example cURL command:

```
curl -X DELETE \
'<compactor_addr>/loki/api/v1/delete?request_id=<request_id>' \
-H 'X-Scope-OrgID: <tenant-id>'
```

The same example deletion cancellation request for Grafana Enterprise Logs uses Basic Authentication and specifies the tenant name as a user; `Tenant1` is the tenant name in this example. The password in this example is an access policy token that has been defined in the API_TOKEN environment variable. The token must be for an access policy with `logs:delete` scope for the tenant specified in the user field.

```bash
curl -u "Tenant1:$API_TOKEN" \
-X DELETE \
'<compactor_addr>/loki/api/v1/delete?request_id=<request_id>'
```

## Deprecated endpoints

### `GET /api/prom/tail`
Expand Down