GET Monitor Events.

GET

/api/observability/synthetic_monitor/namespaces/{namespace}/monitor-events

const url = 'https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/observability/synthetic_monitor/namespaces/example/monitor-events';
const options = {method: 'GET', headers: {Authorization: '<Authorization>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/observability/synthetic_monitor/namespaces/example/monitor-events \
  --header 'Authorization: <Authorization>'

Returns the healthy and critical events for the specified monitor.

Examples of this operation.

Authorizations

ApiToken

Parameters

Path Parameters

namespace

required

string

Namespace Request namespace.

Query Parameters

monitor_type

string

Monitor_type. X-required Monitor type.

monitor_name

string

Monitor_name. X-required Monitor name.

start_time

string

Start_time. X-required Start time for requested events.

end_time

string

End_time. End time for requested events (default: current time)

Responses

200

A successful response.

application/json

GetMonitorEventsResponse

Monitor health events by region.

object

events

events

{ “event_time”: “2022-02-09T19:48:11Z”, “historical_health”: “Critical”, “event”: “HTTP monitor test1 in region VES-I/O-paris turns critical due to connection timeout.”, “source”: “Global”, “monitor_type”: "", “provider”: "", }, { “event_time”: “2022-02-09T19:48:11Z”, “historical_health”: “Healthy”, “event”: “HTTP monitor test1 in region VES-I/O-paris turns critical due to connection timeout.”, “source”: “VES-I/O-paris”, “monitor_type”: “HTTP”, “provider”: “f5xc”, }, … ], List of the monitor health events.

Array<object>

object

dns_detail

object

answer

answer

Configuration parameter for answer

string

<= 1024 characters

compress

compress

Configuration parameter for compress

string

<= 1024 characters

dns_lookup_ms

dns_lookup_ms

Configuration parameter for dns lookup ms

string

<= 1024 characters

msg_hdr_authenticated_data

msg_hdr_authenticated_data

Data or content configuration

string

<= 1024 characters

msg_hdr_authoritative

msg_hdr_authoritative

Configuration parameter for msg hdr authoritative

string

<= 1024 characters

msg_hdr_checking_disabled

msg_hdr_checking_disabled

Disable functionality when true

string

<= 1024 characters

msg_hdr_id

msg_hdr_id

Unique identifier for this resource

string

<= 1024 characters

msg_hdr_opcode

msg_hdr_opcode

Configuration parameter for msg hdr opcode

string

<= 1024 characters

msg_hdr_rcode

msg_hdr_rcode

Configuration parameter for msg hdr rcode

string

<= 1024 characters

msg_hdr_recursion_available

msg_hdr_recursion_available

Configuration parameter for msg hdr recursion available

string

<= 1024 characters

msg_hdr_response

msg_hdr_response

Configuration parameter for msg hdr response

string

<= 1024 characters

msg_hdr_truncated

msg_hdr_truncated

Configuration parameter for msg hdr truncated

string

<= 1024 characters

msg_hdr_zero

msg_hdr_zero

Configuration parameter for msg hdr zero

string

<= 1024 characters

question

question

Configuration parameter for question

string

<= 1024 characters

region

region

Geographic region for resource placement

string

<= 1024 characters

status_code

status_code

Status or state information

string

<= 1024 characters

trailer

trailer

Configuration parameter for trailer

string

<= 1024 characters

event

event

Description of health event.

string

<= 1024 characters

event_time

event_time

Date and time of event.

string

<= 1024 characters

historical_health

historical_health

Last recorded health of monitor.

string

<= 1024 characters

http_detail

object

body

body

Request or response body content

string

<= 1024 characters

content_length

content_length

Configuration parameter for content length

string

<= 1024 characters

content_transfer_ms

content_transfer_ms

Configuration parameter for content transfer ms

string

<= 1024 characters

dns_lookup_ms

dns_lookup_ms

Configuration parameter for dns lookup ms

string

<= 1024 characters

header

header

Configuration parameter for header

string

<= 1024 characters

proto

proto

Configuration parameter for proto

string

<= 1024 characters

region

region

Geographic region for resource placement

string

<= 1024 characters

server_processing_ms

server_processing_ms

Configuration parameter for server processing ms

string

<= 1024 characters

status_code

status_code

Status or state information

string

<= 1024 characters

tcp_connection_ms

tcp_connection_ms

Configuration parameter for tcp connection ms

string

<= 1024 characters

tls_cipher_suite

tls_cipher_suite

IP address configuration

string

<= 1024 characters

tls_did_resume

tls_did_resume

Configuration parameter for tls did resume

string

<= 1024 characters

tls_handshake_complete

tls_handshake_complete

Configuration parameter for tls handshake complete

string

<= 1024 characters

tls_handshake_ms

tls_handshake_ms

Configuration parameter for tls handshake ms

string

<= 1024 characters

tls_negotiated_protocol

tls_negotiated_protocol

Configuration parameter for tls negotiated protocol

string

<= 1024 characters

tls_server_name

tls_server_name

Human-readable name for the resource

string

<= 1024 characters

tls_version

tls_version

Version number or identifier

string

<= 1024 characters

trailer

trailer

Configuration parameter for trailer

string

<= 1024 characters

transfer_encoding

transfer_encoding

Configuration parameter for transfer encoding

string

<= 1024 characters

uncompressed

uncompressed

Configuration parameter for uncompressed

string

<= 1024 characters

monitor_type

monitor_type

Monitor type Required: YES.

string

<= 1024 characters

provider

provider

Region provider.

string

>= 3 characters <= 1024 characters

source

source

Region event occurred in.

string

<= 1024 characters

Example^generated

{
  "events": [
    {
      "dns_detail": {
        "answer": "example",
        "compress": "example",
        "dns_lookup_ms": "example",
        "msg_hdr_authenticated_data": "example",
        "msg_hdr_authoritative": "example",
        "msg_hdr_checking_disabled": "example",
        "msg_hdr_id": "example",
        "msg_hdr_opcode": "example",
        "msg_hdr_rcode": "example",
        "msg_hdr_recursion_available": "example",
        "msg_hdr_response": "example",
        "msg_hdr_truncated": "example",
        "msg_hdr_zero": "example",
        "question": "example",
        "region": "example",
        "status_code": "example",
        "trailer": "example"
      },
      "event": "example",
      "event_time": "example",
      "historical_health": "example",
      "http_detail": {
        "body": "example",
        "content_length": "example",
        "content_transfer_ms": "example",
        "dns_lookup_ms": "example",
        "header": "example",
        "proto": "example",
        "region": "example",
        "server_processing_ms": "example",
        "status_code": "example",
        "tcp_connection_ms": "example",
        "tls_cipher_suite": "example",
        "tls_did_resume": "example",
        "tls_handshake_complete": "example",
        "tls_handshake_ms": "example",
        "tls_negotiated_protocol": "example",
        "tls_server_name": "example",
        "tls_version": "example",
        "trailer": "example",
        "transfer_encoding": "example",
        "uncompressed": "example"
      },
      "monitor_type": "example",
      "provider": "example",
      "source": "example"
    }
  ]
}

401

Returned when operation is not authorized.

application/json

string format: string

Example^generated

example

403

Returned when there is no permission to access resource.

application/json

string format: string

Example^generated

example

404

Returned when resource is not found.

application/json

string format: string

Example^generated

example

409

Returned when operation on resource is conflicting with current value.

application/json

string format: string

Example^generated

example

429

Returned when operation has been rejected as it is happening too frequently.

application/json

string format: string

Example^generated

example

500

Returned when server encountered an error in processing API.

application/json

string format: string

Example^generated

example

503

Returned when service is unavailable temporarily.

application/json

string format: string

Example^generated

example

504

Returned when server timed out processing request.

application/json

string format: string

Example^generated

example

GET Monitor Events.

Authorizations

Parameters

Path Parameters

Query Parameters

Responses

200

Examplegenerated

401

Examplegenerated

403

Examplegenerated

404

Examplegenerated

409

Examplegenerated

429

Examplegenerated

500

Examplegenerated

503

Examplegenerated

504

Examplegenerated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated