Administrator Connectors API
- Last Updated: April 9, 2024
- 1 minute read
- Hybrid Data Pipeline
- Version 5.0
- Documentation
Administrators may use the Administrator Connectors API to retrieve information about the
On-Premises Connectors that are registered with the Hybrid Data Pipeline server. The
Administrator Connectors API also allows administrators to filter API responses by
appending query parameters to requests. Filtering responses enables administrators to
retrieve information about connectors that share specific details or attributes. A user
must have the Administrator (12) permission to use the Administrator Connectors
API.
Note: The Administrator Connectors API is distinct from
the Connector API. The Connector API is used to manage access to on-premises backend
data. See Connector
API for details.
You can perform the following operations with the Administrator Connectors API.
| Operation | Request | URL |
|---|---|---|
| Retrieve a list of registered On-Premises Connectors | GET | https://<myserver>:<port>/api/admin/connectors |
| Retrieve information about an On-Premises Connector | GET | https://<myserver>:<port>/api/admin/connector/{connectorId} |