CoPilot API Authentication

The CoPilot API authentication allows you to retrieve network metric data across your Aviatrix data plane. The CoPilot API key is used to authenticate service requests for your Aviatrix services.

Enable the CoPilot API Feature

To use the CoPilot API authentication feature, you need to enable it first.

  1. Log in to CoPilot.

  2. Go to CoPilot > Settings > Configuration > License and click Enable next to CoPilot API Access under Add-on Features.

  3. A confirmation window will appear. Click Enable CoPilot API Access to proceed.

  4. Copy the provided API key and save it in a secure place.

  5. Click Download API Specification to download the CoPilot API documentation. Select Metrics API or Status API.

  6. Click Close to exit the window.

Download API Documentation for the CoPilot API Feature

After enabling the CoPilot API authentication feature, you can download the CoPilot API key.

To download the CoPilot API key:

  1. Log in to CoPilot.

  2. Go to CoPilot > Settings > Configuration > General and select an API specification under CoPilot API Key.

  3. Click Download.

You can also reset the API key.