API

Prev Next

Network API credentials enable Discovery to connect to supported cloud-managed and on-premises network platforms through REST APIs and retrieve network infrastructure information.

The Network API page supports the following platforms:

Platform

Authentication Method

Purpose

Cisco Meraki

API key

Connects to the Cisco Meraki cloud API to discover accessible organizations and network resources.

Aruba Central

API key

Connects to the Aruba Central API to discover accessible network resources.

Cisco DNA Center / Catalyst Center

Username and password

Connects to the Cisco DNA Center or Catalyst Center REST API to discover managed network resources.

FortiManager

Username and password

Connects to the FortiManager API to discover managed network resources.

Note

REST API credentials for cloud-managed or on-prem network platforms.

Figure: API

Figure: API

Cisco Meraki Credentials

Use a Cisco Meraki credential profile to connect to the Cisco Meraki cloud API by using an API key. You can optionally specify an organization ID to limit discovery to a particular organization.

Configure a Cisco Meraki Credential Profile

Create a Cisco Meraki credential profile to allow Discovery to connect to the Cisco Meraki cloud API and retrieve accessible network resource information.

Perform the following steps to configure and test a Cisco Meraki credential profile:

  1. Select the API credential category.

  2. Select the Net API tab.

  3. Select New account.

  4. Select the required Department.

  5. Enter a profile name.

  6. Select Cisco Meraki from Platform.

  7. Enter the Cisco Meraki API endpoint in Base API URL. Leave this field blank to use the default Cisco Meraki cloud API URL.

  8. Enter the Cisco Meraki API key in API Key.

  9. To limit discovery to a specific organization, enter the organization identifier in Org ID (optional). Leave this field blank to allow automatic detection.

  10. Select Test Connection to verify the API key and API connectivity.

  11. After a successful connection test, select Save Profile.

Select Cancel to discard the entered information.

Cisco Meraki Credential Fields

Field Name

Description

Department

Select the Department for which you want to create the Cisco Meraki credential profile.

Profile Name

Enter a unique and descriptive name for the credential profile. For example, Production Meraki Organization.

Platform

Select Cisco Meraki.

Base API URL

Enter the Cisco Meraki API base URL. Leave this field blank to use the default Cisco Meraki cloud API URL. Leave blank for Meraki cloud default

API Key

Enter the API key that has permission to access the required Cisco Meraki organization and network resources.

Org ID (optional)

Enter the Cisco Meraki organization ID to limit discovery to a specific organization. Leave this field blank to allow Discovery to identify the accessible organization automatically.

Aruba Central Credentials

Use an Aruba Central credential profile to connect to the Aruba Central API by using an API key. You can optionally specify an organization ID to limit discovery to a particular organization.

Configure an Aruba Central Credential Profile

Create an Aruba Central credential profile to allow Discovery to connect to the Aruba Central API and retrieve accessible network resource information.

Perform the following steps to configure and verify an Aruba Central credential profile:

  1. Select the API credential category.

  2. Select the Net API tab.

  3. Select New account.

  4. Select the required Department.

  5. Enter a profile name.

  6. Select Aruba Central from Platform.

  7. Enter the Aruba Central API endpoint in Base API URL.

  8. Enter the Aruba Central API key in API Key.

  9. To limit discovery to a specific organization, enter the organization identifier in Org ID (optional). Leave this field blank to allow automatic detection.

  10. Select Test Connection to verify the API key and API connectivity.

  11. After a successful connection test, select Save Profile.

Select Cancel to discard the entered information.

Aruba Central Credential Fields

Field Name

Description

Department

Select the Department for which you want to create the Aruba Central credential profile.

Profile Name

Enter a unique and descriptive name for the credential profile. For example, Production Aruba Central.

Platform

Select Aruba Central.

Base API URL

Enter the Aruba Central API base URL configured for the target environment.

API Key

Enter the API key that has permission to access the required Aruba Central resources.

Org ID (optional)

Enter the organization ID to limit discovery to a specific organization. Leave this field blank to allow Discovery to identify the accessible organization automatically.

Cisco DNA Center / Catalyst Center Credentials

Use a Cisco DNA Center / Catalyst Center credential profile to connect to the platform REST API by using a username and password.

Configure a Cisco DNA Center / Catalyst Center Credential Profile

Create a Cisco DNA Center / Catalyst Center credential profile to allow Discovery to connect to the platform REST API and retrieve managed network resource information.

Perform the following steps to configure and verify a Cisco DNA Center / Catalyst Center credential profile:

  1. Select the API credential category.

  2. Select the Net API tab.

  3. Select New account.

  4. Select the required Department.

  5. Enter a profile name.

  6. Select Cisco DNA Center / Catalyst Center from Platform.

  7. Enter the Cisco DNA Center or Catalyst Center API endpoint in Base API URL.

  8. Enter the API username in Username.

  9. Enter the corresponding password in Password.

  10. Select Test Connection to verify the username, password, API endpoint, and connectivity.

  11. After a successful connection test, select Save Profile.

