mirror of
https://github.com/elastic/kibana.git
synced 2025-04-25 02:09:32 -04:00
e51b2bda27
## Summary Fixes https://github.com/elastic/kibana/issues/199976 User can choose which space the location will be visible in while creating a location !! ### Testing - [ ] Create location in all spaces and make sure it's visible everywhere. - [ ] Creation location in a specific space and make sure it's only visible in specified space <img width="1728" alt="image" src="https://github.com/user-attachments/assets/6aa5cac9-500a-447a-8ef5-bf53e91a16dd" />
79 lines
2.2 KiB
Text
79 lines
2.2 KiB
Text
[[create-private-location-api]]
|
|
== Create Private Location API
|
|
++++
|
|
<titleabbrev>Create Private Location</titleabbrev>
|
|
++++
|
|
|
|
Creates a private location with the following schema.
|
|
|
|
=== {api-request-title}
|
|
|
|
`POST <kibana host>:<port>/api/synthetics/private_locations`
|
|
|
|
`POST <kibana host>:<port>/s/<space_id>/api/synthetics/private_locations`
|
|
|
|
=== {api-prereq-title}
|
|
|
|
You must have `all` privileges for the *Synthetics and Uptime* feature in the *{observability}* section of the
|
|
<<kibana-feature-privileges,{kib} feature privileges>>.
|
|
|
|
[[private-location-request-body]]
|
|
==== Request body
|
|
|
|
The request body should contain the following attributes:
|
|
|
|
`label`::
|
|
(Required, string) A label for the private location.
|
|
|
|
`agentPolicyId`::
|
|
(Required, string) The ID of the agent policy associated with the private location.
|
|
|
|
`tags`::
|
|
(Optional, array of strings) An array of tags to categorize the private location.
|
|
|
|
`geo`::
|
|
(Optional, object) Geographic coordinates (WGS84) for the location. It should include the following attributes:
|
|
|
|
- `lat` (Required, number): The latitude of the location.
|
|
- `lon` (Required, number): The longitude of the location.
|
|
|
|
`spaces`::
|
|
(Optional, array of strings) An array of space IDs where the private location is available. If not provided, the private location is available in all spaces.
|
|
|
|
[[private-location-create-example]]
|
|
==== Example
|
|
|
|
Here is an example of a POST request to create a private location:
|
|
|
|
[source,sh]
|
|
--------------------------------------------------
|
|
POST /api/private_locations
|
|
{
|
|
"label": "Private Location 1",
|
|
"agentPolicyId": "abcd1234",
|
|
"tags": ["private", "testing"],
|
|
"geo": {
|
|
"lat": 40.7128,
|
|
"lon": -74.0060
|
|
}
|
|
"spaces": ["default"]
|
|
}
|
|
--------------------------------------------------
|
|
|
|
The API returns the created private location as follows:
|
|
|
|
[source,json]
|
|
--------------------------------------------------
|
|
{
|
|
"id": "abcd1234",
|
|
"label": "Private Location 1",
|
|
"agentPolicyId": "abcd1234",
|
|
"tags": ["private", "testing"],
|
|
"geo": {
|
|
"lat": 40.7128,
|
|
"lon": -74.0060
|
|
}
|
|
}
|
|
--------------------------------------------------
|
|
|
|
If the `agentPolicyId` is already used by an existing private location, or if the `label` already exists, the API will return a `400 Bad Request` response with a corresponding error message.
|