External Interactions¶

This document describes external dependencies and prerequisites for this App to operate, including system requirements, API endpoints, interconnection or integrations to other applications or services, and similar topics.

There are various integrations that you may want to incorporate into the Device Lifecycle plug-in. This page will rpvide references to officially supported external integrations. This is not meant to limit what is supported, but rather is meant as a place to go for integration needs for external systems (such as NIST for example...).

External System Integrations¶

From the App to Other Systems¶

From Other Systems to the App¶

Nautobot REST API endpoints¶

Hardware Lifecycle Management API Examples¶

REST API Example 1¶

Gather hardware notices that will be end of support by the end of 2021

curl "http://$NBHOST/api/plugins/device-lifecycle/hardware/?end_of_support__lte=2021-12-31" \
-X GET \
-H  "accept: application/json" \
-H  "Authorization: Token $TOKEN" | json_pp

REST API Example 2¶

Gather hardware notices that are currently expired.

Note

The expired flag will honor end_of_support if the field exist for the record. If the field does not exist, end_of_sale will be used as the expired field.

curl "http://$NBHOST/api/plugins/device-lifecycle/hardware/?expired=true" \
-X GET \
-H  "accept: application/json" \
-H  "Authorization: Token $TOKEN" | json_pp