Nodes API
- Last Updated: February 27, 2024
- 1 minute read
- Hybrid Data Pipeline
- Version 5.0
- Documentation
Hybrid Data Pipeline generates system logs to record information about deployment, runtime operations, and on-premises connections (see System logs for details). The Nodes API allows you to retrieve system logs. Since these logs are associated with specific nodes, you must first retrieve a list of nodes in the Hybrid Data Pipeline deployment. After retrieving the list of nodes, you may then make requests to obtain system logs for a node. You may also request system logs for a specific date range. You must make a separate request to obtain the logs for each node. A user must have the Administrator (12) permission to obtain system logs.
| Operation | Request | URL |
|---|---|---|
| Returns a list of available nodes | GET | https://<myserver>:<port>/api/admin/system/nodes |
| Returns system logs for a node | GET | https://<myserver>:<port>/api/admin/system/nodes/{id}/logs |
| Returns the system logs for a node for a specific data range | GET | https://<myserver>:<port>/api/admin/system/nodes/{id}/logs?start_date=<yyyy-mm-dd>&end_date=<yyyy-mm-dd> |