Jump to

• Request
• Response

Create a Device Configuration Profile

post

/api/config/Profiles

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

• ProfileName
• ProfileStatus
• ProfileDescription
• ProfileUser
• ProfilePassword
• NotificationProfile
• NotificationTemplate
• Message
• EmailAddresses

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

• ConfigAgentProfileTypeID: integer
  The configuration agent profile type ID. The possible values are 1 for SSH and 2 for Telnet.

  Example: 1
• ConfigAgentProfileTypeName: string
  The configuration agent profile type name.

  Example: SSH
• EmailAddresses: string
  The email address.

  Example: [e-mail]
• LoginPrompt: string
  Only used when profile type is Telnet. This is an optional field.

  Example:
• Message: string
  Message

  Example: Example Message
• NotificationProfile: integer
  The notification profile ID.

  Example: 51
• NotificationTemplate: integer
  The notification template ID.

  Example: 50
• ProfileDescription: string
  The profile description.

  Example: Example Description
• ProfileName: string
  The profile 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: SSH Profile
• ProfilePassword: string
  The profile password.

  Example: myFakePassword
• ProfileStatus: integer
  Whether the profile is enabled (1 or disabled 0).

  Example: 1
• ProfileUser: string
  The profile user.

  Example: Default
• TelnetPort: integer
  Only used when profile type is Telnet. The value can be anything between 1 to 65535.

  Example: 80

{
    "properties":{
        "ProfileName":{
            "description":"The profile 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":"SSH Profile"
        },
        "ProfileDescription":{
            "description":"The profile description.",
            "type":"string",
            "example":"Example Description"
        },
        "Message":{
            "description":"Message",
            "type":"string",
            "example":"Example Message"
        },
        "EmailAddresses":{
            "description":"The email address.",
            "type":"string",
            "example":"[e-mail]"
        },
        "ProfileStatus":{
            "description":"Whether the profile is enabled (<b>1</b> or disabled <b>0</b>).",
            "type":"integer",
            "example":"1"
        },
        "ConfigAgentProfileTypeName":{
            "description":"The configuration agent profile type name.",
            "type":"string",
            "example":"SSH"
        },
        "NotificationTemplate":{
            "description":"The notification template ID.",
            "type":"integer",
            "example":"50"
        },
        "NotificationProfile":{
            "description":"The notification profile ID.",
            "type":"integer",
            "example":"51"
        },
        "ProfileUser":{
            "description":"The profile user.",
            "type":"string",
            "example":"Default"
        },
        "ProfilePassword":{
            "description":"The profile password.",
            "type":"string",
            "example":"myFakePassword"
        },
        "ConfigAgentProfileTypeID":{
            "description":"The configuration agent profile type ID. The possible values are <b>1</b> for SSH and <b>2</b> for Telnet.",
            "type":"integer",
            "example":"1"
        },
        "TelnetPort":{
            "description":"Only used when profile type is Telnet. The value can be anything between 1 to 65535.",
            "type":"integer",
            "example":"80"
        },
        "LoginPrompt":{
            "description":"Only used when profile type is Telnet. This is an optional field.",
            "type":"string",
            "example":""
        }
    }
}

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 profile.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/configProfilesRead"
                    }
                },
                "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 profile.
• total: integer
  The total number of results regardless of paging.

  Example: 1

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

Show Source

• Array of: object configProfilesRead

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

Nested Schema : configProfilesRead

Type: object

Show Source

• ConfigAgentProfileTypeID: integer
  The configuration agent profile type ID. The possible values are 1 (SSH) and 2 (Telnet).

  Example: 1
• ConfigAgentProfileTypeName: string
  The configuration agent profile type name.

  Example: SSH
• EmailAddresses: string
  The email address.

  Example: [e-mail]
• LoginPrompt: string
  The login prompt.

  Example: Customized
• Message: string
  Message

  Example: Example Message
• NotificationProfile: integer
  The notification profile ID.

  Example: 51
• NotificationTemplate: integer
  The notification template ID.

  Example: 50
• ProfileDescription: string
  The profile description.

  Example: Example Description
• ProfileName: string
  The profile name.

  Example: SSH Profile
• ProfileStatus: integer
  Whether the profile is enabled (1) or disabled (0).

  Example: 1
• ProfileUser: string
  The profile user.

  Example: Default
• TelnetPort: integer
  The telnet port.

  Example: 23

{
    "properties":{
        "ProfileName":{
            "description":"The profile name.",
            "type":"string",
            "example":"SSH Profile"
        },
        "ProfileDescription":{
            "description":"The profile description.",
            "type":"string",
            "example":"Example Description"
        },
        "Message":{
            "description":"Message",
            "type":"string",
            "example":"Example Message"
        },
        "EmailAddresses":{
            "description":"The email address.",
            "type":"string",
            "example":"[e-mail]"
        },
        "ProfileStatus":{
            "description":"Whether the profile is enabled (<b>1</b>) or disabled (<b>0</b>).",
            "type":"integer",
            "example":"1"
        },
        "ConfigAgentProfileTypeName":{
            "description":"The configuration agent profile type name.",
            "type":"string",
            "example":"SSH"
        },
        "NotificationTemplate":{
            "description":"The notification template ID.",
            "type":"integer",
            "example":"50"
        },
        "NotificationProfile":{
            "description":"The notification profile ID.",
            "type":"integer",
            "example":"51"
        },
        "LoginPrompt":{
            "description":"The login prompt.",
            "type":"string",
            "example":"Customized"
        },
        "TelnetPort":{
            "description":"The telnet port.",
            "type":"integer",
            "example":"23"
        },
        "ProfileUser":{
            "description":"The profile user.",
            "type":"string",
            "example":"Default"
        },
        "ConfigAgentProfileTypeID":{
            "description":"The configuration agent profile type ID. The possible values are 1 (<b>SSH</b>) and 2 (<b>Telnet</b>).",
            "type":"integer",
            "example":"1"
        }
    }
}

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