Create a key
- In your dashboard, open Settings from your name at the bottom of the left menu.
- Open the Advanced tab.
- Under API Key, choose Create API Key. Your key appears in the box.
- Choose Copy and paste the key where your developer or app needs it.
The Advanced tab only appears on plans that include API access. If you don’t see it, your plan doesn’t include API keys; upgrade to get them.
Using the key
The API reference explains how to send the key with each request and lists everything the API can do. Hand that link to your developer along with the key.
Keep it safe
- Treat the key like a password. Anyone who has it can use the API as your account.
- Don’t put it in a web page or anywhere visitors can see it. Keep it on your server.
- If it gets out, delete it and create a new one (see below).
Delete or replace a key
On the Advanced tab, choose Delete next to the key. It’s deleted straight away, with no “are you sure?”, and anything still using it stops working. Then choose Create API Key to get a new one, and update your apps with it.
Common questions
Which plans include API keys?
API keys come with plans that include API access. If Settings has no Advanced tab, your plan doesn’t include them; see Subscriptions to upgrade.
Can I have more than one API key?
No. The Advanced tab holds one key at a time. To replace the key, delete it and choose Create API Key again.
What happens when I delete my API key?
The key is deleted straight away, with no confirmation, and any app still using it stops working. Create a new key and update your apps with it.
Where is the TeliportMe API documentation?
The API reference lists everything the API can do and explains how to send your key with each request.