REST Resources

/api/space/device-management/devices/{id}

The following operations are supported on this resource:

  • GET - Get device information by ID
  • DELETE - Remove Device by providing ID
GET /devices/{id}Version 1

This API is used to retrieve information for a specified device. It retrieves the name, ID, and other important device attributes.

Sample Usage

GET /devices/{id}


  • Parameters:
    NameTypeURI TypeDescriptionRequired
    device-idIntegerPathThe ID of the device for which information will be retrieved. Y
  • Sample Output XML:
    <device uri="/api/space/device-management/devices/5832730">
      <deviceFamily>junos</deviceFamily>
      <OSVersion>16.1R3.3</OSVersion>
      <platform>EX9208</platform>
      <serialNumber>SIMADScale111</serialNumber>
      <name>AD_Scale11_1</name>
      <hostName>AD_Scale11_1</hostName>
      <id>5832730</id>
      <ipAddr>10.20.175.1</ipAddr>
      <otp>otp</otp>
      <domain-id>2</domain-id>
      <domain-name>Global</domain-name>
      <connection-type>Junos Space initiated</connection-type>
      <attribute-column-0>Device Alias</attribute-column-0>
      <use-nat>false</use-nat>
      <authentication-status>CREDENTIAL_UNVERIFIED</authentication-status>
      <device-id>5832730</device-id>
      <web-mgmt>web-magmt</web-mgmt>
      <lsys-count>0</lsys-count>
      <hosting-deviceId>0</hosting-deviceId>
      <adapter-name>wwjunos</adapter-name>
      <config-status>DEVICE_STATE_SYNC_FAILED</config-status>
      <schema-version>junos_13.2X50-D15.3</schema-version>
      <change-requests uri="/api/space/device-management/devices/5832730/change-requests">
        <change-request href="/api/space/configuration-management/change-requests/9404603" uri="/api/space/device-management/devices/5832730/change-requests/api/space/configuration-management/change-requests/9404603" key="9404603">
          <deviceId>5832730</deviceId>
          <name>no name</name>
        </change-request>
      </change-requests>
      <managed-elements uri="/api/space/device-management/devices/5832730/managed-elements">
        <managed-element href="/api/space/managed-domain/managed-elements/6155764">
          <id>6155764</id>
          <ipAddr>10.20.175.1</ipAddr>
          <deviceId>5832730</deviceId>
        </managed-element>
      </managed-elements>
      <connection-status uri="/api/space/device-management/devices/5832730/connection-status">
        <status>down</status>
      </connection-status>
      <managed-status uri="/api/space/device-management/devices/5832730/managed-status">
        <status>Sync Failed</status>
      </managed-status>
      <configurations href="/api/space/device-management/devices/5832730/configurations" />
      <rpc href="/api/space/device-management/devices/5832730/exec-rpc" />
      <config-files href="/api/space/config-file-management/config-files?filter=(deviceId eq 5832730)" />
      <associated-scripts href="/api/space/device-management/devices/5832730/associated-scripts" />
      <associated-softwares href="/api/space/device-management/devices/5832730/associated-softwares" />
      <activate-modeled-device href="/api/space/device-management/devices/5832730/activate-modeled-device" />
      <clone href="/api/space/device-management/devices/5832730/clone" />
      <modify-device-target-ip href="/api/space/device-management/devices/5832730/modify-device-target-ip" />
      <configlet href="/api/space/device-management/devices/5832730/configlet" />
      <domain href="/api/space/domain-management/domains/2" />
      <apply-cli-configlet href="/api/space/device-management/devices/5832730/apply-cli-configlet" />
      <submit-cli-configlet href="/api/space/device-management/devices/5832730/submit-cli-configlet" />
      <compute-configlet-parameter-values href="/api/space/device-management/devices/5832730/compute-configlet-parameter-values" />
      <applicable-configlets href="/api/space/device-management/devices/5832730/applicable-configlets" />
      <validate-cli-configlet href="/api/space/device-management/devices/5832730/validate-cli-configlet" />
      <customized-attribute-values href="/api/space/device-management/devices/5832730/customized-attribute-values" />
    </device>

  • Sample Output JSON:

    {
      "device": {
        "@uri": "/api/space/device-management/devices/5832730",
        "deviceFamily": "junos",
        "OSVersion": "16.1R3.3",
        "platform": "EX9208",
        "serialNumber": "SIMADScale111",
        "name": "AD_Scale11_1",
        "hostName": "AD_Scale11_1",
        "id": "5832730",
        "ipAddr": "10.20.175.1",
        "otp": "otp",
        "domain-id": "2",
        "domain-name": "Global",
        "connection-type": "Junos Space initiated",
        "attribute-column-0": "Device Alias",
        "use-nat": "false",
        "authentication-status": "CREDENTIAL_UNVERIFIED",
        "device-id": "5832730",
        "web-mgmt": "web-magmt",
        "lsys-count": "0",
        "hosting-deviceId": "0",
        "adapter-name": "wwjunos",
        "config-status": "DEVICE_STATE_SYNC_FAILED",
        "schema-version": "junos_13.2X50-D15.3",
        "change-requests": {
          "@uri": "/api/space/device-management/devices/5832730/change-requests",
          "change-request": [
            {
              "@href": "/api/space/configuration-management/change-requests/9404603",
              "@uri": "/api/space/device-management/devices/5832730/change-requests/api/space/configuration-management/change-requests/9404603",
              "@key": "9404603",
              "deviceId": "5832730",
              "name": "no name"
            }
          ]
        },
        "managed-elements": {
          "@uri": "/api/space/device-management/devices/5832730/managed-elements",
          "managed-element": [
            {
              "@href": "/api/space/managed-domain/managed-elements/6155764",
              "id": "6155764",
              "ipAddr": "10.20.175.1",
              "deviceId": "5832730"
            }
          ]
        },
        "connection-status": {
          "@uri": "/api/space/device-management/devices/5832730/connection-status",
          "status": "down"
        },
        "managed-status": {
          "@uri": "/api/space/device-management/devices/5832730/managed-status",
          "status": "Sync Failed"
        },
        "configurations": {
          "@href": "/api/space/device-management/devices/5832730/configurations"
        },
        "rpc": {
          "@href": "/api/space/device-management/devices/5832730/exec-rpc"
        },
        "config-files": {
          "@href": "/api/space/config-file-management/config-files?filter=(deviceId eq 5832730)"
        },
        "associated-scripts": {
          "@href": "/api/space/device-management/devices/5832730/associated-scripts"
        },
        "associated-softwares": {
          "@href": "/api/space/device-management/devices/5832730/associated-softwares"
        },
        "activate-modeled-device": {
          "@href": "/api/space/device-management/devices/5832730/activate-modeled-device"
        },
        "clone": {
          "@href": "/api/space/device-management/devices/5832730/clone"
        },
        "modify-device-target-ip": {
          "@href": "/api/space/device-management/devices/5832730/modify-device-target-ip"
        },
        "configlet": {
          "@href": "/api/space/device-management/devices/5832730/configlet"
        },
        "domain": {
          "@href": "/api/space/domain-management/domains/2"
        },
        "apply-cli-configlet": {
          "@href": "/api/space/device-management/devices/5832730/apply-cli-configlet"
        },
        "submit-cli-configlet": {
          "@href": "/api/space/device-management/devices/5832730/submit-cli-configlet"
        },
        "compute-configlet-parameter-values": {
          "@href": "/api/space/device-management/devices/5832730/compute-configlet-parameter-values"
        },
        "applicable-configlets": {
          "@href": "/api/space/device-management/devices/5832730/applicable-configlets"
        },
        "validate-cli-configlet": {
          "@href": "/api/space/device-management/devices/5832730/validate-cli-configlet"
        },
        "customized-attribute-values": {
          "@href": "/api/space/device-management/devices/5832730/customized-attribute-values"
        }
      }
    }

  • Access Control

    The following capabilities are required to access this API: ReadDevices

    DELETE /devices/{id}Version 1

    This API is used to delete a device from the database.

    Sample Usage

    This API makes an asynchronous method call; so, you can optionally specify queue and schedule parameters:

    DELETE /devices/{id}?queue=<queue>&schedule=<schedule>


    Note: The queue URL denoted by <queue> must have been created already.


    • Parameters:
      NameTypeURI TypeDescriptionRequired
      device-idIntegerPathThe ID of the device to be removed from the database. Y
      queueQueue URLQueryA fully qualified queue URL, where job progress notifications will be sent (See Asynchronous API Usage)N
      schedulecron-like-expressionQuerySchedule this API in the future, by specifying a cron-like-expression (See Job Scheduling)N

    Access Control

    The following capabilities are required to access this API: DeleteDevice