Link Update Link Attributes

Link Update Link Attributes

Update WAN link attributes (display name, location, alert settings, etc.)

Privileges required:

UPDATE EDGE

Request
URI
POST
https://{api_host}/portal/rest/link/updateLinkAttributes
COPY
Request Body
{
    "enterpriseId": 0,
    "linkId": 0,
    "id": 0,
    "_update": {
        "isp": "string",
        "lat": "string",
        "lon": "string",
        "displayName": "string",
        "backupState": "string",
        "serviceState": "string",
        "alertsEnabled": false,
        "operatorAlertsEnabled": false
    }
}
integer
enterpriseId
Optional

id of the Customer to which the link/Edge belongs. Required when the caller is an Operator or Partner Admin.

integer
linkId
Optional

Link id as reported by e.g. edge/getEdge

integer
id
Optional

Alias for linkId

object
_update
Optional

_update

Responses
200

Request was successfully processed

Returns rows_modified_confirmation of type(s) application/json 
{
    "rows": 1
}
string
error
Optional

An error message explaining why the method failed

integer
rows
Required

The number of rows modified


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 '{}' https://{api_host}/portal/rest/link/updateLinkAttributes
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 Get Secure Device Secrets Option
POST
Edge Set Bastion State
POST
Edge Set Secure Device Secrets Option
POST
Edge Sync Ofc Routes
POST
Edge Update Analytics Settings For Edges
POST
Edge Update Edge Admin Password
POST
Edge Update Edge Attributes
POST
Edge Update Edge Credentials By Configuration
POST
Link Update Link Attributes
POST
Edge Get Edge Csr
POST
Edge Get Edge Pending Csrs
POST
Edge Insert Edge Certificate