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/{id}
The following operations are supported on this resource:
GET /change-requests/{id} | Version 1 |
This API retrieves details of a change request for a given change request ID.
Sample Usage
GET /change-requests/{id}
-
Parameters:
Name Type URI Type Description Required id Integer Path The ID of the change request for which details are to be fetched Y
-
Accept Headers:
application/vnd.net.juniper.space.configuration-management.change-request+xml;version=1
application/vnd.net.juniper.space.configuration-management.change-request+json;version=1
<change-request>
<device href="/api/space/device-management/devices/196609">
<id>196609</id>
<deviceFamily>junos-es</deviceFamily>
<OSVersion>10.0R2.10</OSVersion>
<platform>SRX100-LM</platform>
<serialNumber>AT5109AF0621</serialNumber>
<connectionStatus>up</connectionStatus>
<ipAddr>192.168.21.9</ipAddr>
<managedStatus>In Sync</managedStatus>
<name>hsc-srx_200</name>
<hostName>hsc-srx_200</hostName>
</device>
<name>TEST</name>
<description>testDesc</description>
<xmlData>
<configuration>
<groups>
<name>JUNIPER_TEAM</name>
<snmp><location>PVC LAB
Test5</location></snmp>
</groups>
</configuration>
</xmlData>
</change-request>
{
"change-request": {
"device": {
"@href":
"/api/space/device-management/devices/196609",
"id": "196609",
"deviceFamily": "junos-es",
"OSVersion": "10.0R2.10",
"platform": "SRX100-LM",
"serialNumber": "AT5109AF0621",
"connectionStatus": "up",
"ipAddr": "192.168.21.9",
"managedStatus": "In Sync",
"name": "hsc-srx_200",
"hostName": "hsc-srx_200"
},
"name": "TEST",
"description": "testDesc",
"xmlData": "<configuration><groups><name>JUNIPER_TEAM</name><snmp><location>PVC LAB Test5</location></snmp></groups></configuration>"
}
}
Access Control
The following capabilities are required to access this API: ViewChangeRequestsCap
PUT /change-requests/{id} | Version 1 |
This API updates an existing change request based on the change request ID. The user will be not able to modify the change request if it has been executed already.
Sample Usage
PUT /change-requests/{id}
-
Parameters:
Name Type URI Type Description Required id Integer Path The ID of the change request to be updated Y
-
Content-Type Headers:
application/vnd.net.juniper.space.configuration-management.change-request+xml;version=1;charset=UTF-8
application/vnd.net.juniper.space.configuration-management.change-request+json;version=1;charset=UTF-8 -
Accept Headers:
application/vnd.net.juniper.space.configuration-management.change-request+xml;version=1
application/vnd.net.juniper.space.configuration-management.change-request+json;version=1
<change-request>
<name>TEST_NAME</name>
<description>TEST_DESC</description>
<xmlData>
<![CDATA[<config><loc>TEST_CONF
</loc></config> ]]>
</xmlData>
<syncAfterPush>true</syncAfterPush>
</change-request>
<change-request>
<device href="/api/space/device-management/devices/196609">
<id>196609</id>
<deviceFamily>junos-es</deviceFamily>
<OSVersion>10.0R2.10</OSVersion>
<platform>SRX100-LM</platform>
<serialNumber>AT5109AF0621</serialNumber>
<connectionStatus>up</connectionStatus>
<ipAddr>192.168.21.9</ipAddr>
<managedStatus>In Sync</managedStatus>
<name>hsc-srx_200</name>
<hostName>hsc-srx_200</hostName>
</device>
<name>TEST</name>
<description>testDesc</description>
<xmlData>
<configuration>
<groups>
<name>JUNIPER_TEAM</name>
<snmp><location>PVC LAB
Test5</location></snmp>
</groups>
</configuration>
</xmlData>
</change-request>
{
"change-request": {
"name": "TEST_NAME",
"description": "TEST_DESC",
"xmlData":
"<config><loc>TEST_CONF</loc></config>",
"syncAfterPush": "true"
}
}
{
"change-request": {
"device": {
"@href":
"/api/space/device-management/devices/196609",
"id": "196609",
"deviceFamily": "junos-es",
"OSVersion": "10.0R2.10",
"platform": "SRX100-LM",
"serialNumber": "AT5109AF0621",
"connectionStatus": "up",
"ipAddr": "192.168.21.9",
"managedStatus": "In Sync",
"name": "hsc-srx_200",
"hostName": "hsc-srx_200"
},
"name": "TEST",
"description": "testDesc",
"xmlData": "<configuration><groups><name>JUNIPER_TEAM</name><snmp><location>PVC LAB Test5</location></snmp></groups></configuration>"
}
}
Access Control
The following capabilities are required to access this API: ExecuteChangeRequestsCap