This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.
« Delete Parameters API Delete Private Location API »
Elastic Docs ›Kibana Guide [master] ›REST API ›Synthetics APIs

Create Private Location API

edit

Create Private Location API

edit

Creates a private location with the following schema.

Request

edit

POST <kibana host>:<port>/api/synthetics/private_locations

POST <kibana host>:<port>/s/<space_id>/api/synthetics/private_locations

Prerequisites

edit

You must have all privileges for the Synthetics and Uptime feature in the Observability section of the Kibana feature privileges.

Request body

edit

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.

Example

edit

Here is an example of a POST request to create a private location:

POST /api/private_locations
{
  "label": "Private Location 1",
  "agentPolicyId": "abcd1234",
  "tags": ["private", "testing"],
  "geo": {
    "lat": 40.7128,
    "lon": -74.0060
  }
}

The API returns the created private location as follows:

{
  "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.

« Delete Parameters API Delete Private Location API »