Select Cancel to discard the entered information.

Cisco DNA Center / Catalyst Center Credential Fields

Field Name

Description

Department

Select the Department for which you want to create the Cisco DNA Center / Catalyst Center credential profile.

Profile Name

Enter a unique and descriptive name for the credential profile. For example, Production Catalyst Center.

Platform

Select Cisco DNA Center / Catalyst Center.

Base API URL

Enter the base URL of the Cisco DNA Center or Catalyst Center instance. For example, https://dnac-host/dna.

Username

Enter the username that has permission to connect to the Cisco DNA Center or Catalyst Center API and retrieve network resource information.

Password

Enter the password associated with the username.

FortiManager Credentials

Use a FortiManager credential profile to connect to the FortiManager API by using a username and password.

Configure a FortiManager Credential Profile

Create a FortiManager credential profile to allow Discovery to connect to the FortiManager API and retrieve managed network resource information.

Perform the following steps to configure and verify a FortiManager credential profile:

  1. Select the API credential category.

  2. Select the Net API tab.

  3. Select New account.

  4. Select the required Department.

  5. Enter a profile name.

  6. Select FortiManager from Platform.

  7. Enter the FortiManager API endpoint in Base API URL.

  8. Enter the FortiManager API username in Username.

  9. Enter the corresponding password in Password.

  10. Select Test Connection to verify the username, password, API endpoint, and connectivity.

  11. After a successful connection test, select Save Profile.

Select Cancel to discard the entered information.

FortiManager Credential Fields

Field Name

Description

Department

Select the Department for which you want to create the FortiManager credential profile.

Profile Name

Enter a unique and descriptive name for the credential profile. For example, Production FortiManager.

Platform

Select FortiManager.

Base API URL

Enter the base URL of the FortiManager instance.

Username

Enter the username that has permission to connect to the FortiManager API and retrieve managed network resource information.

Password

Enter the password associated with the username.

Manage Network API Credential Profiles

The credential profile list displays the configured Network API credential profiles for Cisco Meraki, Aruba Central, Cisco DNA Center / Catalyst Center, and FortiManager.

Credential Profile List

Column

Description

Account Name

Displays the name assigned to the Network API credential profile.

Type

Displays API as the credential type.

Username

Displays the username configured for the credential profile. A hyphen (—) displays when the selected platform uses API key authentication.

Active Status

Indicates whether the credential profile is active. Use the toggle to activate or deactivate the profile.

Last Updated

Displays the date and time when a user last updated the credential profile. Select the column heading to sort the profiles by the last updated date and time.

Actions

Provides options to edit the credential profile or view the change history.

Activate or Deactivate a Network API Credential Profile

Use the Active Status toggle to control whether Discovery can use the Network API credential profile.

  • Turn on the toggle to activate the credential profile.

  • Turn off the toggle to deactivate the credential profile.

A deactivated credential profile remains available in the list, but Discovery does not use the profile for later discovery operations.

Edit a Network API Credential Profile

To edit a Network API credential profile:

  1. Select the API credential category.

  2. Select the Net API tab.

  3. Locate the credential profile in the list.

  4. Select the Edit icon under Actions.

  5. Update the required profile details.

  6. Enter or update the API key or password when required.

  7. Select Test Connection to check the updated credentials and API connectivity.

  8. Select Save Profile.

View Network API Credential Profile History

The credential profile history provides a read-only record of changes made to the selected Network API credential profile. The newest changes display first, and secret values remain masked.

To view the credential profile history:

  1. Select the API credential category.

  2. Select the Net API tab.

  3. Locate the credential profile in the list.

  4. Select the History icon under Actions.

  5. Review the available change records.

Change History Fields

Field Name

Description

Field name

Displays the name of the Network API credential profile field added or modified, such as Discovery Credential Name, Department, Used for, or Active.

Old value

Displays the field value before the change. A hyphen (—) displays when no previous value exists. Secret values remain masked.

New value

Displays the field value after the change. Secret values remain masked.

Date changed

Displays the date and time when the change occurred.

Changed by

Displays the identifier of the user who made the change.

The page also displays the number of available change records. End of history indicates that no additional records are available.

Select Close to close the Change history page and return to the Network API credential profile list.

List Page Actions

Action

Description

New account

Opens the form for creating a Network API credential profile.

Active Status

Activates or deactivates the Network API credential profile.

Edit

Opens the selected Network API credential profile for modification.

History

Displays the change history for the selected Network API credential profile.