synthetics

Create a private location

Spaces method and path for this operation:

<div><span class="operation-verb post">post</span>&nbsp;<span class="operation-path">/s/{space_id}/api/synthetics/private_locations</span></div>

Refer to Spaces for more information.

Create a private location backed by a Fleet agent policy.

You must have all privileges for the Synthetics and Uptime feature in the Observability section of the Kibana feature privileges.<br/><br/>[Required authorization] Route required privileges: uptime-read AND private-location-write AND uptime-write.

post/api/synthetics/private_locations

Request

  • Base URL
    https://localhost:5601
  • URL
    https://localhost:5601/api/synthetics/private_locations
  • Auth
    • API key in header Authorization
    • or HTTP basic

Headers

kbn-xsrfstring required
Example:true

A required header to protect against CSRF attacks

Request body

agentPolicyIdstring required

The ID of the agent policy associated with the private location. Each agent policy can back only one private location.

labelstring required

A label for the private location. Must be unique.

spacesstring[]

An array of space IDs where the private location is available. If it is not provided, the private location is available in all spaces.

tagsstring[]

An array of tags to categorize the private location.

Response

A successful response.

agentPolicyIdstring

The ID of the agent policy associated with the private location.

idstring

The unique identifier of the private location.

isInvalidboolean

Indicates whether the location is invalid. If true, the location is invalid, which means the agent policy associated with the location is deleted.

labelstring

A label for the private location.

namespacestring

The namespace of the location, which is the same as the namespace of the agent policy associated with the location.

spacesstring[]

The space IDs where the private location is available.

tagsstring[]

An array of tags to categorize the private location.

Changes

No operation changes recorded.