Update an Exclusion Profile
put
/api/discovery/Excludes/{id}
Updates the properties of the exclusion profile that matches the specified ID.
Request
Path Parameters
-
id(required): integer
The discovery profile ID.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
DeviceZoneID: integer
Unique identifier for Device Zone.Example:
1
-
IPRange: string
IP Range (e.g. 10.*.0-9.1,2,3,4) to be excluded. If ProfileTypeID is 1, then it is required.Example:
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
-
ProfileName: string
Profile NameExample:
Example Device List
-
ProfileStatusID: integer
Profile Status ID Allowed Values: - 0 => Disabled - 1 => EnabledExample:
0
-
ProfileTypeID: integer
Profile Type ID Allowed Values: - 1 => IP Range - 2 => Device ListExample:
1
-
Seeds: string
Seeds (e.g. 10.10.10.1,hostname,172.16.10.1) to be excluded. If ProfileTypeID is 2, then it is required.Example:
192.168.100.255,10.10.10.255
Response
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulUpdateOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Updated record
-
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 properties of the updated exclusion profile.
-
total: integer
The total number of results regardless of paging.Example:
1
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