Jump to

• Request
• Response

Create a Device Configuration Policy

post

/api/config/Policies

Creates a new device configuration policy.
The minimum required properties in the request body are:

• ConfigDiscoProfileName
• StatusID
• Description
• DeviceNameRegex
• DeviceMetaTypeID
• DeviceMetaTypeValue
• ConfigAgentProfileID
• ConfigActionProfileID
• DeviceTypeID
• DeviceTypeCategoryID

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ConfigActionProfileID: integer
  The action profile ID.

  Example: 1001
• ConfigAgentProfileID: integer
  The configuration agent profile ID.

  Example: 1001
• ConfigDiscoProfileName: string
  The policy name.
  To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.

  Example: test
• Description: string
  The policy description.

  Example: Example Description
• DeviceMetaTypeID: integer
  The device meta type ID.

  Example: 5
• DeviceMetaTypeValue: string
  The device meta type value.

  Example: Example Value
• DeviceNameRegex: string
  The regular expression to match with device names. Used to limit the policy to specific devices.

  Example: ^(Device-[0-9]{3})$
• DeviceTypeCategoryID: integer
  The device type category ID.

  Example: 6
• DeviceTypeID: string
  The device type ID.

  Example: NONE
• IPRange: string
  The device IP range to which the policy should be applied.

  Example: 192.168.1.0 - 192.168.1.255
• StatusID: integer
  The policy status ID. Either 0 (disabled) or 1 (enabled).

  Example: 0

{
    "properties":{
        "ConfigDiscoProfileName":{
            "description":"The policy name.\n<br>To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, <b>1234</b>, <b>+1234</b>, and <b>-1234</b> are not valid, but <b>US1234</b>, <b>US+1234</b> and <b>US_1234</b> are.",
            "type":"string",
            "example":"test"
        },
        "Description":{
            "description":"The policy description.",
            "type":"string",
            "example":"Example Description"
        },
        "StatusID":{
            "description":"The policy status ID. Either <b>0</b> (disabled) or <b>1</b> (enabled).",
            "type":"integer",
            "example":"0"
        },
        "ConfigAgentProfileID":{
            "description":"The configuration agent profile ID.",
            "type":"integer",
            "example":"1001"
        },
        "ConfigActionProfileID":{
            "description":"The action profile ID.",
            "type":"integer",
            "example":"1001"
        },
        "IPRange":{
            "description":"The device IP range to which the policy should be applied.",
            "type":"string",
            "example":"192.168.1.0 - 192.168.1.255"
        },
        "DeviceNameRegex":{
            "description":"The regular expression to match with device names. Used to limit the policy to specific devices.",
            "type":"string",
            "example":"^(Device-[0-9]{3})$"
        },
        "DeviceTypeCategoryID":{
            "description":"The device type category ID.",
            "type":"integer",
            "example":"6"
        },
        "DeviceMetaTypeID":{
            "description":"The device meta type ID.",
            "type":"integer",
            "example":"5"
        },
        "DeviceMetaTypeValue":{
            "description":"The device meta type value.",
            "type":"string",
            "example":"Example Value"
        },
        "DeviceTypeID":{
            "description":"The device type ID.",
            "type":"string",
            "example":"NONE"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulAddOperation
  The response body for a successful add operation.
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulAddOperation"
        },
        {
            "type":"object",
            "properties":{
                "data":{
                    "description":"The properties of the new device configuration policy.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/configPoliciesRead"
                    }
                },
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                }
            }
        }
    ]
}

Nested Schema : SuccessfulAddOperation

Type: object

The response body for a successful add operation.

Show Source

• message: string
  The response message.

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

  Example: true

{
    "description":"The response body for a successful add 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":"Added record"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data
  The properties of the new device configuration policy.
• total: integer
  The total number of results regardless of paging.

  Example: 1

{
    "type":"object",
    "properties":{
        "data":{
            "description":"The properties of the new device configuration policy.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/configPoliciesRead"
            }
        },
        "total":{
            "description":"The total number of results regardless of paging.",
            "type":"integer",
            "example":"1"
        }
    }
}

Nested Schema : data

Type: array

The properties of the new device configuration policy.

Show Source

• Array of: object configPoliciesRead

{
    "description":"The properties of the new device configuration policy.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/configPoliciesRead"
    }
}

Nested Schema : configPoliciesRead

Type: object

Show Source

• ActionName: string
  The action name.

  Example: SSH Action
• ConfigActionProfileID: integer
  The action profile ID.

  Example: 1001
