Example of Accessing the API with cURL

The following example shows how to get current change management status by submitting a GET request on the REST resource using cURL. If the request requires a timestamp, use the timestamp from the response of the /login API. For more information about cURL, see Use cURL.

curl -X GET \
    -b cookies.txt \
    "https://$IPADDR/restapi/change_management/get_status"

Example of the Response Headers

The following shows an example of the response headers.

HTTP/1.1 200 OK
Date: Tue, 15 Dec 2020 18:17:11 GMT
Server: Apache/2.4.6 () OpenSSL/1.0.2k-fips mod_fcgid/2.3.9 PHP/5.4.40
Vary: Accept-Encoding
X-UA-Compatible: IE=Edge,chrome=1
Transfer-Encoding: chunked
Content-Type: application/json; charset=ISO-8859-1

Example of the Response Body

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

{
  "status": "success",
  "state": "network_staging",
  "state_int": 0,
  "data": {
      "inbox_files": [],
      "contents": [{
          "observed_sw_revision": null,
          "staged_sw_revision": "",
          "staged_config": "",
          "active_software": "R7_3_GA_P12_11282019",
          "file_name": "Talari_APNWare_E1000_install_R7_3_QA_BUGFIX_P12_11262019-6-g56fa474.tar.gz",
          "file_transfer_total_size_bytes": null,
          "actual_interruption_time_ms": "",
          "observed_staging_sw_revision": null,
          "file_transfer_received_byte_count": null,
          "appliance_id": "0",
          "staged_site_name": "Client-1",
          "active_total_size_bytes": null,
          "active_transfer_finished_reason": null,
          "hw_model": "E1000",
          "staged_hw_model": "E1000",
          "staged_appliance_name": "Client-1",
          "active_file_transfer_received_byte_count": null,
          "base_registry_name": "Client-1_1575393728.ncn",
          "active_config": "",
          "observed_staging_registry_timestamp": null,
          "active_package_file_name": "Client-1+0/talari_E1000.zip",
          "config_staged": "test-wan-gre-r73.cfg",
          "orig_staged_sw_revision": "R7_3_QA_BUGFIX_P12_11262019-6-g56fa474",
          "status_val": "Done",
          "active_transfer_state": null,
          "is_ha": "0",
          "transfer_finished_reason": "0",
          "appliance_name": "Client-1",
          "staged_package_file_name": "Client-1+0/talari_E1000.zip",
          "staged_registry_timestamp": "1575393728",
          "config_active": "test-wan-gre-r73_Updated_alu.cfg",
          "last_observation_time_s": null,
          "is_ncn": "1",
          "observed_registry_timestamp": null,
          "site_name": "Client-1",
          "transfer_state": "2",
          "expected_interruption": "Loc Chg Mgt",
          "staged_appliance_id": "0",
          "expected_sw_revision": "R7_3_GA_P12_11282019",
          "expected_registry_timestamp": "1577701091"
      }, {
          "observed_sw_revision": null,
          "staged_sw_revision": "",
          "staged_config": "",
          "active_software": "R7_3_GA_P12_11282019",
          "file_name": "Talari_APNWare_T860_install_R7_3_QA_BUGFIX_P12_11262019-6-g56fa474.tar.gz",
          "file_transfer_total_size_bytes": null,
          "actual_interruption_time_ms": "",
          "observed_staging_sw_revision": null,
          "file_transfer_received_byte_count": null,
          "appliance_id": "0",
          "staged_site_name": "GEO-Site",
          "active_total_size_bytes": null,
          "active_transfer_finished_reason": null,
          "hw_model": "T860",
          "staged_hw_model": "T860",
          "staged_appliance_name": "GEO-Site",
          "active_file_transfer_received_byte_count": null,
          "base_registry_name": "GEO-Site_1575393728.client",
          "active_config": "",
          "observed_staging_registry_timestamp": null,
          "active_package_file_name": "GEO-Site+0/talari_T860.zip",
          "config_staged": "test-wan-gre-r73.cfg",
          "orig_staged_sw_revision": "R7_3_QA_BUGFIX_P12_11262019-6-g56fa474",
          "status_val": "",
          "active_transfer_state": null,
          "is_ha": "0",
          "transfer_finished_reason": null,
          "appliance_name": "GEO-Site",
          "staged_package_file_name": "GEO-Site+0/talari_T860.zip",
          "staged_registry_timestamp": "1575393728",
          "config_active": "test-wan-gre-r73_Updated_alu.cfg",
          "last_observation_time_s": null,
          "is_ncn": "0",
          "observed_registry_timestamp": null,
          "site_name": "GEO-Site",
          "transfer_state": null,
          "expected_interruption": "Loc Chg Mgt",
          "staged_appliance_id": "0",
          "expected_sw_revision": "R7_3_GA_P12_11282019",
          "expected_registry_timestamp": "1577701091"
      }, {
          "observed_sw_revision": null,
          "staged_sw_revision": "",
          "staged_config": "",
          "active_software": "R7_3_GA_P12_11282019",
          "file_name": "Talari_APNWare_E100_install_R7_3_QA_BUGFIX_P12_11262019-6-g56fa474.tar.gz",
          "file_transfer_total_size_bytes": null,
          "actual_interruption_time_ms": "",
          "observed_staging_sw_revision": null,
          "file_transfer_received_byte_count": null,
          "appliance_id": "0",
          "staged_site_name": "NCN-Primary",
          "active_total_size_bytes": null,
          "active_transfer_finished_reason": null,
          "hw_model": "E100",
          "staged_hw_model": "E100",
          "staged_appliance_name": "NCN-Primary",
          "active_file_transfer_received_byte_count": null,
          "base_registry_name": "NCN-Primary_1575393728.client",
          "active_config": "",
          "observed_staging_registry_timestamp": null,
          "active_package_file_name": "NCN-Primary+0/talari_E100.zip",
          "config_staged": "test-wan-gre-r73.cfg",
          "orig_staged_sw_revision": "R7_3_QA_BUGFIX_P12_11100  4451    0  4451    0     0   2399      0 --:--:--  0:00:01 --:--:--  2399nsfer_state",
          "is_ha": "0",
          "transfer_finished_reason": null,
          "appliance_name": "NCN-Primary",
          "staged_package_file_name": "NCN-Primary+0/talari_E100.zip",
          "staged_registry_timestamp": "1575393728",
          "config_active": "test-wan-gre-r73_Updated_alu.cfg",
          "last_observation_time_s": null,
          "is_ncn": "0",
          "observed_registry_timestamp": null,
          "site_name": "NCN-Primary",
          "transfer_state": null,
          "expected_interruption": "Loc Chg Mgt",
          "staged_appliance_id": "0",
          "expected_sw_revision": "R7_3_GA_P12_11282019",
          "expected_registry_timestamp": "1577701091"
      }],
      "network_staged_configs": {
          "selected_filename": "",
          "filenames": []
      },
      "network_staged_software": []
  }
}