Create a monitor

Server: https://{kibana_url}

POST /api/synthetics/monitors

Create a new monitor with the specified attributes. A monitor can be one of the following types: HTTP, TCP, ICMP, or Browser. The required and default fields may vary based on the monitor type. You must have all privileges for the Synthetics feature in the Observability section of the Kibana feature privileges.

Request

Responses

A successful response. The response may include a warnings array when the monitor configuration has non-critical issues. For example, if a browser monitor specifies a timeout but has no private locations configured, a warning is returned indicating the timeout will have no effect.

application/json

Bad request. For browser monitors, a 400 error is returned if the timeout is less than 30 seconds.

application/json

Examples

Create an HTTP monitor to check a website's availability.

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST /api/synthetics/monitors
{
  "type": "http",
  "name": "Website Availability",
  "url": "https://example.com",
  "tags": ["website", "availability"],
  "locations": ["united_kingdom"]
}

curl Shell

curl -X POST "https://{kibana_url}/api/synthetics/monitors" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "http",
  "name": "Website Availability",
  "url": "https://example.com",
  "tags": ["website", "availability"],
  "locations": ["united_kingdom"]
}'

Response

{
  "type": "browser",
  "name": "Example journey",
  "enabled": true,
  "warnings": [
    {
      "id": "monitor-id",
      "message": "For browser monitors, timeout is only supported on private locations. Browser monitor \"Example journey\" specifies a timeout and is running on public locations: \"public-1, public-2\". The timeout will have no effect on these locations.",
      "publicLocationIds": ["public-1", "public-2"]
    }
  ]
}

{
  "statusCode": 400,
  "error": "Bad Request",
  "message": "Browser Monitor timeout is invalid",
  "attributes": {
    "details": "Invalid timeout 20 seconds supplied. Minimum timeout for browser monitors is 30 seconds."
  }
}

Create a TCP monitor to monitor a server's availability.

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST /api/synthetics/monitors
{
  "type": "tcp",
  "name": "Server Availability",
  "host": "example.com",
  "private_locations": ["my_private_location"]
}

curl Shell

curl -X POST "https://{kibana_url}/api/synthetics/monitors" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "tcp",
  "name": "Server Availability",
  "host": "example.com",
  "private_locations": ["my_private_location"]
}'

Response

{
  "type": "browser",
  "name": "Example journey",
  "enabled": true,
  "warnings": [
    {
      "id": "monitor-id",
      "message": "For browser monitors, timeout is only supported on private locations. Browser monitor \"Example journey\" specifies a timeout and is running on public locations: \"public-1, public-2\". The timeout will have no effect on these locations.",
      "publicLocationIds": ["public-1", "public-2"]
    }
  ]
}

{
  "statusCode": 400,
  "error": "Bad Request",
  "message": "Browser Monitor timeout is invalid",
  "attributes": {
    "details": "Invalid timeout 20 seconds supplied. Minimum timeout for browser monitors is 30 seconds."
  }
}

Create an ICMP monitor to perform ping checks.

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST /api/synthetics/monitors
{
  "type": "icmp",
  "name": "Ping Test",
  "host": "example.com",
  "locations": ["united_kingdom"]
}

curl Shell

curl -X POST "https://{kibana_url}/api/synthetics/monitors" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "icmp",
  "name": "Ping Test",
  "host": "example.com",
  "locations": ["united_kingdom"]
}'

Response

{
  "type": "browser",
  "name": "Example journey",
  "enabled": true,
  "warnings": [
    {
      "id": "monitor-id",
      "message": "For browser monitors, timeout is only supported on private locations. Browser monitor \"Example journey\" specifies a timeout and is running on public locations: \"public-1, public-2\". The timeout will have no effect on these locations.",
      "publicLocationIds": ["public-1", "public-2"]
    }
  ]
}

{
  "statusCode": 400,
  "error": "Bad Request",
  "message": "Browser Monitor timeout is invalid",
  "attributes": {
    "details": "Invalid timeout 20 seconds supplied. Minimum timeout for browser monitors is 30 seconds."
  }
}

Create a browser monitor to check a website.

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST /api/synthetics/monitors
{
  "type": "browser",
  "name": "Example journey",
  "inline_script": "step('Go to https://google.com.co', () => page.goto('https://www.google.com'))",
  "locations": ["united_kingdom"]
}

curl Shell

curl -X POST "https://{kibana_url}/api/synthetics/monitors" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "browser",
  "name": "Example journey",
  "inline_script": "step('\''Go to https://google.com.co'\'', () => page.goto('\''https://www.google.com'\''))",
  "locations": ["united_kingdom"]
}'

Response

{
  "type": "browser",
  "name": "Example journey",
  "enabled": true,
  "warnings": [
    {
      "id": "monitor-id",
      "message": "For browser monitors, timeout is only supported on private locations. Browser monitor \"Example journey\" specifies a timeout and is running on public locations: \"public-1, public-2\". The timeout will have no effect on these locations.",
      "publicLocationIds": ["public-1", "public-2"]
    }
  ]
}

{
  "statusCode": 400,
  "error": "Bad Request",
  "message": "Browser Monitor timeout is invalid",
  "attributes": {
    "details": "Invalid timeout 20 seconds supplied. Minimum timeout for browser monitors is 30 seconds."
  }
}

Request Synthetics_browserMonitorFields | Synthetics_httpMonitorFields | Synthetics_icmpMonitorFields | Synthetics_tcpMonitorFields |

Responses

Request