Jump to

• Request
• Response

Get Discovery Exclusion Profiles

get

/api/discovery/Excludes

Gets the discovery exclusion profiles that match the specified parameters. If no parameters are specified, all discovery exclusion profiles are returned.

Request

Query Parameters

• filter: object
  The fields to filter the results by. You cannot filter by fields that contain a state.
  This parameter's value uses the following JSON format:
  { "property": "property", "value": "propertyValue", "operator": "operator", "conjunction": "conjunction" }
  If you use multiple JSON objects to combine filters, for example, to filter by several different device names, you cannot combine OR and AND conjunctions. The conjunction used for the last object applies to the entire list.

  • conjunction: string
    Default Value: OR

    Allowed Values: [ "AND", "OR" ]

    The conjunction between filters.

    Example: AND
  • operator: string
    Default Value: LIKE

    Allowed Values: [ "eq", "ne", "gte", "gt", "lte", "lt", "LIKE", "NOT LIKE", "re", "not re", "NOT IN" ]

    The filter operation to use.

    Example: eq
  • property(required): string
    The name of the field to filter on.

    Example: name
  • value(required): string
    The value of the field to filter on.

    Example: test

  {
      "required":[
          "property",
          "value"
      ],
      "properties":{
          "property":{
              "description":"The name of the field to filter on.",
              "type":"string",
              "example":"name"
          },
          "value":{
              "description":"The value of the field to filter on.",
              "type":"string",
              "example":"test"
          },
          "operator":{
              "description":"The filter operation to use.",
              "type":"string",
              "default":"LIKE",
              "enum":[
                  "eq",
                  "ne",
                  "gte",
                  "gt",
                  "lte",
                  "lt",
                  "LIKE",
                  "NOT LIKE",
                  "re",
                  "not re",
                  "NOT IN"
              ],
              "example":"eq"
          },
          "conjunction":{
              "description":"The conjunction between filters.",
              "type":"string",
              "default":"OR",
              "enum":[
                  "AND",
                  "OR"
              ],
              "example":"AND"
          }
      },
      "type":"object"
  }

• limit: integer(int32)
  The number of records to limit results by. If you do not also set the start parameter, records start at 0.

  Example:

  100

• sort: object
  The field and direction to sort results by. You cannot sort by fields that contain a state.
  This parameters value uses the following JSON format: { "property": "property", "direction": "direction" }

  • direction(required): string
    Allowed Values: [ "ASC", "DESC" ]

    The direction of the sort.

    Example: ASC
  • property(required): string
    The field to sort on.

    Example: name

  {
      "required":[
          "property",
          "direction"
      ],
      "properties":{
          "property":{
              "description":"The field to sort on.",
              "type":"string",
              "example":"name"
          },
          "direction":{
              "description":"The direction of the sort.",
              "type":"string",
              "enum":[
                  "ASC",
                  "DESC"
              ],
              "example":"ASC"
          }
      },
      "type":"object",
      "example":[
          {
              "property":"Name",
              "direction":"ASC"
          },
          {
              "property":"Value",
              "direction":"DESC"
          }
      ]
  }

  Example:

  [
      {
          "property":"Name",
          "direction":"ASC"
      },
      {
          "property":"Value",
          "direction":"DESC"
      }
  ]

