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
-
conjunction:
string
-
limit: integer(int32)
The number of records to limit results by.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
-
direction(required):
string
-
start: integer(int32)
The page of results to start from.Default Value:
0
Example:1
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulGetOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Loaded 1 entries
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
true
Nested Schema : type
Type:
Show Source
object
-
data: array
data
The list of discovery exclusion profiles that match the specified parameters.
-
total: integer
The total number of results regardless of pagingExample:
1
Nested Schema : data
Type:
array
The list of discovery exclusion profiles that match the specified parameters.
Show Source
Nested Schema : discoveryExcludesRead
Type:
Show Source
object
-
DeviceZoneID: object
DeviceZoneID
Unique identifier for Device Zone.
-
DeviceZoneName: string
Device Zone NameExample:
Default First Zone
-
IPRange: string
IP Range (e.g. 10.*.0-9.1,2,3,4) to be excludedExample:
0.0.0-1.*
-
ProfileDescr: string
Profile Description (why the devices are being excluded)Example:
This is an example of excluding a list of devices from discovery
-
ProfileID: integer
Discovery Profile ID specified for individual CRUD operationsExample:
2
-
ProfileName: string
Profile NameExample:
Example Device List
-
ProfileStatus: string
Profile StatusExample:
Disabled
-
ProfileStatusIcon: string
Profile Status IconExample:
OrbRed.png
-
ProfileStatusID: integer
Profile Status ID Allowed Values: - 0 => Disabled - 1 => EnabledExample:
0
-
ProfileType: string
Profile Type Allowed Values: - 1 => IP Range - 2 => Device ListExample:
Device List
-
Seeds: string
Seeds (e.g. 10.10.10.1,hostname,172.16.10.1) to be excludedExample:
192.168.100.255,10.10.10.255
Nested Schema : DeviceZoneID
Type:
object
Unique identifier for Device Zone.
Show Source
-
id: integer
Device Zone IDExample:
1
-
name: string
Device Zone name associated with IDExample:
Default First Zone
Default Response
Failed operation
Root Schema : schema
Type:
Show Source
object
-
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
Nested Schema : errors
Type:
array
The list of errors reported. Validation errors will be keyed by record field.
Show Source
Nested Schema : items
Type:
object