Update a monitor

Server: https://{kibana_url}

PUT /api/synthetics/monitors/{id}

Update a monitor with the specified attributes. 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. You can also partially update a monitor. This will only update the fields that are specified in the request body. All other fields are left unchanged. The specified fields should conform to the monitor type. For example, you can't update the inline_scipt field of a HTTP monitor.

Path Parameters

id string required: The identifier for the monitor that you want to update.

Request

Responses

A successful response. The response may include a warnings array when the monitor configuration has non-critical issues.

application/json

400

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

Examples

Update an HTTP monitor that checks a website's availability.

Request Console 1 / 2 languages

Console Kibana Dev Tools

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

curl Shell

curl -X PUT "https://{kibana_url}/api/synthetics/monitors/{id}" \
  -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"]
    }
  ]
}

Update a TCP monitor that monitors a server's availability.

Request Console 1 / 2 languages

Console Kibana Dev Tools

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

curl Shell

curl -X PUT "https://{kibana_url}/api/synthetics/monitors/{id}" \
  -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"]
    }
  ]
}

Update an ICMP monitor that performs ping checks.

Request Console 1 / 2 languages

Console Kibana Dev Tools

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

curl Shell

curl -X PUT "https://{kibana_url}/api/synthetics/monitors/{id}" \
  -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"]
    }
  ]
}

Update a browser monitor that checks a website.

Request Console 1 / 2 languages

Console Kibana Dev Tools

PUT /api/synthetics/monitors/{id}
{
  "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 PUT "https://{kibana_url}/api/synthetics/monitors/{id}" \
  -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"]
    }
  ]
}

Path Parameters

Request Synthetics_browserMonitorFields | Synthetics_httpMonitorFields | Synthetics_icmpMonitorFields | Synthetics_tcpMonitorFields |

Responses

Request