You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: solutions/observability/apps/agent-configuration-api.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,7 +23,7 @@ Interact with APM APIs using cURL or another API tool. All APM APIs are Kibana A
23
23
For all APM APIs, you must use a request header. Supported headers are `Authorization`, `kbn-xsrf`, and `Content-Type`.
24
24
25
25
`Authorization: ApiKey {{credentials}}`
26
-
: Kibana supports token-based authentication with the Elasticsearch API key service. The API key returned by the [Elasticsearch create API key API](https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html) can be used by sending a request with an `Authorization` header that has a value of `ApiKey` followed by the `{{credentials}}`, where `{{credentials}}` is the base64 encoding of `id` and `api_key` joined by a colon.
26
+
: Kibana supports token-based authentication with the Elasticsearch API key service. The API key returned by the [Elasticsearch create API key API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-api-key) can be used by sending a request with an `Authorization` header that has a value of `ApiKey` followed by the `{{credentials}}`, where `{{credentials}}` is the base64 encoding of `id` and `api_key` joined by a colon.
27
27
28
28
Alternatively, you can create a user and use their username and password to authenticate API access: `-u $USER:$PASSWORD`.
Copy file name to clipboardExpand all lines: solutions/observability/apps/annotation-api.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,7 +22,7 @@ Interact with APM APIs using cURL or another API tool. All APM APIs are Kibana A
22
22
For all APM APIs, you must use a request header. Supported headers are `Authorization`, `kbn-xsrf`, and `Content-Type`.
23
23
24
24
`Authorization: ApiKey {{credentials}}`
25
-
: Kibana supports token-based authentication with the Elasticsearch API key service. The API key returned by the [Elasticsearch create API key API](https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html) can be used by sending a request with an `Authorization` header that has a value of `ApiKey` followed by the `{{credentials}}`, where `{{credentials}}` is the base64 encoding of `id` and `api_key` joined by a colon.
25
+
: Kibana supports token-based authentication with the Elasticsearch API key service. The API key returned by the [Elasticsearch create API key API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-api-key) can be used by sending a request with an `Authorization` header that has a value of `ApiKey` followed by the `{{credentials}}`, where `{{credentials}}` is the base64 encoding of `id` and `api_key` joined by a colon.
26
26
27
27
Alternatively, you can create a user and use their username and password to authenticate API access: `-u $USER:$PASSWORD`.
Copy file name to clipboardExpand all lines: solutions/observability/apps/api-keys.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -241,7 +241,7 @@ A full list of `apikey` subcommands and flags is available in the [API key comma
241
241
242
242
### {{es}} API key workflow [apm-create-api-key-workflow-es]
243
243
244
-
It is also possible to create API keys using the {{es}} [create API key API](https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html).
244
+
It is also possible to create API keys using the {{es}} [create API key API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-api-key).
245
245
246
246
This example creates an API key named `java-002`:
247
247
@@ -286,7 +286,7 @@ The `credential` string, which is what agents use to communicate with APM Server
You can verify your API key has been base64-encoded correctly with the [Authenticate API](https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-authenticate.html):
289
+
You can verify your API key has been base64-encoded correctly with the [Authenticate API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-authenticate):
Copy file name to clipboardExpand all lines: solutions/observability/apps/apm-agent-key-api.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,7 @@ Interact with APM APIs using cURL or another API tool. All APM APIs are Kibana A
20
20
For all APM APIs, you must use a request header. Supported headers are `Authorization`, `kbn-xsrf`, and `Content-Type`.
21
21
22
22
`Authorization: ApiKey {{credentials}}`
23
-
: Kibana supports token-based authentication with the Elasticsearch API key service. The API key returned by the [Elasticsearch create API key API](https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html) can be used by sending a request with an `Authorization` header that has a value of `ApiKey` followed by the `{{credentials}}`, where `{{credentials}}` is the base64 encoding of `id` and `api_key` joined by a colon.
23
+
: Kibana supports token-based authentication with the Elasticsearch API key service. The API key returned by the [Elasticsearch create API key API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-api-key) can be used by sending a request with an `Authorization` header that has a value of `ApiKey` followed by the `{{credentials}}`, where `{{credentials}}` is the base64 encoding of `id` and `api_key` joined by a colon.
24
24
25
25
Alternatively, you can create a user and use their username and password to authenticate API access: `-u $USER:$PASSWORD`.
Copy file name to clipboardExpand all lines: solutions/observability/apps/apm-ui-api.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,7 @@ Interact with APM APIs using cURL or another API tool. All APM APIs are Kibana A
20
20
For all APM APIs, you must use a request header. Supported headers are `Authorization`, `kbn-xsrf`, and `Content-Type`.
21
21
22
22
`Authorization: ApiKey {{credentials}}`
23
-
: Kibana supports token-based authentication with the Elasticsearch API key service. The API key returned by the [Elasticsearch create API key API](https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html) can be used by sending a request with an `Authorization` header that has a value of `ApiKey` followed by the `{{credentials}}`, where `{{credentials}}` is the base64 encoding of `id` and `api_key` joined by a colon.
23
+
: Kibana supports token-based authentication with the Elasticsearch API key service. The API key returned by the [Elasticsearch create API key API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-api-key) can be used by sending a request with an `Authorization` header that has a value of `ApiKey` followed by the `{{credentials}}`, where `{{credentials}}` is the base64 encoding of `id` and `api_key` joined by a colon.
24
24
25
25
Alternatively, you can create a user and use their username and password to authenticate API access: `-u $USER:$PASSWORD`.
Copy file name to clipboardExpand all lines: solutions/observability/apps/control-access-to-apm-data.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -49,7 +49,7 @@ To separate `staging` and `production` APM data, we’d need to create six filte
49
49
50
50
The `production-<event>-apm` aliases will contain a filter that only provides access to documents where the `service.environment` is `production`. Similarly, the `staging-<event>-apm` aliases will contain a filter that only provides access to documents where the `service.environment` is `staging`.
51
51
52
-
To create these six filtered aliases, use the {{es}} [Aliases API](https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-aliases.html). In {{kib}}, open **Dev Tools** and run the following POST requests.
52
+
To create these six filtered aliases, use the {{es}} [Aliases API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-update-aliases). In {{kib}}, open **Dev Tools** and run the following POST requests.
53
53
54
54
::::{dropdown} `traces-apm*` production alias example
55
55
```console
@@ -271,7 +271,7 @@ Using the table below, assign each role the following privileges:
271
271
:class: screenshot
272
272
:::
273
273
274
-
Alternatively, you can use the {{es}} [Create or update roles API](https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role.html):
274
+
Alternatively, you can use the {{es}} [Create or update roles API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-put-role):
275
275
276
276
::::{dropdown} Create a `production_apm_viewer` role
277
277
This request creates a `production_apm_viewer` role:
@@ -350,7 +350,7 @@ The last thing to do is assign users to the newly created roles above. Users wil
350
350
351
351
For information on how to create users and assign them roles with the {{kib}} UI, see [Securing access to Kibana](../../../deploy-manage/users-roles/cluster-or-deployment-auth/quickstart.md).
352
352
353
-
Alternatively, you can use the {{es}} [Create or update users API](https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-user.html).
353
+
Alternatively, you can use the {{es}} [Create or update users API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-put-user).
354
354
355
355
This example creates a new user and assigns them the `production_apm_viewer` role created in the previous step. This user will only have access to the production space and data with a `service.environment` of `production`. Remember to change the `password`, `full_name`, and `email` fields.
Copy file name to clipboardExpand all lines: solutions/observability/apps/create-assign-feature-roles-to-apm-server-users.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -95,7 +95,7 @@ The privileges included in this role are **required** for all users when [centra
95
95
$$$apm-privileges-agent-central-config-server$$$
96
96
APM Server acts as a proxy between your APM agents and the Applications UI. The Applications UI communicates any changed settings to APM Server so that your agents only need to poll the Server to determine which central configuration settings have changed.
97
97
98
-
To create a role with the required privileges for managing central configuration in {{es}} without {{kib}}, you must use the [Roles API](https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role.html) (the required privileges can’t be assigned to a role in Kibana):
98
+
To create a role with the required privileges for managing central configuration in {{es}} without {{kib}}, you must use the [Roles API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-put-role) (the required privileges can’t be assigned to a role in Kibana):
Copy file name to clipboardExpand all lines: solutions/observability/apps/custom-filters.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -57,7 +57,7 @@ To obfuscate the passwords stored in the request body, you can use a series of [
57
57
### Create a pipeline [_create_a_pipeline]
58
58
59
59
::::{tip}
60
-
This tutorial uses the [Ingest APIs](https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest-apis.html), but it’s also possible to create a pipeline using the UI. In Kibana, go to **Stack Management** → **Ingest Pipelines** → **Create pipeline** → **New pipeline** or use the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md).
60
+
This tutorial uses the [Ingest APIs](https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-ingest), but it’s also possible to create a pipeline using the UI. In Kibana, go to **Stack Management** → **Ingest Pipelines** → **Create pipeline** → **New pipeline** or use the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md).
61
61
::::
62
62
63
63
@@ -140,7 +140,7 @@ Finally, use the [remove processor](https://www.elastic.co/guide/en/elasticsearc
140
140
141
141
#### Register the pipeline [_register_the_pipeline]
142
142
143
-
Then put it all together, and use the [create or update pipeline API](https://www.elastic.co/guide/en/elasticsearch/reference/current/put-pipeline-api.html) to register the new pipeline in {{es}}. Name the pipeline `apm_redacted_body_password`:
143
+
Then put it all together, and use the [create or update pipeline API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ingest-put-pipeline) to register the new pipeline in {{es}}. Name the pipeline `apm_redacted_body_password`:
144
144
145
145
```console
146
146
PUT _ingest/pipeline/apm_redacted_body_password
@@ -184,7 +184,7 @@ PUT _ingest/pipeline/apm_redacted_body_password
184
184
185
185
### Test the pipeline [_test_the_pipeline]
186
186
187
-
Prior to enabling this new pipeline, you can test it with the [simulate pipeline API](https://www.elastic.co/guide/en/elasticsearch/reference/current/simulate-pipeline-api.html). This API allows you to run multiple documents through a pipeline to ensure it is working correctly.
187
+
Prior to enabling this new pipeline, you can test it with the [simulate pipeline API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ingest-simulate). This API allows you to run multiple documents through a pipeline to ensure it is working correctly.
188
188
189
189
The request below simulates running three different documents through the pipeline:
190
190
@@ -295,7 +295,7 @@ The final step in this process is to call the newly created `apm_redacted_body_p
295
295
296
296
To match a custom ingest pipeline with a data stream, follow the `<type>-<dataset>@custom` template, or replace `-namespace` with `@custom` in the table above. For example, to target application traces, you’d create a pipeline named `traces-apm@custom`.
297
297
298
-
Use the [create or update pipeline API](https://www.elastic.co/guide/en/elasticsearch/reference/current/put-pipeline-api.html) to register the new pipeline in {{es}}. Name the pipeline `traces-apm@custom`:
298
+
Use the [create or update pipeline API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ingest-put-pipeline) to register the new pipeline in {{es}}. Name the pipeline `traces-apm@custom`:
Copy file name to clipboardExpand all lines: solutions/observability/apps/delete-sensitive-data.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,7 +17,7 @@ If you accidentally ingest sensitive data, follow these steps to remove or redac
17
17
18
18
## Redact specific fields [apm-redact-field-data]
19
19
20
-
To redact sensitive data in a specific field, use the [update by query API](https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-update-by-query.html).
20
+
To redact sensitive data in a specific field, use the [update by query API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-update-by-query).
21
21
22
22
For example, the following query removes the `client.ip` address from APM documents in the `logs-apm.error-default` data stream:
23
23
@@ -59,17 +59,17 @@ POST /logs-apm.error-default/_update_by_query
59
59
}
60
60
```
61
61
62
-
See [update by query API](https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-update-by-query.html) for more information and examples.
62
+
See [update by query API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-update-by-query) for more information and examples.
63
63
64
64
65
65
## Delete {{es}} documents [apm-delete-doc-data]
66
66
67
67
::::{warning}
68
-
This will permanently delete your data. You should test your queries with the [search API](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-search.html) prior to deleting data.
68
+
This will permanently delete your data. You should test your queries with the [search API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search) prior to deleting data.
69
69
::::
70
70
71
71
72
-
To delete an {{es}} document, you can use the [delete by query API](https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete-by-query.html).
72
+
To delete an {{es}} document, you can use the [delete by query API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-delete-by-query).
73
73
74
74
For example, to delete all documents in the `apm-traces-*` data stream with a `user.email` value, run the following query:
75
75
@@ -84,5 +84,5 @@ POST /apm-traces-*/_delete_by_query
84
84
}
85
85
```
86
86
87
-
See [delete by query API](https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete-by-query.html) for more information and examples.
87
+
See [delete by query API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-delete-by-query) for more information and examples.
0 commit comments