Create a Device Configuration Policy
post
/api/config/Policies
Creates a new device configuration policy.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
ConfigActionProfileID: integer
Action Profile IDExample:
1001
-
ConfigAgentProfileID: integer
Config Agent Profile IDExample:
1001
-
ConfigDiscoProfileName: string
Policy NameExample:
test
-
Description: string
Policy DescriptionExample:
Example Description
-
DeviceMetaTypeID: integer
Device Meta Type IDExample:
5
-
DeviceMetaTypeValue: string
Device Meta Type ValueExample:
Example Value
-
DeviceNameRegex: string
Regex to match to device namesExample:
^(Device-[0-9]{3})$
-
DeviceTypeCategoryID: integer
Device Type Category IDExample:
6
-
DeviceTypeID: string
Device Type IDExample:
NONE
-
IPRange: string
Device IP range to apply the policy toExample:
192.168.1.0 - 192.168.1.255
-
StatusID: integer
Policy state Allowed Values: - 0 => Disabled - 1 => EnabledExample:
0
Response
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulAddOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Added 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 new device configuration policy.
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : configPoliciesRead
Type:
Show Source
object
-
ActionName: string
Action NameExample:
SSH Action
-
ConfigActionProfileID: integer
Action Profile IDExample:
1001
-
ConfigAgentProfileID: integer
Config Agent Profile IDExample:
1001
-
ConfigDiscoProfileID: integer
Profile ID specified for individual CRUD operationsExample:
1004
-
ConfigDiscoProfileName: string
Policy NameExample:
test
-
Description: string
Policy DescriptionExample:
Example Description
-
DeviceMetaTypeID: integer
Device Meta Type IDExample:
5
-
DeviceMetaTypeName: string
Device Meta Type NameExample:
Example Name
-
DeviceMetaTypeValue: string
Device Meta Type ValueExample:
Example Value
-
DeviceNameRegex: string
Regex to match to device namesExample:
^(Device-[0-9]{3})$
-
DeviceTypeCategoryID: integer
Device Type Category IDExample:
6
-
DeviceTypeCategoryName: string
Device Type Category NameExample:
Server
-
DeviceTypeID: string
Device Type IDExample:
NONE
-
DeviceTypeName: string
Device Type NameExample:
Example Name
-
IPRange: string
Device IP range to apply the policy toExample:
192.168.1.0 - 192.168.1.255
-
ProfileName: string
Profile NameExample:
SSH Profile
-
Status: string
Status based on StatusID - If StatusID is 0, Status will be "Disabled" - If StatusID is 1, Status will be "Enabled"Example:
Disabled
-
StatusIcon: string
Status image name based on StatusID. - If StatusID is 0, StatusIcon will be "OrbRed.png" - If StatusID is 1, StatusIcon will be "OrbGreen.png"Example:
OrbRed.png
-
StatusID: integer
Policy state Allowed Values: - 0 => Disabled - 1 => EnabledExample:
0
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