Create Probe Profile (v2.0)

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

Create a new probe profile.

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 profile. Max size = 256.

id string

The probe profile ID.

name stringrequired

The probe profile name. Max size = 128.

probe_config_ids string[]required

The probe configuration IDs. Max number = 8.

tags string[]

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

Responses

200

Successful Operation

application/json

Schema

Schema

description

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

id string

The probe profile ID.

name stringrequired

The probe profile name. Max size = 128.

probe_config_ids string[]required

The probe configuration IDs. Max number = 8.

tags string[]

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

Example (from schema)

{
  "id": "string",
  "name": "string",
  "probe_config_ids": [
    "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_PROFILE_MAX_PROBE_CONFIGS_LIMIT_EXCEEDED_OR_DUPLICATES"
      },
      {
        "code": "PROBE_ENDPOINT_DUPLICATE_IP_FQDN_PROTOCOL"
      },
      {
        "code": "PROBE_PROFILE_IS_IN_USE_BY_WANINTERFACE_LABEL"
      },
      {
        "code": "PROBE_PROFILE_IS_IN_USE_BY_WANINTERFACE"
      },
      {
        "code": "PROBE_CONFIGS_INVALID"
      },
      {
        "code": "PROBE_PROFILE_PROBE_CONFIG_IDS_REQUIRED"
      },
      {
        "code": "PERFMGMT_CONFIG_IDS_IN_USE_BY_LABELS"
      },
      {
        "code": "PERFMGMT_CONFIG_IDS_IN_USE_BY_WANINTERFACE"
      }
    ]
  }
}

Loading...