Jump to

• Request
• Response

Get an Exclusion Profile by ID

get

/api/discovery/Excludes/{id}

Gets the exclusion profile that matches the specified ID.

Request

Path Parameters

• id(required): integer
  The discovery profile ID.

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 properties of the specified exclusion profile.",
                    "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 properties of the specified exclusion profile.
• 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 properties of the specified exclusion profile.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/discoveryExcludesRead"
            }
        }
    }
}

Nested Schema : data

Type: array

The properties of the specified exclusion profile.

Show Source

• Array of: object discoveryExcludesRead

{
    "description":"The properties of the specified exclusion profile.",
    "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