Jump to

• Request
• Response

Update a Device Configuration Policy

put

/api/config/Policies/{id}

Updates the properties of the device configuration policy that matches the specified ID.

Request

Path Parameters

• id(required): integer(int32)
  The device configuration policy ID.

  Example:

  1

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ConfigActionProfileID: integer
  Action Profile ID

  Example: 1001
• ConfigAgentProfileID: integer
  Config Agent Profile ID

  Example: 1001
• ConfigDiscoProfileName: string
  Policy Name

  Example: test
• Description: string
  Policy Description

  Example: Example Description
• DeviceMetaTypeID: integer
  Device Meta Type ID

  Example: 5
• DeviceMetaTypeValue: string
  Device Meta Type Value

  Example: Example Value
• DeviceNameRegex: string
  Regex to match to device names

  Example: ^(Device-[0-9]{3})$
• DeviceTypeCategoryID: integer
  Device Type Category ID

  Example: 6
• DeviceTypeID: string
  Device Type ID

  Example: NONE
• IPRange: string
  Device IP range to apply the policy to

  Example: 192.168.1.0 - 192.168.1.255
• StatusID: integer
  Policy state Allowed Values: - 0 => Disabled - 1 => Enabled

  Example: 0

{
    "properties":{
        "ConfigDiscoProfileName":{
            "description":"Policy Name",
            "type":"string",
            "example":"test"
        },
        "Description":{
            "description":"Policy Description",
            "type":"string",
            "example":"Example Description"
        },
        "StatusID":{
            "description":"Policy state\n\nAllowed Values:\n-  0 => Disabled\n-  1 => Enabled",
            "type":"integer",
            "example":"0"
        },
        "ConfigAgentProfileID":{
            "description":"Config Agent Profile ID",
            "type":"integer",
            "example":"1001"
        },
        "ConfigActionProfileID":{
            "description":"Action Profile ID",
            "type":"integer",
            "example":"1001"
        },
        "IPRange":{
            "description":"Device IP range to apply the policy to",
            "type":"string",
            "example":"192.168.1.0 - 192.168.1.255"
        },
        "DeviceNameRegex":{
            "description":"Regex to match to device names",
            "type":"string",
            "example":"^(Device-[0-9]{3})$"
        },
        "DeviceTypeCategoryID":{
            "description":"Device Type Category ID",
            "type":"integer",
            "example":"6"
        },
        "DeviceMetaTypeID":{
            "description":"Device Meta Type ID",
            "type":"integer",
            "example":"5"
        },
        "DeviceMetaTypeValue":{
            "description":"Device Meta Type Value",
            "type":"string",
            "example":"Example Value"
        },
        "DeviceTypeID":{
            "description":"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 SuccessfulUpdateOperation
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulUpdateOperation"
        },
        {
            "type":"object",
            "properties":{
                "data":{
                    "description":"The properties of the updated 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 : SuccessfulUpdateOperation

Type: object

Show Source

• message: string
  The response message.

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

  Example: true

{
    "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":"Updated record"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

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

  Example: 1

{
    "type":"object",
    "properties":{
        "data":{
            "description":"The properties of the updated 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 updated device configuration policy.

Show Source

• Array of: object configPoliciesRead

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

Nested Schema : configPoliciesRead

Type: object

Show Source

• ActionName: string
  Action Name

  Example: SSH Action
• ConfigActionProfileID: integer
  Action Profile ID

  Example: 1001
• ConfigAgentProfileID: integer
  Config Agent Profile ID

  Example: 1001
• ConfigDiscoProfileID: integer
  Profile ID specified for individual CRUD operations

  Example: 1004
• ConfigDiscoProfileName: string
  Policy Name

  Example: test
• Description: string
  Policy Description

  Example: Example Description
• DeviceMetaTypeID: integer
  Device Meta Type ID

  Example: 5
• DeviceMetaTypeName: string
  Device Meta Type Name

  Example: Example Name
• DeviceMetaTypeValue: string
  Device Meta Type Value

  Example: Example Value
• DeviceNameRegex: string
  Regex to match to device names

  Example: ^(Device-[0-9]{3})$
• DeviceTypeCategoryID: integer
  Device Type Category ID

  Example: 6
• DeviceTypeCategoryName: string
  Device Type Category Name

  Example: Server
• DeviceTypeID: string
  Device Type ID

  Example: NONE
• DeviceTypeName: string
  Device Type Name

  Example: Example Name
• IPRange: string
  Device IP range to apply the policy to

  Example: 192.168.1.0 - 192.168.1.255
• ProfileName: string
  Profile Name

  Example: 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 => Enabled

  Example: 0

{
    "properties":{
        "ConfigDiscoProfileID":{
            "description":"Profile ID specified for individual CRUD operations",
            "type":"integer",
            "example":"1004"
        },
        "ConfigDiscoProfileName":{
            "description":"Policy Name",
            "type":"string",
            "example":"test"
        },
        "Description":{
            "description":"Policy Description",
            "type":"string",
            "example":"Example Description"
        },
        "StatusID":{
            "description":"Policy state\n\nAllowed Values:\n-  0 => Disabled\n-  1 => Enabled",
            "type":"integer",
            "example":"0"
        },
        "Status":{
            "description":"Status based on StatusID\n\n- If StatusID is 0, Status will be \"Disabled\"\n- If StatusID is 1, Status will be \"Enabled\"",
            "type":"string",
            "example":"Disabled"
        },
        "ConfigAgentProfileID":{
            "description":"Config Agent Profile ID",
            "type":"integer",
            "example":"1001"
        },
        "ProfileName":{
            "description":"Profile Name",
            "type":"string",
            "example":"SSH Profile"
        },
        "ConfigActionProfileID":{
            "description":"Action Profile ID",
            "type":"integer",
            "example":"1001"
        },
        "ActionName":{
            "description":"Action Name",
            "type":"string",
            "example":"SSH Action"
        },
        "IPRange":{
            "description":"Device IP range to apply the policy to",
            "type":"string",
            "example":"192.168.1.0 - 192.168.1.255"
        },
        "DeviceNameRegex":{
            "description":"Regex to match to device names",
            "type":"string",
            "example":"^(Device-[0-9]{3})$"
        },
        "DeviceTypeCategoryName":{
            "description":"Device Type Category Name",
            "type":"string",
            "example":"Server"
        },
        "DeviceTypeCategoryID":{
            "description":"Device Type Category ID",
            "type":"integer",
            "example":"6"
        },
        "DeviceMetaTypeID":{
            "description":"Device Meta Type ID",
            "type":"integer",
            "example":"5"
        },
        "DeviceMetaTypeName":{
            "description":"Device Meta Type Name",
            "type":"string",
            "example":"Example Name"
        },
        "DeviceMetaTypeValue":{
            "description":"Device Meta Type Value",
            "type":"string",
            "example":"Example Value"
        },
        "DeviceTypeName":{
            "description":"Device Type Name",
            "type":"string",
            "example":"Example Name"
        },
        "DeviceTypeID":{
            "description":"Device Type ID",
            "type":"string",
            "example":"NONE"
        },
        "StatusIcon":{
            "description":"Status image name based on StatusID.\n\n- If StatusID is 0, StatusIcon will be \"OrbRed.png\"\n- If StatusID is 1, StatusIcon will be \"OrbGreen.png\"",
            "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":{
                "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

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Back to Top