In this article we will explain API keys and how to use them with both API v2 and API v1. See Telnyx guidance and requirements.
To use Telnyx v2 API endpoints, you will need an API key. For our API v1 endpoints, you will need an API Token.
This article will explain how to get your API Key for API v2 or API Token for API v1.
Telnyx uses API Keys or Tokens to authenticate API requests from our customers.
Step by Step guide API v2 Key
- Log in to https://portal.telnyx.com/
- Click on the Account Settings option in the Account Icon on the top-right corner.
- Then click API Keys.
Click Create API Key on the top right hand corner to create an API v2 Key.
This key is what you will use as the bearer token in your API requests.
-
You will then be provided with your API v2 Key to copy.
- NOTE: The API Key will only be visible at the time of creation, so ensure it is securely stored in your application's environment variables.
- If you lose it, you can always go back to this section again to get it or create a new one.
- You have the option to set an Expiration date for your key, or temporarily disable any given API Key by just toggling the option.
- You can also associate up to 10 tags per API Key.
Coming soon:
- Adding search by tag functionality in the Mission Control Portal
- Adding developer documentation to access managed API Keys through an API endpoint.
Step by Step guide API v1 Token
- Log in to https://portal.telnyx.com/
- Click on the Account Settings dropdown section on the left-hand side.
- Then click API Keys.
- Inside this page, click the "API V1 Tokens" button on the top right-hand side.
- Click Create API Token.
-
We will ask you to give it a name, you can name it whatever you want.
-
You will see a section on the right-hand side where you can click Copy Token.
-
If you lose it you can always go back to this section again to get it or create a new one.
- NOTE: The API Token will only be visible at the time of creation, so ensure it is securely stored in your application's environment variables.
In your API request, please include two headers called:
- x-api-user:
- x-api-token: when making the API V1 request.
You can find more details on API v1 Tokens in our developer's docs here and our API v2 Key here
