REST API for Unified Assurance Core

Get Device Configuration Profiles

get

/api/config/Profiles

Gets the device configuration profiles that match the specified parameters. If no parameters are specified, all device configuration profiles are returned.

Request

Query Parameters

filter: object

The fields to filter the results by. You cannot filter by fields that contain a state.
This parameter's value uses the following JSON format:
{
"property": "property",
"value": "propertyValue",
"operator": "operator",
"conjunction": "conjunction"
}

If you use multiple JSON objects to combine filters, for example, to filter by several different device names, you cannot combine OR and AND conjunctions. The conjunction used for the last object applies to the entire list.

conjunction: string

Default Value: OR

Allowed Values: [ "AND", "OR" ]

The conjunction between filters.

Example: AND
operator: string

Default Value: LIKE

Allowed Values: [ "eq", "ne", "gte", "gt", "lte", "lt", "LIKE", "NOT LIKE", "re", "not re", "NOT IN" ]

The filter operation to use.

Example: eq
property(required): string

The name of the field to filter on.

Example: name
value(required): string

The value of the field to filter on.

Example: test

{
    "required":[
        "property",
        "value"
    ],
    "properties":{
        "property":{
            "description":"The name of the field to filter on.",
            "type":"string",
            "example":"name"
        },
        "value":{
            "description":"The value of the field to filter on.",
            "type":"string",
            "example":"test"
        },
        "operator":{
            "description":"The filter operation to use.",
            "type":"string",
            "default":"LIKE",
            "enum":[
                "eq",
                "ne",
                "gte",
                "gt",
                "lte",
                "lt",
                "LIKE",
                "NOT LIKE",
                "re",
                "not re",
                "NOT IN"
            ],
            "example":"eq"
        },
        "conjunction":{
            "description":"The conjunction between filters.",
            "type":"string",
            "default":"OR",
            "enum":[
                "AND",
                "OR"
            ],
            "example":"AND"
        }
    },
    "type":"object"
}

limit: integer(int32)
The number of records to limit results by.
Example:
```
100
```

sort: object

The field and direction to sort results by. You cannot sort by fields that contain a state.
This parameters value uses the following JSON format:
{
"property": "property",
"direction": "direction"
}

direction(required): string

Allowed Values: [ "ASC", "DESC" ]

The direction of the sort.

Example: ASC
property(required): string

The field to sort on.

Example: name

{
    "required":[
        "property",
        "direction"
    ],
    "properties":{
        "property":{
            "description":"The field to sort on.",
            "type":"string",
            "example":"name"
        },
        "direction":{
            "description":"The direction of the sort.",
            "type":"string",
            "enum":[
                "ASC",
                "DESC"
            ],
            "example":"ASC"
        }
    },
    "type":"object"
}

start: integer(int32)
The page of results to start from.

Default Value: 0
Example:
```
1
```

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : schema

Match All

Show Source

object SuccessfulGetOperation
object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulGetOperation"
        },
        {
            "type":"object",
            "properties":{
                "data":{
                    "description":"The list of all the device configuration profiles that match the specified parameters.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/configProfilesRead"
                    }
                },
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                }
            }
        }
    ]
}

Nested Schema : SuccessfulGetOperation

Type: object

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

{
    "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":"Loaded 1 entries"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

data: array data

The list of all the device configuration profiles that match the specified parameters.
total: integer

The total number of results regardless of paging.

Example: 1

{
    "type":"object",
    "properties":{
        "data":{
            "description":"The list of all the device configuration profiles that match the specified parameters.",
            "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 list of all the device configuration profiles that match the specified parameters.

Show Source

Array of: object configProfilesRead

{
    "description":"The list of all the device configuration profiles that match the specified parameters.",
    "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: abc@email.com
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":"abc@email.com"
        },
        "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

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