Managing Credentials

Learn how to search, view, add, edit, and delete the API credentials that connect your applications to the Convey platform.

Overview

The Credentials page (under Security > Credentials in the left-hand menu) is where you manage the API credentials that authenticate your applications with Convey. Each credential is tied to a connection and consists of an API Key, API Secret, System ID, and Password. From this single page you can search across every credential in your account — including sub-accounts — then add, view, edit, or delete credentials as your integrations evolve. Use this guide to find an existing credential, create a new one, update or rotate credentials, and safely remove credentials you no longer need.

Important Note

Your API credentials are the keys to your account — anyone who has your API Key and API Secret can send messages on your behalf. Treat them like passwords and never share them in emails, tickets, or screenshots. Be careful with the Reset Credentials option and the Delete icon: both take effect as soon as you confirm, and any integration still using the old values will stop working immediately.

What You'll Need

Before you begin, please make sure you have:

Access to your Convey dashboard with an active login.
Permission to open the Security menu (if you don't see it, ask your account administrator).
To add a credential: the Connection it will belong to (connections are configured under Configuration > Connections).
To update an existing credential: its Credential Name, Credential ID, Credential GUID, or API Key so you can find it quickly.

Step-by-Step Guide

All credential management starts from the same place: log in to Aerialink v5 and select Credentials under the Security menu in the left-hand navigation.

The Search Credentials page (Security > Credentials)

1. Search for a credential

Use the filters at the top of the page to narrow the list, then click Search. Click Reset at any time to clear the filters and start over. You can filter by:

Account & Connection: Limit results to a specific account or connection. Sub-accounts are included automatically — tick Exclude Sub-accounts to see only the selected account.
Credential details: Search by Credential Name, Credential ID, Credential GUID, API Key, or System ID.
Status: Show all credentials, or only active or inactive ones.
Sort By & Output: Choose the sort order (for example, Last Updated Descending) and whether results appear on screen.

The Search Results table lists each matching credential with its Credential ID, GUID, Name, Account ID, Connection ID, API Key, System ID, Active status, and Last Updated timestamp. The three icons at the end of each row let you Edit, View, or Delete the credential.

2. Add a new credential

Open the form: Click the + (Add New Credential) icon at the top right of the Search Results panel.
Choose the connection: Select the Connection this credential will authenticate against (required).
Name it: Enter a clear, descriptive Name (required) so you can recognize it later in Search Results.
Note the generated values: Review the Api Key, Api Secret, System ID, and Password, and store them somewhere secure — your application will need them to authenticate.
Set the options: Leave Credential is Active ticked, and tick Enable for use with Firewall(s) only if this credential must work through your configured firewalls.
Save: Click the dark-green button at the bottom right of the form to save the new credential.

Click the + icon to add a new credential

3. View a credential

Click the eye (View) icon at the end of the credential's row to open a read-only summary. Use this when you need to check or copy the API Key or System ID without changing anything.

The View icon opens a read-only summary

4. Edit a credential

Click the pencil (Edit) icon at the end of the credential's row to open the Manage Credentials page.

The top of the page shows the credential's read-only identifiers — Credential GUID, Credential ID, and the Created and Updated timestamps. Below them you can change the following:

Field	What it does
Credential is Active	Untick to temporarily disable the credential without deleting it.
Connection *	The connection this credential authenticates against.
Name *	The label shown in Search Results — make it descriptive.
Api Key / Api Secret	The key pair your application uses to authenticate API requests.
System ID	The system identifier used alongside the API key.
Password	The credential password. Click the eye icon inside the field to show or hide it.
Reset Credentials	Tick to generate a new Api Key, Api Secret, System ID, and Password when you save. The old values stop working immediately.
Enable for use with Firewall(s)	Allows the credential to be used with the firewalls configured under Security > Firewalls.

Click Update Credential to save your changes, or Cancel to discard them. Fields marked with * are required.

5. Delete a credential

Click the trash can (Delete) icon at the end of the credential's row and confirm. Deleting a credential cannot be undone, and any application still using it will immediately lose access. If you're not sure whether a credential is still in use, edit it and untick Credential is Active instead — you can always reactivate it later.

Having Trouble?

If you encounter any issues along the way, refer to this quick troubleshooting guide.

What you're seeing	Why it happens	How to resolve it
A credential isn't appearing in Search Results	A filter such as Account, Status, or Exclude Sub-accounts is narrowing the list.	Click Reset, set Status to All, then click Search again.
Your API requests are rejected with authentication errors	The credential is inactive, or its key and secret were regenerated.	Open the credential in Edit mode, tick Credential is Active, and confirm your application uses the current Api Key, Api Secret, System ID, and Password.
You don't see the Security menu or the action icons	Your user profile doesn't have credential-management permissions.	Reach out to your account administrator to request access.
An integration broke right after you saved changes	Reset Credentials was ticked, which regenerated the key, secret, system ID, and password.	Copy the new values from the Manage Credentials page into your application, then restart or redeploy it.

Tips for Success

To get the most out of this feature, keep the following tips in mind:

Common Pitfalls

× Ticking Reset Credentials without a plan to update every integration — the old Api Key, Api Secret, System ID, and Password stop working the moment you save.
× Deleting a credential that may still be in use. When in doubt, untick Credential is Active instead so you can reactivate it later.
× Sharing your API Key, API Secret, or password in tickets, chats, or screenshots.

Best Practices

✓ Give every credential a clear, descriptive name (for example, the environment plus the application) so it's easy to find in Search Results.
✓ After saving changes, confirm the new Last Updated timestamp in the Search Results table.
✓ Store credentials in a secure secrets manager and rotate them regularly using Reset Credentials.
✓ Only tick Enable for use with Firewall(s) for credentials that must authenticate through your configured firewalls (Security > Firewalls).

Frequently Asked Questions

Q: What does Reset Credentials do?

A: It generates a brand-new Api Key, Api Secret, System ID, and Password when you click Update Credential. The old values stop working immediately, so use it to rotate credentials on a schedule or after a suspected compromise — and update every integration that uses them straight away.

Q: Why do I see credentials from other accounts in my results?

A: Searches include sub-accounts by default. Tick Exclude Sub-accounts above the results and click Search to limit the list to the selected account only.

Q: Can I restore a deleted credential?

A: No — deletion is permanent. Add a new credential with the + icon and update your integration with the new values.

Need More Help?

If you've followed the steps above and are still having trouble, our support team is ready to assist you.

Contact Support Submit a ticket to our team for personalized help.

Related to