Jump to

• Request
• Response

Create a Device Configuration Profile

post

/api/config/Profiles

Creates a new device configuration profile.

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
  Config agent profile type ID Allowed Values: - 1 => SSH - 2 => Telnet

  Example: 1
• ConfigAgentProfileTypeName: string
  Config Agent Profile Type Name

  Example: SSH
• EmailAddresses: string
  Email Address

  Example: [e-mail]
• LoginPrompt: string
  - Login Prompt - Only used when profile type is Telnet - Optional field

  Example:
• Message: string
  Message

  Example: Example Message
• NotificationProfile: integer
  Notification Profile ID

  Example: 51
• NotificationTemplate: integer
  Notification Template ID

  Example: 50
• ProfileDescription: string
  Profile Description

  Example: Example Description
• ProfileName: string
  Profile Name

  Example: SSH Profile
• ProfilePassword: string
  Profile password

  Example: myFakePassword
• ProfileStatus: integer
  Profile status Allowed Values: - 0 => Disabled - 1 => Enabled

  Example: 1
• ProfileUser: string
  Profile user

  Example: Default
• TelnetPort: integer
  - Telnet Port - Only used when profile type is Telnet

  Example: 80

{
    "properties":{
        "ProfileName":{
            "description":"Profile Name",
            "type":"string",
            "example":"SSH Profile"
        },
        "ProfileDescription":{
            "description":"Profile Description",
            "type":"string",
            "example":"Example Description"
        },
        "Message":{
            "description":"Message",
            "type":"string",
            "example":"Example Message"
        },
        "EmailAddresses":{
            "description":"Email Address",
            "type":"string",
            "example":"[e-mail]"
        },
        "ProfileStatus":{
            "description":"Profile status\n\nAllowed Values:\n-  0 => Disabled\n-  1 => Enabled",
            "type":"integer",
            "example":"1"
        },
        "ConfigAgentProfileTypeName":{
            "description":"Config Agent Profile Type Name",
            "type":"string",
            "example":"SSH"
        },
        "NotificationTemplate":{
            "description":"Notification Template ID",
            "type":"integer",
            "example":"50"
        },
        "NotificationProfile":{
            "description":"Notification Profile ID",
            "type":"integer",
            "example":"51"
        },
        "ProfileUser":{
            "description":"Profile user",
            "type":"string",
            "example":"Default"
        },
        "ProfilePassword":{
            "description":"Profile password",
            "type":"string",
            "example":"myFakePassword"
        },
        "ConfigAgentProfileTypeID":{
            "description":"Config agent profile type ID\n\nAllowed Values:\n-  1 => SSH\n-  2 => Telnet",
            "type":"integer",
            "example":"1"
        },
        "TelnetPort":{
            "description":"- Telnet Port\n- Only used when profile type is Telnet",
            "type":"integer",
            "example":"80"
        },
        "LoginPrompt":{
            "description":"- Login Prompt\n- Only used when profile type is Telnet\n- 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
• 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

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 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
  Config agent profile type ID Allowed Values: - 1 => SSH - 2 => Telnet

  Example: 1
• ConfigAgentProfileTypeName: string
  Config Agent Profile Type Name

  Example: SSH
• EmailAddresses: string
  Email Address

  Example: [e-mail]
• LoginPrompt: string
  Login Prompt

  Example: Customized
• Message: string
  Message

  Example: Example Message
• NotificationProfile: integer
  Notification Profile ID

  Example: 51
• NotificationTemplate: integer
  Notification Template ID

  Example: 50
• ProfileDescription: string
  Profile Description

  Example: Example Description
• ProfileName: string
  Profile Name

  Example: SSH Profile
• ProfileStatus: integer
  Profile status Allowed Values: - 0 => Disabled - 1 => Enabled

  Example: 1
• ProfileUser: string
  Profile user

  Example: Default
• TelnetPort: integer
  Telnet Port

  Example: 23

{
    "properties":{
        "ProfileName":{
            "description":"Profile Name",
            "type":"string",
            "example":"SSH Profile"
        },
        "ProfileDescription":{
            "description":"Profile Description",
            "type":"string",
            "example":"Example Description"
        },
        "Message":{
            "description":"Message",
            "type":"string",
            "example":"Example Message"
        },
        "EmailAddresses":{
            "description":"Email Address",
            "type":"string",
            "example":"[e-mail]"
        },
        "ProfileStatus":{
            "description":"Profile status\n\nAllowed Values:\n-  0 => Disabled\n-  1 => Enabled",
            "type":"integer",
            "example":"1"
        },
        "ConfigAgentProfileTypeName":{
            "description":"Config Agent Profile Type Name",
            "type":"string",
            "example":"SSH"
        },
        "NotificationTemplate":{
            "description":"Notification Template ID",
            "type":"integer",
            "example":"50"
        },
        "NotificationProfile":{
            "description":"Notification Profile ID",
            "type":"integer",
            "example":"51"
        },
        "LoginPrompt":{
            "description":"Login Prompt",
            "type":"string",
            "example":"Customized"
        },
        "TelnetPort":{
            "description":"Telnet Port",
            "type":"integer",
            "example":"23"
        },
        "ProfileUser":{
            "description":"Profile user",
            "type":"string",
            "example":"Default"
        },
        "ConfigAgentProfileTypeID":{
            "description":"Config agent profile type ID\n\nAllowed Values:\n-  1 => SSH\n-  2 => Telnet",
            "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":{
                "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