[8.x] [Synthetics] Clarify private location api docs !! (#208504) (#209005)

# Backport

This will backport the following commits from `main` to `8.x`:
- [[Synthetics] Clarify private location api docs !!
(#208504)](https://github.com/elastic/kibana/pull/208504)

<!--- Backport version: 9.4.3 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT
[{"author":{"name":"Shahzad","email":"shahzad31comp@gmail.com"},"sourceCommit":{"committedDate":"2025-01-30T17:44:40Z","message":"[Synthetics]
Clarify private location api docs !! (#208504)\n\n##
Summary\r\n\r\nClarify private location api docs
!!\r\n\r\nCo-authored-by: Dominique Clarke
<dominique.clarke@elastic.co>","sha":"6dda88821dbf79b596b2bdefb109d2842e754195","branchLabelMapping":{"^v9.0.0$":"main","^v8.18.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","v9.0.0","backport:prev-minor"],"title":"[Synthetics]
Clarify private location api docs
!!","number":208504,"url":"https://github.com/elastic/kibana/pull/208504","mergeCommit":{"message":"[Synthetics]
Clarify private location api docs !! (#208504)\n\n##
Summary\r\n\r\nClarify private location api docs
!!\r\n\r\nCo-authored-by: Dominique Clarke
<dominique.clarke@elastic.co>","sha":"6dda88821dbf79b596b2bdefb109d2842e754195"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/208504","number":208504,"mergeCommit":{"message":"[Synthetics]
Clarify private location api docs !! (#208504)\n\n##
Summary\r\n\r\nClarify private location api docs
!!\r\n\r\nCo-authored-by: Dominique Clarke
<dominique.clarke@elastic.co>","sha":"6dda88821dbf79b596b2bdefb109d2842e754195"}}]}]
BACKPORT-->

Co-authored-by: Shahzad <shahzad31comp@gmail.com>
This commit is contained in:
Kibana Machine 2025-01-31 05:16:42 +11:00 committed by GitHub
parent 4c5914d778
commit 4cb2f9d7fc
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -38,7 +38,8 @@ The request body should contain the following attributes:
- `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.
(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, the API will throw an error if user
does not have access to all spaces. In that case you can provide the space ID where the private location should be available.
[[private-location-create-example]]
==== Example