Create Probe Config (v2.0)

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

Create a new probe configuration.

Request

Path Parameters

tenant_id stringrequired

The tenant ID.

application/json

Body

Details of the PROBE profile to be created

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.

Responses

200

Successful Operation

application/json

Schema

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.

Example (from schema)

{
  "enabled": true,
  "endpoints": [
    {
      "allow_insecure_https_connection": true,
      "dns_server_ip": "string",
      "fqdn": "string",
      "http_response_codes": [
        0
      ],
      "http_response_string": "string",
      "ipv4_address": "string",
      "path_types": [
        "vpn"
      ],
      "probe_count": 0,
      "probe_cycle_duration": 0,
      "protocol": "http"
    }
  ],
  "id": "string",
  "name": "string",
  "tags": [
    "string"
  ]
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "INVALID_JSON_VALUE"
      },
      {
        "code": "PROBE_ENDPOINTS_REQUIRED"
      },
      {
        "code": "PROBE_ENDPOINT_INVALID_IP"
      },
      {
        "code": "PROBE_ENDPOINT_MULTICAST_IP_NOT_ALLOWED"
      },
      {
        "code": "PROBE_ENDPOINT_DNS_SERVER_MULTICAST_IP_NOT_ALLOWED"
      },
      {
        "code": "PROBE_ENDPOINT_INVALID_PROTOCOL"
      },
      {
        "code": "PROBE_ENDPOINT_INVALID_PROBE_CYCLE_DURATION_RANGE"
      },
      {
        "code": "PROBE_ENDPOINT_INVALID_PATH_TYPE"
      },
      {
        "code": "PROBE_ENDPOINTS_SUPPORTED_SIZE_EXCEEDED"
      },
      {
        "code": "PROBE_ENDPOINT_INVALID_PROBE_COUNT"
      },
      {
        "code": "PROBE_ENDPOINT_EITHER_IP_OR_FQDN_MUST_BE_CONFIGURED"
      },
      {
        "code": "PROBE_ENDPOINT_IP_AND_FQDN_CANNOT_CONFIGURED_TOGETHER"
      },
      {
        "code": "PROBE_ENDPOINT_INSECURE_HTTPS_APPLICABLE_FOR_PROTOCOL_HTTPS"
      },
      {
        "code": "PROBE_ENDPOINT_HTTP_CODE_STRING_NOT_SUPPORTED"
      },
      {
        "code": "PROBE_ENDPOINT_PATH_TYPES_REQUIRED"
      },
      {
        "code": "PROBE_ENDPOINT_DUPLICATE_PATH_TYPES"
      },
      {
        "code": "PROBE_ENDPOINT_INVALID_DNS_SERVER_IP"
      },
      {
        "code": "PROBE_ENDPOINT_DNS_SERVER_IP_NOT_APPLICABLE"
      },
      {
        "code": "PROBE_ENDPOINT_DNS_SERVER_IP_REQUIRED"
      },
      {
        "code": "PROBE_ENDPOINT_IP_NOT_ALLOWED_FOR_DNS"
      },
      {
        "code": "PROBE_ENDPOINT_INVALID_PROBE_DURATION_MULTIPLE"
      },
      {
        "code": "INVALID_FQDN_STRING_LENGTH"
      },
      {
        "code": "INVALID_HTTP_RESPONSE_STRING_LENGTH"
      },
      {
        "code": "PROBE_ENDPOINT_INVALID_HTTP_RESPONSE_STRING_ENCODING"
      }
    ]
  }
}

Loading...