docs: add more api information (#68717) (#68865)

elastic · Jun 11, 2020 · 1678e7e · 1678e7e
1 parent 5c916a5
commit 1678e7e
Show file tree

Hide file tree

Showing 2 changed files with 71 additions and 26 deletions.
diff --git a/docs/apm/api.asciidoc b/docs/apm/api.asciidoc
@@ -15,8 +15,39 @@ Some APM app features are provided via a REST API:
 [[apm-api-example]]
 === Using the APIs
 
-Users interacting with APM APIs must have <<apm-app-api-user,sufficient privileges>>.
-In addition, there are request headers to be aware of, like `kbn-xsrf: true`, and `Content-Type: applicaton/json`.
+// The following content is reused throughout the API docs
+// tag::using-the-APIs[]
+Interact with APM APIs using cURL or another API tool.
+All APM APIs are Kibana APIs, not Elasticsearch APIs;
+because of this, the Kibana dev tools console cannot be used to interact with APM APIs.
+
+For all APM APIs, you must use a request header.
+Supported headers are `Authorization`, `kbn-xsrf`, and `Content-Type`.
+
+`Authorization: ApiKey {credentials}`::
+Kibana supports token-based authentication with the Elasticsearch API key service.
+The API key returned by the  {ref}/security-api-create-api-key.html[Elasticsearch create API key API]
+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.
++
+Alternatively, you can create a user and use their username and password to authenticate API access: `-u $USER:$PASSWORD`.
++
+Whether using `Authorization: ApiKey {credentials}`, or `-u $USER:$PASSWORD`,
+users interacting with APM APIs must have <<apm-app-api-user,sufficient privileges>>.
+
+`kbn-xsrf: true`::
+  By default, you must use `kbn-xsrf` for all API calls, except in the following scenarios:
+
+* The API endpoint uses the `GET` or `HEAD` operations
+* The path is whitelisted using the <<settings, `server.xsrf.whitelist`>> setting
+* XSRF protections are disabled using the `server.xsrf.disableProtection` setting
+
+`Content-Type: application/json`::
+  Applicable only when you send a payload in the API request.
+  {kib} API requests and responses use JSON.
+  Typically, if you include the `kbn-xsrf` header, you must also include the `Content-Type` header.
+// end::using-the-APIs[]
+
 Here's an example CURL request that adds an annotation to the APM app:
 
 [source,curl]
@@ -38,9 +69,6 @@ curl -X POST \
     }'
 ----
 
-The Kibana <<api,REST API reference>> provides additional information on how to use Kibana APIs,
-required request headers, and token-based authentication options.
-
 ////
 *******************************************************
 ////
@@ -59,7 +87,15 @@ The following Agent configuration APIs are available:
 * <<apm-list-config>> to list all Agent configurations.
 * <<apm-search-config>> to search for an Agent configuration.
 
-See <<apm-app-api-config-manager>> for information on the privileges required to use this API endpoint.
+[float]
+[[use-agent-config-api]]
+==== How to use APM APIs
+
+.Expand for required headers, privileges, and usage details
+[%collapsible%closed]
+======
+include::api.asciidoc[tag=using-the-APIs]
+======
 
 ////
 *******************************************************
@@ -100,7 +136,7 @@ See <<apm-app-api-config-manager>> for information on the privileges required to
 [[apm-update-config-example]]
 ===== Example
 
-[source,console]
+[source,curl]
 --------------------------------------------------
 PUT /api/apm/settings/agent-configuration
 {
@@ -150,7 +186,7 @@ PUT /api/apm/settings/agent-configuration
 [[apm-delete-config-example]]
 ===== Example
 
-[source,console]
+[source,curl]
 --------------------------------------------------
 DELETE /api/apm/settings/agent-configuration
 {
@@ -228,7 +264,7 @@ DELETE /api/apm/settings/agent-configuration
 [[apm-list-config-example]]
 ===== Example
 
-[source,console]
+[source,curl]
 --------------------------------------------------
 GET  /api/apm/settings/agent-configuration
 --------------------------------------------------
@@ -293,7 +329,7 @@ GET  /api/apm/settings/agent-configuration
 [[apm-search-config-example]]
 ===== Example
 
-[source,console]
+[source,curl]
 --------------------------------------------------
 POST /api/apm/settings/agent-configuration/search
 {
@@ -317,17 +353,25 @@ POST /api/apm/settings/agent-configuration/search
 The Annotation API allows you to annotate visualizations in the APM app with significant events, like deployments,
 allowing you to easily see how these events are impacting the performance of your existing applications.
 
+By default, annotations are stored in a newly created `observability-annotations` index.
+The name of this index can be changed in your `config.yml` by editing `xpack.observability.annotations.index`.
+
 The following APIs are available:
 
 * <<apm-annotation-create>> to create an annotation for APM.
 // * <<obs-annotation-create>> POST /api/observability/annotation
 // * <<obs-annotation-get>> GET /api/observability/annotation/:id
 // * <<obs-annotation-delete>> DELETE /api/observability/annotation/:id
 
-By default, annotations are stored in a newly created `observability-annotations` index.
-The name of this index can be changed in your `config.yml` by editing `xpack.observability.annotations.index`.
+[float]
+[[use-annotation-api]]
+==== How to use APM APIs
 
-See <<apm-app-api-annotation-manager>> for information on the privileges required to use this API endpoint.
+.Expand for required headers, privileges, and usage details
+[%collapsible%closed]
+======
+include::api.asciidoc[tag=using-the-APIs]
+======
 
 ////
 *******************************************************
@@ -374,19 +418,20 @@ While you can add additional tags, you cannot remove the `apm` tag.
 
 The following example creates an annotation for a service named `opbeans-java`.
 
-[source,console]
+[source,curl]
 --------------------------------------------------
-POST /api/apm/services/opbeans-java/annotation
-{
-	"@timestamp": "2020-05-08T10:31:30.452Z",
-	"service": {
-		"version": "1.2"
-	},
-	"message": "Deployment 1.2",
-	"tags": [
-		"elastic.co", "customer"
-	]
-}
+curl -X POST \
+  http://localhost:5601/api/apm/services/opbeans-java/annotation \
+-H 'Content-Type: application/json' \
+-H 'kbn-xsrf: true' \
+-H 'Authorization: Basic YhUlubWZhM0FDbnlQeE6WRtaW49FQmSGZ4RUWXdX' \
+-d '{
+      "@timestamp": "2020-05-08T10:31:30.452Z",
+      "service": {
+        "version": "1.2"
+      },
+      "message": "Deployment 1.2"
+    }'
 --------------------------------------------------
 
 [[apm-annotation-config-body]]

diff --git a/docs/apm/deployment-annotations.asciidoc b/docs/apm/deployment-annotations.asciidoc
@@ -18,7 +18,7 @@ Alternatively, you can explicitly create deployment annotations with our annotat
 The API can integrate into your CI/CD pipeline,
 so that each time you deploy, a POST request is sent to the annotation API endpoint:
 
-[source,console]
+[source,curl]
 ----
 curl -X POST \
   http://localhost:5601/api/apm/services/${SERVICE_NAME}/annotation \ <1>