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
Root Schema : schema
Type:
Show Source
object
-
ConfigAgentProfileTypeID: integer
Config agent profile type ID Allowed Values: - 1 => SSH - 2 => TelnetExample:
1
-
ConfigAgentProfileTypeName: string
Config Agent Profile Type NameExample:
SSH
-
EmailAddresses: string
Email AddressExample:
abc@email.com
-
LoginPrompt: string
- Login Prompt - Only used when profile type is Telnet - Optional fieldExample:
-
Message: string
MessageExample:
Example Message
-
NotificationProfile: integer
Notification Profile IDExample:
51
-
NotificationTemplate: integer
Notification Template IDExample:
50
-
ProfileDescription: string
Profile DescriptionExample:
Example Description
-
ProfileName: string
Profile NameExample:
SSH Profile
-
ProfilePassword: string
Profile passwordExample:
myFakePassword
-
ProfileStatus: integer
Profile status Allowed Values: - 0 => Disabled - 1 => EnabledExample:
1
-
ProfileUser: string
Profile userExample:
Default
-
TelnetPort: integer
- Telnet Port - Only used when profile type is TelnetExample:
80
Response
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulAddOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Added record
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
true
Nested Schema : type
Type:
Show Source
object
-
data: array
data
The properties of the new device configuration profile.
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : data
Type:
array
The properties of the new device configuration profile.
Show Source
Nested Schema : configProfilesRead
Type:
Show Source
object
-
ConfigAgentProfileTypeID: integer
Config agent profile type ID Allowed Values: - 1 => SSH - 2 => TelnetExample:
1
-
ConfigAgentProfileTypeName: string
Config Agent Profile Type NameExample:
SSH
-
EmailAddresses: string
Email AddressExample:
abc@email.com
-
LoginPrompt: string
Login PromptExample:
Customized
-
Message: string
MessageExample:
Example Message
-
NotificationProfile: integer
Notification Profile IDExample:
51
-
NotificationTemplate: integer
Notification Template IDExample:
50
-
ProfileDescription: string
Profile DescriptionExample:
Example Description
-
ProfileName: string
Profile NameExample:
SSH Profile
-
ProfileStatus: integer
Profile status Allowed Values: - 0 => Disabled - 1 => EnabledExample:
1
-
ProfileUser: string
Profile userExample:
Default
-
TelnetPort: integer
Telnet PortExample:
23
Default Response
Failed operation
Root Schema : schema
Type:
Show Source
object
-
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
Nested Schema : errors
Type:
array
The list of errors reported. Validation errors will be keyed by record field.
Show Source
Nested Schema : items
Type:
object