Kibana API

In addition to the APM specific API endpoints, Kibana provides its own REST API which you can use to automate certain aspects of configuring and deploying Kibana. An example is below.

Customize the APM index pattern

As an alternative to updating apm_oss.indexPattern in your kibana.yml configuration file, you can use Kibana’s update object API to update the default APM index pattern on the fly.

The following example sets the default APM app index pattern to some-other-pattern-*:

  1. curl -X PUT "localhost:5601/api/saved_objects/index-pattern/apm_static_index_pattern_id" \ 
  2. -H 'Content-Type: application/json' \
  3. -H 'kbn-xsrf: true' \
  4. -H 'Authorization: Basic ${YOUR_AUTH_TOKEN}' \
  5. -d' {
  6.       "attributes": {
  7.         "title": "some-other-pattern-*", 
  8.       }
  9.     }'

apm_static_index_pattern_id is the internal, hard-coded ID of the APM index pattern. This value should not be changed

Your custom index pattern matcher.

The API returns the following:

  1. {
  2.    "id":"apm_static_index_pattern_id",
  3.    "type":"index-pattern",
  4.    "updated_at":"2020-07-06T22:55:59.555Z",
  5.    "version":"WzYsMV0=",
  6.    "attributes":{
  7.       "title":"some-other-pattern-*"
  8.    }
  9. }

To view the new APM app index pattern, use the GET object API:

  1. curl -X GET "localhost:5601/api/saved_objects/index-pattern/apm_static_index_pattern_id" \ 
  2. -H 'kbn-xsrf: true' \
  3. -H 'Authorization: Basic ${YOUR_AUTH_TOKEN}'

apm_static_index_pattern_id is the internal, hard-coded ID of the APM index pattern.

The API returns the following:

  1. {
  2.   "id":"apm_static_index_pattern_id",
  3.   "type":"index-pattern",
  4.   "updated_at":"2020-07-06T22:55:59.555Z",
  5.   "version":"WzYsMV0=",
  6.   "attributes":{...}
  7.     "fieldFormatMap":"{...}
  8.     "fields":"[{...},{...},...]
  9.     "sourceFilters":"[{\"value\":\"sourcemap.sourcemap\"}]",
  10.     "timeFieldName":"@timestamp",
  11.     "title":"some-other-pattern-*"
  12.    },
  13.    ...
  14. }

More information on Kibana’s API is available in REST API.

Most Popular