Jump to

• Request
• Response
• Examples

Update the Configuration on a Device

post

/rest/{versionId}/configuration/devices/{deviceId}/action

Use this (POST) method to push a device configuration stored on the SDM database to the device and ensure that it is properly activated and used as the running configuration for the device. Actions such as save, activate, and save and activate are supported.

Request

Supported Media Types

• application/xml
• application/json

Path Parameters

• deviceId: string
• versionId: string

Body ()

Root Schema : deviceAction

Type: object

Show Source

• type(optional): string

{
    "properties":{
        "type":{
            "type":"string"
        }
    },
    "type":"object",
    "xml":{
        "name":"deviceAction"
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

successful operation

Body ()

Root Schema : saveActivateResult

Type: object

Show Source

• action(optional): string
• errorMessage(optional): string
• isActivateConfigSuccess(optional): string
• isCreateSuccess(optional): string
• isDeviceFirmwareChangedFailure(optional): string
• isEraseCacheSuccess(optional): string
• isIntegrityCheckSuccess(optional): string
• isLockSuccess(optional): string
• isRestoreConfigSuccess(optional): string
• isSaveConfigSuccess(optional): string
• isUnlockSuccess(optional): string
• isValidationSuccess(optional): string
• status(optional): string
• taskId(optional): string
• validationErrorMessage(optional): string

{
    "properties":{
        "action":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "isActivateConfigSuccess":{
            "type":"string"
        },
        "isCreateSuccess":{
            "type":"string"
        },
        "isDeviceFirmwareChangedFailure":{
            "type":"string"
        },
        "isEraseCacheSuccess":{
            "type":"string"
        },
        "isIntegrityCheckSuccess":{
            "type":"string"
        },
        "isLockSuccess":{
            "type":"string"
        },
        "isRestoreConfigSuccess":{
            "type":"string"
        },
        "isSaveConfigSuccess":{
            "type":"string"
        },
        "isUnlockSuccess":{
            "type":"string"
        },
        "isValidationSuccess":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "taskId":{
            "type":"string"
        },
        "validationErrorMessage":{
            "type":"string"
        }
    },
    "type":"object",
    "xml":{
        "name":"saveActivateResult"
    }
}

400 Response

The user input is invalid.

401 Response

The session ID is invalid.

404 Response

The object (resource URI, device, and so on) of your input request cannot be found.

Back to Top

Examples

Example of Accessing the API with cURL

The following example shows how to update the configuration on a device by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X POST -b sessionid.txt \
    [e-mail] \
    --header "Accept: application/xml" \
    --header "Content-Type: application/xml" \
    "https://example.com:8443/rest/v1.3/configuration/devices/ID9/action"

The following shows an example of the contents of the request.xml file sent as the request body.

<?xml version="1.0" encoding="UTF-8"?>
<deviceAction>
   <type>SaveActivateConfig</type>
</deviceAction>

Example of Accessing the API with Python

The following example shows how to update the configuration on a device by submitting a POST request on the REST resource using Python. This example assumes the cookie variable contains a valid authentication cookie. For an example of authenticating with Python, see Authenticate.

import requests
from lxml import etree
url = "https://example.com:8443/rest/v1.3/configuration/devices/ID9/action"
headers = { "Accept":"application/xml", "Content-Type":"application/xml", "Cookie":cookie }
data = etree.tostring(etree.parse("request.xml"))
resp = requests.post(url, headers=headers, data=data)

Example of the Response Headers

The following shows an example of the response headers.

HTTP/1.1 200 OK
Date: Tue, 12 Sep 2017 20:38:30 GMT
Server: Apache
X-Frame-Options: SAMEORIGIN
Content-Length: 742
Vary: Accept-Encoding
Content-Type: application/xml

Example of the Response Body

The following example shows the contents of the response body in XML format.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<saveActivateResult>
  <action>SaveActivateConfig</action>
  <isActivateConfigSuccess>SUCCESS</isActivateConfigSuccess>
  <isCreateSuccess>SUCCESS</isCreateSuccess>
  <isDeviceFirmwareChangedFailure>false</isDeviceFirmwareChangedFailure>
  <isEraseCacheSuccess>Not Applicable</isEraseCacheSuccess>
  <isIntegrityCheckSuccess>SUCCESS</isIntegrityCheckSuccess>
  <isLockSuccess>SUCCESS</isLockSuccess>
  <isRestoreConfigSuccess>Not Applicable</isRestoreConfigSuccess>
  <isSaveConfigSuccess>SUCCESS</isSaveConfigSuccess>
  <isUnlockSuccess>SUCCESS</isUnlockSuccess>
  <isValidationSuccess>SUCCESS</isValidationSuccess>
  <status>SUCCESS</status>
  <taskId>admin-2017-09-12-20-38-30-897-10.196.0.194</taskId>
</saveActivateResult>

Back to Top