mirror of
https://github.com/elastic/kibana.git
synced 2025-04-23 17:28:26 -04:00
* Collapses content in Kibana and APM APIs * Update docs/api/role-management/put.asciidoc Co-Authored-By: Lisa Cawley <lcawley@elastic.co> * Update docs/api/spaces-management/copy_saved_objects.asciidoc Co-Authored-By: Lisa Cawley <lcawley@elastic.co> * Update docs/api/spaces-management/copy_saved_objects.asciidoc Co-Authored-By: Lisa Cawley <lcawley@elastic.co> * Update docs/api/spaces-management/copy_saved_objects.asciidoc Co-Authored-By: Lisa Cawley <lcawley@elastic.co> * Update docs/api/spaces-management/copy_saved_objects.asciidoc Co-Authored-By: Lisa Cawley <lcawley@elastic.co> * Update docs/api/spaces-management/copy_saved_objects.asciidoc Co-Authored-By: Lisa Cawley <lcawley@elastic.co> * Update docs/api/spaces-management/copy_saved_objects.asciidoc Co-Authored-By: Lisa Cawley <lcawley@elastic.co> * Update docs/api/spaces-management/resolve_copy_saved_objects_conflicts.asciidoc Co-Authored-By: Lisa Cawley <lcawley@elastic.co> * Update docs/api/spaces-management/resolve_copy_saved_objects_conflicts.asciidoc Co-Authored-By: Lisa Cawley <lcawley@elastic.co> * Update docs/api/spaces-management/resolve_copy_saved_objects_conflicts.asciidoc Co-Authored-By: Lisa Cawley <lcawley@elastic.co> * Update docs/api/spaces-management/resolve_copy_saved_objects_conflicts.asciidoc Co-Authored-By: Lisa Cawley <lcawley@elastic.co> * Update docs/api/spaces-management/resolve_copy_saved_objects_conflicts.asciidoc Co-Authored-By: Lisa Cawley <lcawley@elastic.co> * Update docs/api/spaces-management/resolve_copy_saved_objects_conflicts.asciidoc Co-Authored-By: Lisa Cawley <lcawley@elastic.co> * Update docs/api/spaces-management/resolve_copy_saved_objects_conflicts.asciidoc Co-Authored-By: Lisa Cawley <lcawley@elastic.co> * Update docs/api/spaces-management/resolve_copy_saved_objects_conflicts.asciidoc Co-Authored-By: Lisa Cawley <lcawley@elastic.co> Co-authored-by: Lisa Cawley <lcawley@elastic.co> Co-authored-by: Lisa Cawley <lcawley@elastic.co>
This commit is contained in:
Kaarina Tungseth
GitHub
parent
4dd098b416
commit
c7d466e6c4
4 changed files with 349 additions and 8 deletions
|
|
@ -17,6 +17,7 @@ experimental[] Create a new {kib} role, or update the attributes of an existing
|
|||
|
||||
To use the create or update role API, you must have the `manage_security` cluster privilege.
|
||||
|
||||
[role="child_attributes"]
|
||||
[[role-management-api-response-body]]
|
||||
==== Request body
|
||||
|
||||
|
|
@ -29,8 +30,11 @@ To use the create or update role API, you must have the `manage_security` cluste
|
|||
{ref}/defining-roles.html[Defining roles].
|
||||
|
||||
`kibana`::
|
||||
(list) Objects that specify the <<kibana-privileges, Kibana privileges>> for the role:
|
||||
|
||||
(list) Objects that specify the <<kibana-privileges, Kibana privileges>> for the role.
|
||||
+
|
||||
.Properties of `kibana`
|
||||
[%collapsible%open]
|
||||
=====
|
||||
`base` :::
|
||||
(Optional, list) A base privilege. When specified, the base must be `["all"]` or `["read"]`.
|
||||
When the `base` privilege is specified, you are unable to use the `feature` section.
|
||||
|
|
@ -45,6 +49,7 @@ To use the create or update role API, you must have the `manage_security` cluste
|
|||
`spaces` :::
|
||||
(list) The spaces to apply the privileges to.
|
||||
To grant access to all spaces, set to `["*"]`, or omit the value.
|
||||
=====
|
||||
|
||||
[[role-management-api-put-response-codes]]
|
||||
==== Response code
|
||||
|
|
@ -52,7 +57,7 @@ To use the create or update role API, you must have the `manage_security` cluste
|
|||
`204`::
|
||||
Indicates a successful call.
|
||||
|
||||
===== Examples
|
||||
==== Examples
|
||||
|
||||
Grant access to various features in all spaces:
|
||||
|
||||
|
|
|
|||
|
|
@ -26,6 +26,7 @@ You can request to overwrite any objects that already exist in the target space
|
|||
`space_id`::
|
||||
(Optional, string) The ID of the space that contains the saved objects you want to copy. When `space_id` is unspecified in the URL, the default space is used.
|
||||
|
||||
[role="child_attributes"]
|
||||
[[spaces-api-copy-saved-objects-request-body]]
|
||||
==== {api-request-body-title}
|
||||
|
||||
|
|
@ -34,10 +35,16 @@ You can request to overwrite any objects that already exist in the target space
|
|||
|
||||
`objects`::
|
||||
(Required, object array) The saved objects to copy.
|
||||
+
|
||||
.Properties of `objects`
|
||||
[%collapsible%open]
|
||||
=====
|
||||
`type`:::
|
||||
(Required, string) The saved object type.
|
||||
|
||||
`id`:::
|
||||
(Required, string) The saved object ID.
|
||||
=====
|
||||
|
||||
`includeReferences`::
|
||||
(Optional, boolean) When set to `true`, all saved objects related to the specified saved objects will also be copied into the target spaces. The default value is `false`.
|
||||
|
|
@ -45,27 +52,43 @@ You can request to overwrite any objects that already exist in the target space
|
|||
`overwrite`::
|
||||
(Optional, boolean) When set to `true`, all conflicts are automatically overidden. When a saved object with a matching `type` and `id` exists in the target space, that version is replaced with the version from the source space. The default value is `false`.
|
||||
|
||||
|
||||
[role="child_attributes"]
|
||||
[[spaces-api-copy-saved-objects-response-body]]
|
||||
==== {api-response-body-title}
|
||||
|
||||
`<space_id>`::
|
||||
(object) An object that describes the result of the copy operation for the space. Includes the dynamic keys in the response.
|
||||
+
|
||||
.Properties of `<space_id>`
|
||||
[%collapsible%open]
|
||||
=====
|
||||
`success`:::
|
||||
(boolean) The copy operation was successful. When set to `false`, some objects may have been copied. For additional information, refer to the `successCount` and `errors` properties.
|
||||
|
||||
`successCount`:::
|
||||
(number) The number of objects that successfully copied.
|
||||
|
||||
`errors`:::
|
||||
(Optional, array) The errors that occurred during the copy operation. When errors are reported, the `success` flag is set to `false`.v
|
||||
(Optional, array) The errors that occurred during the copy operation. When errors are reported, the `success` flag is set to `false`.
|
||||
+
|
||||
.Properties of `errors`
|
||||
[%collapsible%open]
|
||||
======
|
||||
`id`::::
|
||||
(string) The saved object ID that failed to copy.
|
||||
`type`::::
|
||||
(string) The type of saved object that failed to copy.
|
||||
`error`::::
|
||||
(object) The error that caused the copy operation to fail.
|
||||
+
|
||||
.Properties of `error`
|
||||
[%collapsible%open]
|
||||
=======
|
||||
`type`:::::
|
||||
(string) The type of error. For example, `unsupported_type`, `missing_references`, or `unknown`. Errors marked as `conflict` may be resolved by using the <<spaces-api-resolve-copy-saved-objects-conflicts, Resolve copy saved objects conflicts API>>.
|
||||
|
||||
=======
|
||||
======
|
||||
=====
|
||||
[[spaces-api-copy-saved-objects-example]]
|
||||
==== {api-examples-title}
|
||||
|
||||
|
|
|
|||
|
|
@ -25,51 +25,89 @@ Execute the <<spaces-api-copy-saved-objects,copy saved objects to space API>>, w
|
|||
`space_id`::
|
||||
(Optional, string) The ID of the space that contains the saved objects you want to copy. When `space_id` is unspecified in the URL, the default space is used. The `space_id` must be the same value used during the failed <<spaces-api-copy-saved-objects, copy saved objects to space API>> operation.
|
||||
|
||||
[role="child_attributes"]
|
||||
[[spaces-api-resolve-copy-saved-objects-conflicts-request-body]]
|
||||
==== {api-request-body-title}
|
||||
|
||||
`objects`::
|
||||
(Required, object array) The saved objects to copy. The `objects` must be the same values used during the failed <<spaces-api-copy-saved-objects, copy saved objects to space API>> operation.
|
||||
+
|
||||
.Properties of `objects`
|
||||
[%collapsible%open]
|
||||
=====
|
||||
`type`:::
|
||||
(Required, string) The saved object type.
|
||||
|
||||
`id`:::
|
||||
(Required, string) The saved object ID.
|
||||
=====
|
||||
|
||||
`includeReferences`::
|
||||
(Optional, boolean) When set to `true`, all saved objects related to the specified saved objects are copied into the target spaces. The `includeReferences` must be the same values used during the failed <<spaces-api-copy-saved-objects, copy saved objects to space API>> operation. The default value is `false`.
|
||||
|
||||
`retries`::
|
||||
(Required, object) The retry operations to attempt. Object keys represent the target space IDs.
|
||||
+
|
||||
.Properties of `retries`
|
||||
[%collapsible%open]
|
||||
=====
|
||||
`<space_id>`:::
|
||||
(Required, array) The errors to resolve for the specified `<space_id>`.
|
||||
+
|
||||
|
||||
.Properties of `<space_id>`
|
||||
[%collapsible%open]
|
||||
======
|
||||
`type`::::
|
||||
(Required, string) The saved object type.
|
||||
`id`::::
|
||||
(Required, string) The saved object ID.
|
||||
`overwrite`::::
|
||||
(Required, boolean) When set to `true`, the saved object from the source space (desigated by the <<spaces-api-resolve-copy-saved-objects-conflicts-path-params, `space_id` path parameter>>) overwrites the conflicting object in the destination space. When set to `false`, this does nothing.
|
||||
======
|
||||
=====
|
||||
|
||||
|
||||
[role="child_attributes"]
|
||||
[[spaces-api-resolve-copy-saved-objects-conflicts-response-body]]
|
||||
==== {api-response-body-title}
|
||||
|
||||
`<space_id>`::
|
||||
(object) An object that describes the result of the copy operation for the space. Includes the dynamic keys in the response.
|
||||
+
|
||||
.Properties of `<space_id>`
|
||||
[%collapsible%open]
|
||||
=====
|
||||
`success`:::
|
||||
(boolean) The copy operation was successful. When set to `false`, some objects may have been copied. For additional information, refer to the `successCount` and `errors` properties.
|
||||
|
||||
`successCount`:::
|
||||
(number) The number of objects that successfully copied.
|
||||
|
||||
`errors`:::
|
||||
(Optional, array) The errors that occurred during the copy operation. When errors are reported, the `success` flag is set to `false`.
|
||||
+
|
||||
|
||||
.Properties of `errors`
|
||||
[%collapsible%open]
|
||||
======
|
||||
`id`::::
|
||||
(string) The saved object ID that failed to copy.
|
||||
|
||||
`type`::::
|
||||
(string) The type of saved object that failed to copy.
|
||||
|
||||
`error`::::
|
||||
(object) The error that caused the copy operation to fail.
|
||||
+
|
||||
|
||||
.Properties of `error`
|
||||
[%collapsible%open]
|
||||
=======
|
||||
`type`:::::
|
||||
(string) The type of error. For example, `unsupported_type`, `missing_references`, or `unknown`.
|
||||
|
||||
=======
|
||||
======
|
||||
=====
|
||||
|
||||
[[spaces-api-resolve-copy-saved-objects-conflicts-example]]
|
||||
==== {api-examples-title}
|
||||
|
|
|
|||
275
docs/apm/api.asciidoc
Normal file
275
docs/apm/api.asciidoc
Normal file
|
|
@ -0,0 +1,275 @@
|
|||
[role="xpack"]
|
||||
[[apm-api]]
|
||||
== API
|
||||
|
||||
Some APM app features are provided via a REST API:
|
||||
|
||||
* <<agent-config-api>>
|
||||
|
||||
TIP: Kibana provides additional <<api,REST APIs>>,
|
||||
and general information on <<using-api,how to use APIs>>.
|
||||
|
||||
////
|
||||
*******************************************************
|
||||
////
|
||||
|
||||
[[agent-config-api]]
|
||||
=== Agent Configuration API
|
||||
|
||||
The Agent configuration API allows you to fine-tune your APM agent configuration,
|
||||
without needing to redeploy your application.
|
||||
|
||||
The following Agent configuration APIs are available:
|
||||
|
||||
* <<apm-update-config>> to create or update an Agent configuration
|
||||
* <<apm-delete-config>> to delete an Agent configuration.
|
||||
* <<apm-list-config>> to list all Agent configurations.
|
||||
* <<apm-search-config>> to search for an Agent configuration.
|
||||
|
||||
////
|
||||
*******************************************************
|
||||
////
|
||||
|
||||
[[apm-update-config]]
|
||||
==== Create or update configuration
|
||||
|
||||
[[apm-update-config-req]]
|
||||
===== Request
|
||||
|
||||
`PUT /api/apm/settings/agent-configuration`
|
||||
|
||||
[role="child_attributes"]
|
||||
[[apm-update-config-req-body]]
|
||||
===== Request body
|
||||
|
||||
`service`::
|
||||
(required, object) Service identifying the configuration to create or update.
|
||||
|
||||
.Properties of `service`
|
||||
[%collapsible%open]
|
||||
======
|
||||
`name` :::
|
||||
(required, string) Name of service
|
||||
|
||||
`environment` :::
|
||||
(optional, string) Environment of service
|
||||
======
|
||||
|
||||
`settings`::
|
||||
(required) Key/value object with settings and their corresponding value.
|
||||
|
||||
`agent_name`::
|
||||
(optional) The agent name is used by the UI to determine which settings to display.
|
||||
|
||||
|
||||
[[apm-update-config-example]]
|
||||
===== Example
|
||||
|
||||
[source,console]
|
||||
--------------------------------------------------
|
||||
PUT /api/apm/settings/agent-configuration
|
||||
{
|
||||
"service" : {
|
||||
"name" : "frontend",
|
||||
"environment" : "production"
|
||||
},
|
||||
"settings" : {
|
||||
"transaction_sample_rate" : 0.4,
|
||||
"capture_body" : "off",
|
||||
"transaction_max_spans" : 500
|
||||
},
|
||||
"agent_name": "nodejs"
|
||||
}
|
||||
--------------------------------------------------
|
||||
|
||||
////
|
||||
*******************************************************
|
||||
////
|
||||
|
||||
|
||||
[[apm-delete-config]]
|
||||
==== Delete configuration
|
||||
|
||||
[[apm-delete-config-req]]
|
||||
===== Request
|
||||
|
||||
`DELETE /api/apm/settings/agent-configuration`
|
||||
|
||||
[role="child_attributes"]
|
||||
[[apm-delete-config-req-body]]
|
||||
===== Request body
|
||||
`service`::
|
||||
(required, object) Service identifying the configuration to delete
|
||||
|
||||
.Properties of `service`
|
||||
[%collapsible%open]
|
||||
======
|
||||
`name` :::
|
||||
(required, string) Name of service
|
||||
|
||||
`environment` :::
|
||||
(optional, string) Environment of service
|
||||
======
|
||||
|
||||
|
||||
[[apm-delete-config-example]]
|
||||
===== Example
|
||||
|
||||
[source,console]
|
||||
--------------------------------------------------
|
||||
DELETE /api/apm/settings/agent-configuration
|
||||
{
|
||||
"service" : {
|
||||
"name" : "frontend",
|
||||
"environment": "production"
|
||||
}
|
||||
}
|
||||
--------------------------------------------------
|
||||
|
||||
////
|
||||
*******************************************************
|
||||
////
|
||||
|
||||
|
||||
[[apm-list-config]]
|
||||
==== List configuration
|
||||
|
||||
|
||||
[[apm-list-config-req]]
|
||||
===== Request
|
||||
|
||||
`GET /api/apm/settings/agent-configuration`
|
||||
|
||||
[[apm-list-config-body]]
|
||||
===== Response body
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
[
|
||||
{
|
||||
"agent_name": "go",
|
||||
"service": {
|
||||
"name": "opbeans-go",
|
||||
"environment": "production"
|
||||
},
|
||||
"settings": {
|
||||
"transaction_sample_rate": 1,
|
||||
"capture_body": "off",
|
||||
"transaction_max_spans": 200
|
||||
},
|
||||
"@timestamp": 1581934104843,
|
||||
"applied_by_agent": false,
|
||||
"etag": "1e58c178efeebae15c25c539da740d21dee422fc"
|
||||
},
|
||||
{
|
||||
"agent_name": "go",
|
||||
"service": {
|
||||
"name": "opbeans-go"
|
||||
},
|
||||
"settings": {
|
||||
"transaction_sample_rate": 1,
|
||||
"capture_body": "off",
|
||||
"transaction_max_spans": 300
|
||||
},
|
||||
"@timestamp": 1581934111727,
|
||||
"applied_by_agent": false,
|
||||
"etag": "3eed916d3db434d9fb7f039daa681c7a04539a64"
|
||||
},
|
||||
{
|
||||
"agent_name": "nodejs",
|
||||
"service": {
|
||||
"name": "frontend"
|
||||
},
|
||||
"settings": {
|
||||
"transaction_sample_rate": 1,
|
||||
},
|
||||
"@timestamp": 1582031336265,
|
||||
"applied_by_agent": false,
|
||||
"etag": "5080ed25785b7b19f32713681e79f46996801a5b"
|
||||
}
|
||||
]
|
||||
--------------------------------------------------
|
||||
|
||||
[[apm-list-config-example]]
|
||||
===== Example
|
||||
|
||||
[source,console]
|
||||
--------------------------------------------------
|
||||
GET /api/apm/settings/agent-configuration
|
||||
--------------------------------------------------
|
||||
|
||||
////
|
||||
*******************************************************
|
||||
////
|
||||
|
||||
|
||||
[[apm-search-config]]
|
||||
==== Search configuration
|
||||
|
||||
[[apm-search-config-req]]
|
||||
===== Request
|
||||
|
||||
`POST /api/apm/settings/agent-configuration/search`
|
||||
|
||||
[role="child_attributes"]
|
||||
[[apm-search-config-req-body]]
|
||||
===== Request body
|
||||
|
||||
`service`::
|
||||
(required, object) Service identifying the configuration.
|
||||
|
||||
.Properties of `service`
|
||||
[%collapsible%open]
|
||||
======
|
||||
`name` :::
|
||||
(required, string) Name of service
|
||||
|
||||
`environment` :::
|
||||
(optional, string) Environment of service
|
||||
======
|
||||
|
||||
`etag`::
|
||||
(required) etag is sent by the agent to indicate the etag of the last successfully applied configuration. If the etag matches an existing configuration its `applied_by_agent` property will be set to `true`. Every time a configuration is edited `applied_by_agent` is reset to `false`.
|
||||
|
||||
[[apm-search-config-body]]
|
||||
===== Response body
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
{
|
||||
"_index": ".apm-agent-configuration",
|
||||
"_id": "CIaqXXABmQCdPphWj8EJ",
|
||||
"_score": 2,
|
||||
"_source": {
|
||||
"agent_name": "nodejs",
|
||||
"service": {
|
||||
"name": "frontend"
|
||||
},
|
||||
"settings": {
|
||||
"transaction_sample_rate": 1,
|
||||
},
|
||||
"@timestamp": 1582031336265,
|
||||
"applied_by_agent": false,
|
||||
"etag": "5080ed25785b7b19f32713681e79f46996801a5b"
|
||||
}
|
||||
}
|
||||
--------------------------------------------------
|
||||
|
||||
[[apm-search-config-example]]
|
||||
===== Example
|
||||
|
||||
[source,console]
|
||||
--------------------------------------------------
|
||||
POST /api/apm/settings/agent-configuration/search
|
||||
{
|
||||
"etag" : "1e58c178efeebae15c25c539da740d21dee422fc",
|
||||
"service" : {
|
||||
"name" : "frontend",
|
||||
"environment": "production"
|
||||
}
|
||||
}
|
||||
--------------------------------------------------
|
||||
|
||||
////
|
||||
*******************************************************
|
||||
////
|
||||
Loading…
Add table
Add a link
Reference in a new issue