Jump to

• Request
• Response

Create a Device Configuration Collection

post

/api/config/Collections

Creates a new device configuration collection.

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
  Config Action Profile ID

  Example: 1002
• ConfigAgentProfileID: integer
  Config Agent Profile ID

  Example: 1001
• DeviceName: string
  The device the collection pertains to.

  Example: Some Device
• Devices: array Devices
  Device ID array Allowed Values: - To prevent Collection duplication Device, Profile, and Action must be unique.
• DeviceZoneName: string
  The name of the zone the device is in

  Example: Default First Zone
• StatusID: integer
  Status ID Allowed Values: - 0 => Disabled - 1 => Enabled

  Example: 0

{
    "properties":{
        "ConfigAgentProfileID":{
            "description":"Config Agent Profile ID",
            "type":"integer",
            "example":"1001"
        },
        "ConfigActionProfileID":{
            "description":"Config Action Profile ID",
            "type":"integer",
            "example":"1002"
        },
        "DeviceName":{
            "description":"The device the collection pertains to.",
            "type":"string",
            "example":"Some Device"
        },
        "DeviceZoneName":{
            "description":"The name of the zone the device is in",
            "type":"string",
            "example":"Default First Zone"
        },
        "StatusID":{
            "description":"Status ID\n\nAllowed Values:\n-  0 => Disabled\n-  1 => Enabled",
            "type":"integer",
            "example":"0"
        },
        "Devices":{
            "description":"Device ID array\n\nAllowed Values:\n- To prevent Collection duplication Device, Profile, and Action must be unique.",
            "type":"array",
            "example":"[50,19]"
        }
    }
}

Nested Schema : Devices

Type: array

Device ID array Allowed Values: - To prevent Collection duplication Device, Profile, and Action must be unique.

Example:

[50,19]

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulAddOperation
• object type

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

Nested Schema : SuccessfulAddOperation

Type: object

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

{
    "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 collection.
• total: integer
  The total number of results regardless of paging.

  Example: 1

{
    "type":"object",
    "properties":{
        "data":{
            "description":"The properties of the new device configuration collection.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/configCollectionsRead"
            }
        },
        "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 collection.

Show Source

• Array of: object configCollectionsRead

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

Nested Schema : configCollectionsRead

Type: object

Show Source

• ActionName: string
  Action Name

  Example: Example Action Name
• ConfigActionProfileID: integer
  Config Action Profile ID

  Example: 1002
• ConfigAgentProfileID: integer
  Config Agent Profile ID

  Example: 1001
• ConfigCollectionID: integer
  Config Collection ID

  Example: 1003
• DeviceID: integer
  Device ID

  Example: 303
• DeviceName: string
  Device Name most commonly Host FQDN

  Example: server.domain.com
• DeviceZoneName: string
  Device zone name.

  Example: Default First Zone
• 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
  Status ID Allowed Values: - 0 => Disabled - 1 => Enabled

  Example: 0

{
    "properties":{
        "ConfigCollectionID":{
            "description":"Config Collection ID",
            "type":"integer",
            "example":"1003"
        },
        "DeviceName":{
            "description":"Device Name most commonly Host FQDN",
            "type":"string",
            "example":"server.domain.com"
        },
        "DeviceZoneName":{
            "description":"Device zone name.",
            "type":"string",
            "example":"Default First Zone"
        },
        "ProfileName":{
            "description":"Profile Name",
            "type":"string",
            "example":"SSH Profile"
        },
        "ActionName":{
            "description":"Action Name",
            "type":"string",
            "example":"Example Action Name"
        },
        "StatusID":{
            "description":"Status ID\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"
        },
        "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"
        },
        "DeviceID":{
            "description":"Device ID",
            "type":"integer",
            "example":"303"
        },
        "ConfigAgentProfileID":{
            "description":"Config Agent Profile ID",
            "type":"integer",
            "example":"1001"
        },
        "ConfigActionProfileID":{
            "description":"Config Action Profile ID",
            "type":"integer",
            "example":"1002"
        }
    }
}

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