Jump to

• Request
• Response

Get Device Configuration Policies

get

/api/config/Policies

Gets the device configuration policies that match the specified parameters. If no parameters are specified, all device configuration policies 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

  {
      "required":[
          "property",
          "value"
      ],
      "properties":{
          "property":{
              "description":"The name of the field to filter on.",
              "type":"string",
              "example":"name"
          },
          "value":{
              "description":"The value of the field to filter on.",
              "type":"string",
              "example":"test"
          },
          "operator":{
              "description":"The filter operation to use.",
              "type":"string",
              "default":"LIKE",
              "enum":[
                  "eq",
                  "ne",
                  "gte",
                  "gt",
                  "lte",
                  "lt",
                  "LIKE",
                  "NOT LIKE",
                  "re",
                  "not re",
                  "NOT IN"
              ],
              "example":"eq"
          },
          "conjunction":{
              "description":"The conjunction between filters.",
              "type":"string",
              "default":"OR",
              "enum":[
                  "AND",
                  "OR"
              ],
              "example":"AND"
          }
      },
      "type":"object"
  }

• limit: integer(int32)
  The number of records to limit results by. If you do not also set the start parameter, records start at 0.

  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

  {
      "required":[
          "property",
          "direction"
      ],
      "properties":{
          "property":{
              "description":"The field to sort on.",
              "type":"string",
              "example":"name"
          },
          "direction":{
              "description":"The direction of the sort.",
              "type":"string",
              "enum":[
                  "ASC",
                  "DESC"
              ],
              "example":"ASC"
          }
      },
      "type":"object",
      "example":[
          {
              "property":"Name",
              "direction":"ASC"
          },
          {
              "property":"Value",
              "direction":"DESC"
          }
      ]
  }

  Example:

  [
      {
          "property":"Name",
          "direction":"ASC"
      },
      {
          "property":"Value",
          "direction":"DESC"
      }
  ]

• start: integer(int32)
  The page of results to start from. This parameter is ignored if you do not also set the limit parameter.

  Default Value: 0

  Example:

  1

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":{
                "data":{
                    "description":"The list of all the device configuration policies that match the specified parameters.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/configPoliciesRead"
                    }
                },
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                }
            }
        }
    ]
}

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 list of all the device configuration policies that match the specified parameters.
• total: integer
  The total number of results regardless of paging.

  Example: 1

{
    "type":"object",
    "properties":{
        "data":{
            "description":"The list of all the device configuration policies that match the specified parameters.",
            "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 list of all the device configuration policies that match the specified parameters.

Show Source

• Array of: object configPoliciesRead

{
    "description":"The list of all the device configuration policies that match the specified parameters.",
    "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