Edge Update Edge Attributes

Edge Update Edge Attributes

Updates basic attributes (including Edge name, description, site information, and serial number) for the specified Edge. Expects an _update object containing the field(s) to be updated and their corresponding value(s).

Privileges required:

UPDATE EDGE

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

Show optional properties

{
    "_update": {}
}
{
    "id": 0,
    "enterpriseId": 0,
    "_update": {
        "site": {
            "id": 0,
            "created": "string",
            "name": "string",
            "contactName": "string",
            "contactPhone": "string",
            "contactMobile": "string",
            "contactEmail": "string",
            "streetAddress": "string",
            "streetAddress2": "string",
            "city": "string",
            "state": "string",
            "postalCode": "string",
            "country": "string",
            "lat": "number",
            "lon": "number",
            "timezone": "string",
            "locale": "string",
            "shippingSameAsLocation": 0,
            "shippingContactName": "string",
            "shippingAddress": "string",
            "shippingAddress2": "string",
            "shippingCity": "string",
            "shippingState": "string",
            "shippingCountry": "string",
            "shippingPostalCode": "string",
            "modified": "string"
        },
        "name": "string",
        "description": "string",
        "serialNumber": "string",
        "customInfo": "string"
    }
}
integer
id
Optional

id

integer
enterpriseId
Optional

enterpriseId

object
_update
Required

_update

Responses
200

Request was successfully processed

Returns edge_update_edge_attributes_result of type(s) application/json
This response body class contains all of the following: Inlineedge_update_edge_attributes_result0 
"edge_update_edge_attributes_result Object"

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 '{"_update:"object"}' https://{api_host}/portal/rest/edge/updateEdgeAttributes
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