Get a Device Configuration Profile by ID
get
/api/config/Profiles/{id}
Gets the device configuration profile that matches the specified ID.
Request
Path Parameters
-
id(required): integer(int32)
The device configuration profile ID.Example:
1
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : schema
Match All
Show Source
-
object
SuccessfulGetOperation
The response body for a successful get operation.
-
object
type
Nested Schema : SuccessfulGetOperation
Type:
object
The response body for a successful get operation.
Show Source
-
message: string
The response message.Example:
Loaded 1 entries
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
true
Nested Schema : configProfilesRead
Type:
Show Source
object
-
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:
abc@email.com
-
LoginPrompt: string
The login prompt.Example:
Customized
-
Message: string
MessageExample:
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
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
-
Array of:
object items
An error.
Nested Schema : items
Type:
object
An error.