Using an API Key
- Mojib Javadi
- Jonathan Gane
An Application Programming Interface (API) Key is a code used to identify and authenticate a user on the Portal. Once activated by a Platform Admin, users can generate an API Key and use it in the Pilot Command Line Interface to carry out automated or scripted data operations without the need to manually enter a username and password. Generated API keys are valid for one year and can be revoked or regenerated at any time.
Please secure your API Key as you would your username and password.
Generating an API Key
Login and navigate to your Account by clicking your username in the top right corner of the Portal
Find the API Key card and click Generate.
Your API Key will appear. Copy your API Key and store it in a secure location. If you return to this page, the API Key will be hidden and you won't be able to copy it again.
Note the expiry date on which your API Key will automatically invalidate. Generated API keys are valid for one year. You can revoke and regenerate your API Key any time.
Revoking or Regenerating your API Key
Login and navigate to your Account by clicking your username in the top right corner of the Portal
Find the API Key card and click Revoke > Confirm, to delete the API Key and invalidate it, or Regenerate, to delete the API Key and generate another valid one.
For instructions on how to establish an API login session using the Pilot Command Line Interface, please see: User Commands - pilotcli user | Command: login.