Global InfraGlobal Infra Cloud
Monitoring

List Availability Checks

Returns a paginated list of availability checks.

GET
/api/v1/giservices/monitoring/availability_checks

Authorization

AuthorizationBearer <token>

Okta Bearer token

In: header

Query Parameters

filter?array<string>

Filter results by field (e.g. attributes.name[eq]=value)

sort?array<string>

Sort results by field

skip?integer

Number of results to skip

Default0
limit?integer

Maximum number of results

Default100

Response Body

application/json

curl -X GET "https://example.com/api/v1/giservices/monitoring/availability_checks"
{
  "elements": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "service": "string",
      "attributes": {
        "bbe_config": {
          "dns": {
            "dns_over_tls": true,
            "ip_protocol_fallback": true,
            "preferred_ip_protocol": "ip4",
            "query_class": "string",
            "query_name": "string",
            "query_type": "A",
            "recursion_desired": true,
            "source_ip_address": "string",
            "tls_config": {
              "ca": "string",
              "ca_file": "string",
              "cert": "string",
              "cert_file": "string",
              "insecure_skip_verify": true,
              "key": "string",
              "key_file": "string",
              "max_version": "TLS10",
              "min_version": "TLS10",
              "server_name": "string"
            },
            "transport_protocol": "udp",
            "valid_rcodes": [
              "string"
            ],
            "validate_additional_rrs": {
              "fail_if_all_match_regexp": [
                "string"
              ],
              "fail_if_matches_regexp": [
                "string"
              ],
              "fail_if_none_matches_regexp": [
                "string"
              ],
              "fail_if_not_matches_regexp": [
                "string"
              ]
            },
            "validate_answer_rrs": {
              "fail_if_all_match_regexp": [
                "string"
              ],
              "fail_if_matches_regexp": [
                "string"
              ],
              "fail_if_none_matches_regexp": [
                "string"
              ],
              "fail_if_not_matches_regexp": [
                "string"
              ]
            },
            "validate_authority_rrs": {
              "fail_if_all_match_regexp": [
                "string"
              ],
              "fail_if_matches_regexp": [
                "string"
              ],
              "fail_if_none_matches_regexp": [
                "string"
              ],
              "fail_if_not_matches_regexp": [
                "string"
              ]
            }
          },
          "grpc": {
            "ip_protocol_fallback": true,
            "metadata": {
              "property1": [
                "string"
              ],
              "property2": [
                "string"
              ]
            },
            "preferred_ip_protocol": "ip4",
            "service": "string",
            "tls": true,
            "tls_config": {
              "ca": "string",
              "ca_file": "string",
              "cert": "string",
              "cert_file": "string",
              "insecure_skip_verify": true,
              "key": "string",
              "key_file": "string",
              "max_version": "TLS10",
              "min_version": "TLS10",
              "server_name": "string"
            }
          },
          "http": {
            "body": "string",
            "body_file": "string",
            "body_size_limit": "string",
            "compression": "string",
            "enable_http3": true,
            "fail_if_body_matches_regexp": [
              "string"
            ],
            "fail_if_body_not_matches_regexp": [
              "string"
            ],
            "fail_if_header_matches": [
              {
                "allow_missing": true,
                "header": "string",
                "regexp": "string"
              }
            ],
            "fail_if_header_not_matches": [
              {
                "allow_missing": true,
                "header": "string",
                "regexp": "string"
              }
            ],
            "fail_if_not_ssl": true,
            "fail_if_ssl": true,
            "headers": {
              "property1": "string",
              "property2": "string"
            },
            "http_client_config": {
              "authorization": {
                "credentials": "string",
                "credentials_file": "string",
                "type": "string"
              },
              "basic_auth": {
                "password": "string",
                "password_file": "string",
                "username": "string",
                "username_file": "string"
              },
              "bearer_token": "string",
              "bearer_token_file": "string",
              "enable_http2": true,
              "follow_redirects": true,
              "http_headers": {
                "property1": [
                  "string"
                ],
                "property2": [
                  "string"
                ]
              },
              "no_proxy": "string",
              "oauth2": {
                "client_id": "string",
                "client_secret": "string",
                "client_secret_file": "string",
                "endpoint_params": {
                  "property1": "string",
                  "property2": "string"
                },
                "no_proxy": "string",
                "proxy_from_environment": true,
                "proxy_url": "string",
                "scopes": [
                  "string"
                ],
                "tls_config": {
                  "ca": "string",
                  "ca_file": "string",
                  "cert": "string",
                  "cert_file": "string",
                  "insecure_skip_verify": true,
                  "key": "string",
                  "key_file": "string",
                  "max_version": "TLS10",
                  "min_version": "TLS10",
                  "server_name": "string"
                },
                "token_url": "string"
              },
              "proxy_from_environment": true,
              "proxy_url": "string",
              "tls_config": {
                "ca": "string",
                "ca_file": "string",
                "cert": "string",
                "cert_file": "string",
                "insecure_skip_verify": true,
                "key": "string",
                "key_file": "string",
                "max_version": "TLS10",
                "min_version": "TLS10",
                "server_name": "string"
              }
            },
            "ip_protocol_fallback": true,
            "method": "string",
            "no_follow_redirects": true,
            "preferred_ip_protocol": "ip4",
            "skip_resolve_phase_with_proxy": true,
            "valid_http_versions": [
              "string"
            ],
            "valid_status_codes": [
              200
            ]
          },
          "icmp": {
            "dont_fragment": true,
            "ip_protocol_fallback": true,
            "payload_size": 0,
            "preferred_ip_protocol": "ip4",
            "source_ip_address": "string",
            "ttl": 0
          },
          "prober": "http",
          "tcp": {
            "ip_protocol_fallback": true,
            "preferred_ip_protocol": "ip4",
            "query_response": [
              {
                "expect": "string",
                "expect_bytes": "string",
                "labels": [
                  {
                    "name": "string",
                    "value": "string"
                  }
                ],
                "send": "string",
                "starttls": true
              }
            ],
            "source_ip_address": "string",
            "tls": true,
            "tls_config": {
              "ca": "string",
              "ca_file": "string",
              "cert": "string",
              "cert_file": "string",
              "insecure_skip_verify": true,
              "key": "string",
              "key_file": "string",
              "max_version": "TLS10",
              "min_version": "TLS10",
              "server_name": "string"
            }
          },
          "timeout": "5s"
        },
        "interval": 30,
        "labels": {
          "property1": "string",
          "property2": "string"
        },
        "locations": [
          "emea"
        ],
        "monitoring": {
          "alert_availability": "none",
          "alert_certificate": "none",
          "gi_ecosystem": "string",
          "gi_team": "string",
          "priority": "SEV-1",
          "severity": "info"
        },
        "name": "my-service-http",
        "targets": [
          "https://my-service.example.com/health"
        ],
        "timeout": "5s",
        "type": "http"
      },
      "platform": "string",
      "region": "string",
      "tenant": "string"
    }
  ],
  "total": 0,
  "skip": 0,
  "limit": 0
}
Empty
Empty