• ConfigAgentProfileID: integer
  The configuration agent profile ID.

  Example: 1001
• ConfigDiscoProfileID: integer
  The profile ID specified for individual CRUD operations.

  Example: 1004
• ConfigDiscoProfileName: string
  The policy name.

  Example: test
• Description: string
  The policy description.

  Example: Example Description
• DeviceMetaTypeID: integer
  The device meta type ID.

  Example: 5
• DeviceMetaTypeName: string
  The device meta type name.

  Example: Example Name
• DeviceMetaTypeValue: string
  The device meta type value.

  Example: Example Value
• DeviceNameRegex: string
  The regular expression to match with device names. Used to limit the policy to specific devices.

  Example: ^(Device-[0-9]{3})$
• DeviceTypeCategoryID: integer
  The device type category ID.

  Example: 6
• DeviceTypeCategoryName: string
  The device type category name.

  Example: Server
• DeviceTypeID: string
  The device type ID.

  Example: NONE
• DeviceTypeName: string
  The device type name.

  Example: Example Name
• IPRange: string
  The device IP range to apply the policy to.

  Example: 192.168.1.0 - 192.168.1.255
• ProfileName: string
  The profile name.

  Example: SSH Profile
• Status: string
  The status, based on the value of the StatusID property. When StatusID is 0, Status is Disabled. When StatusID is 1, Status is Enabled

  Example: Disabled
• StatusIcon: string
  The 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
  The policy status ID. Either 0 (disabled) or 1 (enabled).

  Example: 0

{
    "properties":{
        "ConfigDiscoProfileID":{
            "description":"The profile ID specified for individual CRUD operations.",
            "type":"integer",
            "example":"1004"
        },
        "ConfigDiscoProfileName":{
            "description":"The policy name.",
            "type":"string",
            "example":"test"
        },
        "Description":{
            "description":"The policy description.",
            "type":"string",
            "example":"Example Description"
        },
        "StatusID":{
            "description":"The policy status ID. Either <b>0</b> (disabled) or <b>1</b> (enabled).",
            "type":"integer",
            "example":"0"
        },
        "Status":{
            "description":"The status, based on the value of the <b>StatusID</b> property. When <b>StatusID</b> is <b>0</b>, <b>Status</b> is <b>Disabled</b>. When <b>StatusID</b> is <b>1</b>, <b>Status</b> is <b>Enabled</b>",
            "type":"string",
            "example":"Disabled"
        },
        "ConfigAgentProfileID":{
            "description":"The configuration agent profile ID.",
            "type":"integer",
            "example":"1001"
        },
        "ProfileName":{
            "description":"The profile name.",
            "type":"string",
            "example":"SSH Profile"
        },
        "ConfigActionProfileID":{
            "description":"The action profile ID.",
            "type":"integer",
            "example":"1001"
        },
        "ActionName":{
            "description":"The action name.",
            "type":"string",
            "example":"SSH Action"
        },
        "IPRange":{
            "description":"The device IP range to apply the policy to.",
            "type":"string",
            "example":"192.168.1.0 - 192.168.1.255"
        },
        "DeviceNameRegex":{
            "description":"The regular expression to match with device names. Used to limit the policy to specific devices.",
            "type":"string",
            "example":"^(Device-[0-9]{3})$"
        },
        "DeviceTypeCategoryName":{
            "description":"The device type category name.",
            "type":"string",
            "example":"Server"
        },
        "DeviceTypeCategoryID":{
            "description":"The device type category ID.",
            "type":"integer",
            "example":"6"
        },
        "DeviceMetaTypeID":{
            "description":"The device meta type ID.",
            "type":"integer",
            "example":"5"
        },
        "DeviceMetaTypeName":{
            "description":"The device meta type name.",
            "type":"string",
            "example":"Example Name"
        },
        "DeviceMetaTypeValue":{
            "description":"The device meta type value.",
            "type":"string",
            "example":"Example Value"
        },
        "DeviceTypeName":{
            "description":"The device type name.",
            "type":"string",
            "example":"Example Name"
        },
        "DeviceTypeID":{
            "description":"The device type ID.",
            "type":"string",
            "example":"NONE"
        },
        "StatusIcon":{
            "description":"The status image name based on <b>StatusID</b>. If <b>StatusID</b> is 0, <b>StatusIcon</b> will be <b>OrbRed.png</b>. If <b>StatusID</b> is 1, <b>StatusIcon</b> will be <b>OrbGreen.png</b>.",
            "type":"string",
            "example":"OrbRed.png"
        }
    }
}

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