REST Resources
-
/ -
/apply-cli-configlet-job-results /{id} -
/change-requests -
/change-requests /{id} -
/cli-configlets -
/cli-configlets /cli-configlets-by-context -
/cli-configlets /{configlet-id} -
/cli-configlets /{configlet-id} /applicable-devices -
/cli-configlets /{configlet-id} /apply-cli-configlet -
/cli-configlets /{configlet-id} /apply-configlet -
/cli-configlets /{configlet-id} /cli-configlet-pages -
/cli-configlets /{configlet-id} /cli-configlet-pages /{configuration-id} -
/cli-configlets /{configlet-id} /cli-configlet-pages /{configuration-id} /cli-text -
/cli-configlets /{configlet-id} /cli-configlet-params -
/cli-configlets /{configlet-id} /cli-configlet-params /{param-id} -
/cli-configlets /{configlet-id} /cli-configlet-prepopulate-params -
/cli-configlets /{configlet-id} /compute-parameter-values -
/cli-configlets /{configlet-id} /preview-cli-configlet -
/cli-configlets /{configlet-id} /submit-cli-configlet -
/cli-configlets /{configlet-id} /validate-cli-configlet -
/configuration-views -
/configuration-views /{config-viewer-id} -
/configuration-views /{config-viewer-id} /configuration-view-params /{param-id} -
/exec-commands -
/execute-export-device-configuration -
/job-instances /{job-id} /apply-cli-configlet-job-results -
/job-instances /{job-id} /deploy-configuration-job-results -
/job-instances /{job-id} /validate-cli-configlet-job-results -
/jobs /{job-id} /export-configuration-datas -
/match-cli-configlets-by-context -
/push-configuration -
/retry-deploy-configuration
/api/space/configuration-management/change-requests
The following operations are supported on this resource:
- GET - Gets all change requests
- POST - Creates a change request for a device. (This is a synchronous request.)
- POST - Creates multiple change requests for one or more devices. (This is a synchronous request.)
- POST - Creates schedulable multiple change requests for one or more devices. (This is an asynchronous request.)
GET /change-requests | Version 3 |
This API retrieves all change requests present in the system.
Sample Usage
GET /change-requests
-
Accept Headers:
application/vnd.net.juniper.space.configuration-management.change-requests+xml;version=3
application/vnd.net.juniper.space.configuration-management.change-requests+json;version=3
<change-requests size="1"
uri="/api/space/configuration-management/change-requests">
<change-request key="790"
uri="/configuration-management/change-requests/790">
<deviceId>8</deviceId>
<name>ChangeRequestName_1</name>
<description>testDesc_1</description>
</change-request>
<change-request key="791"
uri="/configuration-management/change-requests/791">
<deviceId>80</deviceId>
<name>ChangeRequestName_2</name>
<description>testDesc_2</description>
</change-request>
</change-requests>
{
"change-requests": {
"@size": "1",
"@uri":
"/api/space/configuration-management/change-requests",
"change-request": [
{
"@key": "790",
"@uri":
"/configuration-management/change-requests/790",
"deviceId": "8",
"name": "ChangeRequestName_1",
"description" : "testDesc_1"
},
{
"@key": "791",
"@uri":
"/configuration-management/change-requests/791",
"deviceId": "80",
"name": "ChangeRequestName_2",
"description": "testDesc_2"
}
]
}
}
Access Control
The following capabilities are required to access this API: ViewChangeRequestsCap
For the deprecated versions of this API, refer to :
version 1
POST /change-requests | Version 2 |
This API creates a change request for a particular device based on input parameters. This API is a synchronous API.
Note: If the client does not provide an accept header, this synchronous API is called by default.
To execute this API asynchronously, you need an Accept header similar to the following:
Accept application/vnd.net.juniper.space.job-managemnt.task+xml;version=1.Sample Usage
POST /change-requests
-
Content-Type Headers:
application/vnd.net.juniper.space.configuration-management.change-request+xml;version=2;charset=UTF-8
application/vnd.net.juniper.space.configuration-management.change-request+json;version=2;charset=UTF-8 -
Accept Headers:
application/vnd.net.juniper.space.configuration-management.change-request+xml;version=2
application/vnd.net.juniper.space.configuration-management.change-request+json;version=2
<?xml version="1.0" encoding="UTF-8"?>
<change-request>
<name>TEST_NAME</name>
<description>TEST_DESC</description>
<xmlData>
<![CDATA[<configuration>
<system>
<host-name>host-srx_100_updated</host-name>
</system>
</configuration>]]>
</xmlData>
<device href="/api/space/device-management/devices/950288" />
<syncAfterPush>true</syncAfterPush>
</change-request>
<change-request
uri="/api/space/configuration-management/change-requests/223344">
<name>TEST_NAME</name>
<description>TEST_DESC</description>
<xmlData>
<![CDATA[
<configuration>
<system>
<host-name>host-
srx_100_updated</host-name>
</system>
</configuration>
]]>
</xmlData>
<device href="/api/space/device-management/devices/229377"/>
<syncAfterPush>true</syncAfterPush>
<result>
Status: Success, ResultMessage: updateEditConfig Results
lock Success. edit-config Success. commit Success. unlock
Success.
rpc-reply:
<rpc-reply><rpc-reply><ok
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"
xmlns:junos="http://xml.juniper.net/junos/11.2R1/junos"
/></rpc-reply></rpc-reply>
<rpc-reply><rpc-reply><ok
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"
xmlns:junos="http://xml.juniper.net/junos/11.2R1/junos"
/></rpc-reply></rpc-reply>
<rpc-reply><rpc-reply><ok
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"
xmlns:junos="http://xml.juniper.net/junos/11.2R1/junos"
/></rpc-reply></rpc-reply>
<rpc-reply><rpc-reply><ok
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"
xmlns:junos="http://xml.juniper.net/junos/11.2R1/junos"
/></rpc-reply></rpc-reply>
</result>
</change-request>
{
"change-request":{
"name":"TEST_NAME",
"description":"TEST_DESC",
"xmlData":"<configuration><system><host-name>host- srx_100_updated</host-name></system></configuration>",
"device":{
"@href":"/api/space/device-management/devices/950288"
},
"syncAfterPush":"true"
}
}
{
"change-request":
{
"@uri":"/api/space/configuration-management/change-requests/223344",
"name":"TEST_NAME",
"description":"TEST_DESC",
"xmlData":
"<configuration>
<system>
<host-name>host-
srx_100_updated</host-name>
</system>
</configuration>",
"device":{
"@href":
"/api/space/device-management/devices/229377"
},
"syncAfterPush":true,
"result":"Status: Success, ResultMessage:
updateEditConfig Results
lock Success.edit-config Success.commit
Success.unlock Success.
rpc-reply:
<rpc-reply><rpc-reply><ok
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"
xmlns:junos="http://xml.juniper.net/junos/11.2R1/junos"
/></rpc-reply></rpc-reply>
<rpc-reply><rpc-reply><ok
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"
xmlns:junos="http://xml.juniper.net/junos/11.2R1/junos"
/></rpc-reply></rpc-reply>
<rpc-reply><rpc-reply><ok
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"
xmlns:junos="http://xml.juniper.net/junos/11.2R1/junos"
/></rpc-reply></rpc-reply>
<rpc-reply><rpc-reply><ok
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"
xmlns:junos="http://xml.juniper.net/junos/11.2R1/junos"
/></rpc-reply></rpc-reply>"
}
}
Access Control
The following capabilities are required to access this API: ExecuteChangeRequestsCap
For the deprecated versions of this API, refer to :
version 1
POST /change-requests | Version 2 |
This API can create multiple change requests for one or more devices based on input parameters. This is a synchronous API.
Note: If the client does not provide an accept header, this synchronous API is called by default.Sample Usage
POST /change-requests
-
Content-Type Headers:
application/vnd.net.juniper.space.configuration-management.change-requests+xml;version=2;charset=UTF-8
application/vnd.net.juniper.space.configuration-management.change-requests+json;version=2;charset=UTF-8 -
Accept Headers:
application/vnd.net.juniper.space.configuration-management.change-requests+xml;version=2
application/vnd.net.juniper.space.configuration-management.change-requests+json;version=2
<change-requests>
<change-request>
<name>TEST_NAME</name>
<description>TEST_DESC</description>
<xmlData>
<![CDATA[
<configuration>
<system>
<syslog>
<file>
<name>messages</name>
<contents>
<name>authorization</name>
<info/>
</contents>
</file>
</syslog>
</system>
</configuration>
]]>
</xmlData>
<device href="/api/space/device-management/devices/229377"/>
<syncAfterPush>true</syncAfterPush>
</change-request>
<change-request>
<name>TEST_NAME</name>
<description>TEST_DESC</description>
<xmlData>
<![CDATA[
<configuration>
<system>
<syslog>
<file>
<name>messages</name>
<contents>
<name>authorization</name>
<info/>
</contents>
</file>
</syslog>
</system>
</configuration>
]]>
</xmlData>
<device href="/api/space/device-management/devices/229378"/>
<syncAfterPush>true</syncAfterPush>
</change-request>
</change-requests>
<change-requests uri="/api/space/configuration-management/change-requests">
<change-request href="/api/space/configuration-management/change-requests/950274">
<name>TEST_NAME</name>
<description>TEST_DESC</description>
<xmlData>
<configuration><system><syslog><file><name>messages</name><contents><name> authorization </name><info/></contents></file></syslog></system></configuration>
</xmlData>
<device href="/api/space/device-management/devices/229377"/>
<syncAfterPush>true</syncAfterPush>
<result>
<status>Success</status>
<message>updateEditConfig Results lock Success. edit-config Success. commit Success. unlock Success.</message>
<rpc-reply>
<rpc-reply><rpc-reply><ok xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" xmlns:junos="http://xml.juniper.net/junos/11.2R1/junos" /></rpc-reply></rpc-reply>
<rpc-reply><rpc-reply><ok xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" xmlns:junos="http://xml.juniper.net/junos/11.2R1/junos" /></rpc-reply></rpc-reply>
<rpc-reply><rpc-reply><ok xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" xmlns:junos="http://xml.juniper.net/junos/11.2R1/junos" /></rpc-reply></rpc-reply>
<rpc-reply><rpc-reply><ok xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" xmlns:junos="http://xml.juniper.net/junos/11.2R1/junos" /></rpc-reply></rpc-reply>
</rpc-reply>
</result>
</change-request>
<change-request href="/api/space/configuration-management/change-requests/950275">
<name>TEST_NAME</name>
<description>TEST_DESC</description>
<xmlData>
<configuration><system><syslog><file><name>messages</name><contents><name> authorization </name><info/></contents></file></syslog></system></configuration>
</xmlData>
<device href="/api/space/device-management/devices/229378"/>
<syncAfterPush>true</syncAfterPush>
<result>
<status>Success</status>
<message>updateEditConfig Results lock Success. edit-config Success. commit Success. unlock Success.</message>
<rpc-reply>
<rpc-reply><rpc-reply><ok xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" xmlns:junos="http://xml.juniper.net/junos/11.2R1/junos" /></rpc-reply></rpc-reply>
<rpc-reply><rpc-reply><ok xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" xmlns:junos="http://xml.juniper.net/junos/11.2R1/junos" /></rpc-reply></rpc-reply>
<rpc-reply><rpc-reply><ok xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" xmlns:junos="http://xml.juniper.net/junos/11.2R1/junos" /></rpc-reply></rpc-reply>
<rpc-reply><rpc-reply><ok xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" xmlns:junos="http://xml.juniper.net/junos/11.2R1/junos" /></rpc-reply></rpc-reply>
</rpc-reply>
</result>
</change-request>
</change-requests>
{
"change-requests": {
"change-request": [
{
"name": "TEST_NAME",
"description": "TEST_DESC",
"xmlData": "<configuration><system><syslog><file><name>messages<\/name><contents><name>authorization<\/name><info/><\/contents><\/file><\/syslog><\/system><\/configuration>",
"device": {
"@href": "/api/space/device-management/devices/229377"
},
"syncAfterPush": "true"
},
{
"name": "TEST_NAME",
"description": "TEST_DESC",
"xmlData": "<configuration><system><syslog><file><name>messages<\/name><contents><name>authorization<\/name><info/><\/contents><\/file><\/syslog><\/system><\/configuration>",
"device": {
"@href": "/api/space/device-management/devices/229377"
},
"syncAfterPush": "true"
}
]
}
}
{
"change-requests":{
"@uri": "/api/space/configuration-management/change-requests",
"change-request":[
{
"@href": "/api/space/configuration-management/change-requests/950274",
"name":"TEST_NAME",
"description":"TEST_DESC",
"xmlData":
"<configuration>
<system>
<syslog>
<file>
<name>messages</name>
<contents>
<name>authorization</name>
<info/>
</contents>
</file>
</syslog >
</system>
</configuration>",
"device":{
"@href": "/api/space/device-management/devices/229377"
},
"syncAfterPush":"true",
"result":{
"status": "Success",
"message": updateEditConfig Results, lock Success.edit-config Success.commit Success.unlock Success.
"rpc-reply": "<rpc-reply><rpc-reply><ok xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" xmlns:junos="http://xml.juniper.net/junos/11.2R1/junos" /></rpc-reply></rpc-reply>
<rpc-reply><rpc-reply><ok xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" xmlns:junos="http://xml.juniper.net/junos/11.2R1/junos" /></rpc-reply></rpc-reply>
<rpc-reply><rpc-reply><ok xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" xmlns:junos="http://xml.juniper.net/junos/11.2R1/junos" /></rpc-reply></rpc-reply>
<rpc-reply><rpc-reply><ok xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" xmlns:junos="http://xml.juniper.net/junos/11.2R1/junos" /></rpc-reply></rpc-reply>"
}
},
{
"@href": "/api/space/configuration-management/change-requests/950275",
"name":"TEST_NAME",
"description":"TEST_DESC",
"xmlData": "<configuration><system><syslog><file><name>messages</name><contents><name>authorization</name><info/></contents></file></syslog></system></configuration>" ,
"device":{
"@href": "/api/space/device-management/devices/229377"
},
"syncAfterPush":"true",
"result":{
"status": "Success",
"message": updateEditConfig Results, lock Success.edit-config Success.commit Success.unlock Success.
"rpc-reply": "<rpc-reply><rpc-reply><ok xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" xmlns:junos="http://xml.juniper.net/junos/11.2R1/junos" /></rpc-reply></rpc-reply>
<rpc-reply><rpc-reply><ok xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" xmlns:junos="http://xml.juniper.net/junos/11.2R1/junos" /></rpc-reply></rpc-reply>
<rpc-reply><rpc-reply><ok xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" xmlns:junos="http://xml.juniper.net/junos/11.2R1/junos" /></rpc-reply></rpc-reply>
<rpc-reply><rpc-reply><ok xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" xmlns:junos="http://xml.juniper.net/junos/11.2R1/junos" /></rpc-reply></rpc-reply>"
}
}
]
}
}
Access Control
The following capabilities are required to access this API: ExecuteChangeRequestsCap
POST /change-requests | Version 2 |
This API can create schedulable multiple change requests for one or more devices based on input parameters. This is an asynchronous API.
Note: If the client does not provide an accept header, this synchronous API is called by default.Sample Usage
This API makes an asynchronous method call; so, you can optionally specify queue and schedule parameters:
POST /change-requests?queue=<queue>&schedule=<schedule>
Note: The queue URL denoted by <queue> must have been created already.
-
Parameters:
Name Type URI Type Description Required queue Queue URL Query A fully qualified queue URL, where job progress notifications will be sent (See Asynchronous API Usage) N schedule cron-like-expression Query Schedule this API in the future, by specifying a cron-like-expression (See Job Scheduling) N
-
Content-Type Headers:
application/vnd.net.juniper.space.configuration-management.change-requests+xml;version=2;charset=UTF-8
application/vnd.net.juniper.space.configuration-management.change-requests+json;version=2;charset=UTF-8 -
Accept Headers:
application/vnd.net.juniper.space.job-management.task+xml;version=1
application/vnd.net.juniper.space.job-management.task+json;version=1
<change-requests>
<change-request>
<name>TEST_NAME</name>
<description>TEST_DESC</description>
<xmlData>
<![CDATA[
<configuration>
<system>
<syslog>
<file>
<name>messages</name>
<contents>
<name>authorization</name>
<info/>
</contents>
</file>
</syslog>
</system>
</configuration>
]]>
</xmlData>
<device href="/api/space/device-management/devices/229377"/>
<syncAfterPush>true</syncAfterPush>
</change-request>
<change-request>
<name>TEST_NAME</name>
<description>TEST_DESC</description>
<xmlData>
<![CDATA[
<configuration>
<system>
<syslog> <file>
<name>messages</name>
<contents>
<name>authorization</name>
<info/>
</contents>
</file>
</syslog>
</system>
</configuration>
]]>
</xmlData>
<device href="/api/space/device-management/devices/229378"/>
<syncAfterPush>true</syncAfterPush>
</change-request>
</change-requests>
<task href="/api/space/job-management/jobs/688132">
<id>917507</id>
</task>
{
"change-requests":{
"change-request":[
{
"name":"TEST_NAME",
"description":"TEST_DESC",
"xmlData":"<configuration><system><syslog><file><name>messages</name><contents><name>authorization</name><info/></contents></file></syslog></system></configuration>",
"device":{
"@href":"/api/space/device-management/devices/229377"
},
"syncAfterPush":"true"
},
{
"name":"TEST_NAME",
"description":"TEST_DESC",
"xmlData":"<configuration><system><syslog><file><name>messages</name><contents><name>authorization</name><info/></contents></file></syslog></system></configuration>",
"device":{
"@href": "/api/space/device-management/devices/229378"
},
"syncAfterPush":"true"
}
]
}
}
{
"task":{
""@href":"/api/space/job-management/jobs/688132",
"id":917507
}
Access Control
The following capabilities are required to access this API: ExecuteChangeRequestsCap