• start: integer(int32)
  The page of results to start from. This parameter is ignored if you do not also set the limit parameter.

  Default Value: 0

  Example:

  1

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulGetOperation
  The response body for a successful get operation.
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulGetOperation"
        },
        {
            "type":"object",
            "properties":{
                "total":{
                    "description":"The total number of results regardless of paging",
                    "type":"integer",
                    "example":"1"
                },
                "data":{
                    "description":"The list of discovery exclusion profiles that match the specified parameters.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/discoveryExcludesRead"
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulGetOperation

Type: object

The response body for a successful get operation.

Show Source

• message: string
  The response message.

  Example: Loaded 1 entries
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "description":"The response body for a successful get operation.",
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Loaded 1 entries"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data
  The list of discovery exclusion profiles that match the specified parameters.
• total: integer
  The total number of results regardless of paging

  Example: 1

{
    "type":"object",
    "properties":{
        "total":{
            "description":"The total number of results regardless of paging",
            "type":"integer",
            "example":"1"
        },
        "data":{
            "description":"The list of discovery exclusion profiles that match the specified parameters.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/discoveryExcludesRead"
            }
        }
    }
}

Nested Schema : data

Type: array

The list of discovery exclusion profiles that match the specified parameters.

Show Source

• Array of: object discoveryExcludesRead

{
    "description":"The list of discovery exclusion profiles that match the specified parameters.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/discoveryExcludesRead"
    }
}

Nested Schema : discoveryExcludesRead

Type: object

Show Source

• DeviceZoneID: object DeviceZoneID
  The device zone name and ID.
• DeviceZoneName: string
  The device zone name.

  Example: Default First Zone
• IPRange: string
  The IP range excluded from discovery. For example, 10.*.0-9.1,2,3,4.

  Example: 0.0.0-1.*
• ProfileDescr: string
  The discovery profile description, which explains why the devices are being excluded.

  Example: This is an example of excluding a list of devices from discovery.
• ProfileID: integer
  The discovery profile ID for individual CRUD operations.

  Example: 2
• ProfileName: string
  The discovery profile name.

  Example: Example Device List
• ProfileStatus: string
  The profile status.

  Example: Disabled
• ProfileStatusIcon: string
  The profile status icon.

  Example: OrbRed.png
• ProfileStatusID: integer
  The profile status ID. Either 0 (disabled) or 1 (enabled).

  Example: 0
• ProfileType: string
  The profile type. Allowed Values:

  • 1: IP Range
  • 2: Device List

  Example: Device List
• Seeds: string
  The seeds excluded from discovery.

  Example: 192.168.100.255,10.10.10.255

{
    "type":"object",
    "properties":{
        "ProfileStatusID":{
            "description":"The profile status ID. Either <b>0</b> (disabled) or <b>1</b> (enabled).",
            "type":"integer",
            "example":"0"
        },
        "ProfileStatus":{
            "description":"The profile status.",
            "type":"string",
            "example":"Disabled"
        },
        "DeviceZoneID":{
            "description":"The device zone name and ID.",
            "type":"object",
            "properties":{
                "id":{
                    "description":"The device zone ID.",
                    "type":"integer",
                    "example":"1"
                },
                "name":{
                    "description":"The device zone name associated with the specified <b>id</b>.",
                    "type":"string",
                    "example":"Default First Zone"
                }
            }
        },
        "Seeds":{
            "description":"The seeds excluded from discovery.",
            "type":"string",
            "example":"192.168.100.255,10.10.10.255",
            "nullable":true
        },
        "IPRange":{
            "description":"The IP range excluded from discovery. For example, 10.*.0-9.1,2,3,4.",
            "type":"string",
            "example":"0.0.0-1.*",
            "nullable":true
        },
        "ProfileID":{
            "description":"The discovery profile ID for individual CRUD operations.",
            "type":"integer",
            "example":"2"
        },
        "ProfileName":{
            "description":"The discovery profile name.",
            "type":"string",
            "example":"Example Device List"
        },
        "ProfileDescr":{
            "description":"The discovery profile description, which explains why the devices are being excluded.",
            "type":"string",
            "example":"This is an example of excluding a list of devices from discovery."
        },
        "ProfileStatusIcon":{
            "description":"The profile status icon.",
            "type":"string",
            "example":"OrbRed.png"
        },
        "ProfileType":{
            "description":"The profile type.\nAllowed Values:\n<ul><li><b>1</b>: IP Range</li>\n<li><b>2</b>: Device List</li></ul>",
            "type":"string",
            "example":"Device List"
        },
        "DeviceZoneName":{
            "description":"The device zone name.",
            "type":"string",
            "example":"Default First Zone"
        }
    }
}

Nested Schema : DeviceZoneID

Type: object

The device zone name and ID.

Show Source

• id: integer
  The device zone ID.

  Example: 1
• name: string
  The device zone name associated with the specified id.

  Example: Default First Zone

{
    "description":"The device zone name and ID.",
    "type":"object",
    "properties":{
        "id":{
            "description":"The device zone ID.",
            "type":"integer",
            "example":"1"
        },
        "name":{
            "description":"The device zone name associated with the specified <b>id</b>.",
            "type":"string",
            "example":"Default First Zone"
        }
    }
}

Default Response

Failed operation

Body ()

Root Schema : schema

Type: object

Show Source

• errors: array errors
  The list of errors reported. Validation errors will be keyed by record field.
• message: string
  The response message.

  Example: Exception thrown
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: false

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "description":"An error.",
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

• Array of: object items
  An error.

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "description":"An error.",
        "type":"object"
    }
}

Nested Schema : items

Type: object

An error.

Back to Top