Skip to main content

Get a Probe Config (v2.0)

GET 

/v2.0/api/tenants/:tenant_id/probeconfigs/:config_id

List a probe config.

Request

Path Parameters

    tenant_id stringrequired

    The tenant ID.

    config_id stringrequired

    The probe config ID.

Responses

Successful Operation

Schema
    description

    The description of the probe configuration. Max size = 256.

    enabled boolean

    The probe configuration based on rules that are enabled.

    endpoints ProbeEndpoint[]required

    Info on the probe endpoint configurations.

  • Array [
  • allow_insecure_https_connection boolean

    Allow insecure HTTPS connections. True or False.

    dns_server_ip string

    The DNS server IP address.

    fqdn string

    The FQDN for the probe configuration.

    http_response_codes integer[]

    The HTTP response codes.

    http_response_string string

    The HTTP response string.

    ipv4_address string

    The IPv4 address for the probe configuration.

    path_types string[]

    Possible values: [vpn, direct, servicelink, all]

    The probe path type selected = Direct, Prisma SD-WAN VPN, and Direct VPN.

    probe_count int32

    The probe count value which is a multiple of the probe cycle duration; multiples of 1, 2, and 3.

    probe_cycle_duration int32

    Probe cycle duration in minutes or seconds.

    protocol string

    Possible values: [http, https, icmp, dns]

    The selected protocol = HTTP, HTTPS, DNS, and ICMP.

  • ]
  • id string

    The probe config ID.

    name stringrequired

    The probe config name. Max size = 128.

    tags string[]

    An information field that can be added to identify the probe config. Maximum 10 unique tags of length 1024 each are allowed.

Loading...