Skip to main content

Network Endpoints

Configure network endpoint profiles and specify the network endpoints to collect from.OpenAPI: YAML | JSON

A network endpoint is a device that connects to a network, usually at the network’s edge, such as a printer, IP phone, server, IoT device, etc. The Forward Platform allows users to specify custom collection instructions for each type of endpoint in a reusable endpoint profile. Endpoint collection can be performed via CLI (Telnet or SSH), HTTP(S), or SNMP.

A network endpoint can include a profileId, a jump server ID if one is needed to reach the device, credential IDs for authentication, and some other settings for fine-tuning the collection process.


Get all endpoint profiles
/api/endpoint-profiles
Add a CLI endpoint profile
/api/endpoint-profiles?type=CLI
Add an HTTP endpoint profile
/api/endpoint-profiles?type=HTTP
Add an SNMP endpoint profile
/api/endpoint-profiles?type=SNMP
Get an endpoint profile
/api/endpoint-profiles/:profileId
Update a CLI endpoint profile
/api/endpoint-profiles/CLI-:profileId
Update an HTTP endpoint profile
/api/endpoint-profiles/HTTP-:profileId
Update an SNMP endpoint profile
/api/endpoint-profiles/SNMP-:profileId
Delete an endpoint profile
/api/endpoint-profiles/:profileId
Get a network’s endpoints
/api/networks/:networkId/endpoints
Add a CLI network endpoint
/api/networks/:networkId/endpoints?type=CLI
Add an HTTP network endpoint
/api/networks/:networkId/endpoints?type=HTTP
Add an SNMP network endpoint
/api/networks/:networkId/endpoints?type=SNMP
Add CLI network endpoints
/api/networks/:networkId/endpoints?action=addBatch&type=CLI
Add HTTP network endpoints
/api/networks/:networkId/endpoints?action=addBatch&type=HTTP
Add SNMP network endpoints
/api/networks/:networkId/endpoints?action=addBatch&type=SNMP
Delete specific network endpoints
/api/networks/:networkId/endpoints?action=deleteBatch
Update specific network endpoints
/api/networks/:networkId/endpoints
Get a network endpoint
/api/networks/:networkId/endpoints/:endpointName
Update a CLI network endpoint
/api/networks/:networkId/endpoints/:endpointName?type=CLI
Update an HTTP network endpoint
/api/networks/:networkId/endpoints/:endpointName?type=HTTP
Update an SNMP network endpoint
/api/networks/:networkId/endpoints/:endpointName?type=SNMP
Delete a network endpoint
/api/networks/:networkId/endpoints/:endpointName