Edge Update Edge Credentials By Configuration

Edge Update Edge Credentials By Configuration

Requests an update to the Edge-local UI authentication credentials for all Edges belonging to the specified configuration profile. On success, returns a JSON object containing a list of each of the action IDs queued.

Privileges required:

UPDATE EDGE

UPDATE ENTERPRISE_KEYS

Request
URI
POST
https://{api_host}/portal/rest/edge/updateEdgeCredentialsByConfiguration
COPY
Request Body

Show optional properties

{
    "configurationId": 0,
    "credentials": {}
}
{
    "configurationId": 0,
    "credentials": {
        "username": "string",
        "password": "string"
    }
}
integer
configurationId
Required

configurationId

object
credentials
Required

credentials

Responses
200

Request was successfully processed

Returns edge_update_edge_credentials_by_configuration_result of type(s) application/json 
{
    "actionIds": [
        0
    ]
}
array of integer
actionIds
Required

actionIds


400
Returns generic_400 of type(s) application/json
Operation doesn't return any data structure

500
Returns generic_500 of type(s) application/json
Operation doesn't return any data structure

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"configurationId:"integer","credentials:"object"}' https://{api_host}/portal/rest/edge/updateEdgeCredentialsByConfiguration
On This Page
Edge Operations
POST
Edge Edge Cancel Reactivation
POST
Edge Edge Provision
POST
Edge Edge Request Reactivation
POST
Edge Get Client Visibility Mode
POST
Edge Get Edge
POST
Edge Get Edge Configuration Modules
POST
Edge Get Edge Configuration Stack
POST
Edge Get Edge Sdwan Peers
POST
Edge Update Edge Admin Password
POST
Edge Update Edge Attributes
POST
Edge Update Edge Credentials By Configuration