Skip to main content

Credentials

Provide network device credentials needed for network collection.OpenAPI: YAML | JSON

Device credentials are the usernames, passwords, API keys, etc. that allow the Collector to authenticate to network devices to retrieve the information needed to model them. Define any required device credentials first, then reference them by ID in classic devices.

Note: In the Forward Platform, only a Collector can read and use device passwords. For this reason, credential write operations require the network’s Collector to be online.


Get all CLI credentials
/api/networks/:networkId/cli-credentials
Create a CLI credential
/api/networks/:networkId/cli-credentials
Create CLI credentials
/api/networks/:networkId/cli-credentials
Get a CLI credential
/api/networks/:networkId/cli-credentials/:credentialId
Update a CLI credential
/api/networks/:networkId/cli-credentials/:credentialId
Delete a CLI credential
/api/networks/:networkId/cli-credentials/:credentialId
Get all HTTP credentials
/api/networks/:networkId/http-credentials
Create an HTTP credential
/api/networks/:networkId/http-credentials
Create HTTP credentials
/api/networks/:networkId/http-credentials
Get an HTTP credential
/api/networks/:networkId/http-credentials/:credentialId
Update an HTTP credential
/api/networks/:networkId/http-credentials/:credentialId
Delete an HTTP credential
/api/networks/:networkId/http-credentials/:credentialId