API
IXP Manager has a number of API endpoints which are documented in the appropriate places throughout the documentation.
Please find details below about authenticating for API access to secured functions.
Creating an API Key
When logged into IXP Manager, create an API as follows:
- Select My Account on the right hand side of the top menu.
- Select API Keys from the My Account menu.
- Click the plus / addition icon on the top right of the resultant API Keys page.
Treat your API key as a password and do not copy the below URLs into public websites and other public forums.
API Authentication
There are two ways to use your API key to authenticate to IXP Manager.
You can test these using the API test endpoint at api/v4/test. For example:
https://ixp.example.com/api/v4/test
The plaintext response will also indicate if you are authenticated or not (which can be via existing session or API key).
1. HTTP Header Parameter
You can pass your API key in the HTTP request as a request header parameter called X-IXP-Manager-API-Key. For example:
curl -X GET -H "X-IXP-Manager-API-Key: my-api-key" https://ixp.example.com/api/v4/test
2. As a URL Parameter
This is a legacy method that is still supported. You can tack your key on as follows:
https://ixp.example.com/api/v4/test?apikey=my-api-key
API Key Management
In IXP Manager v5.1 we introduced some new API Key management features:
- You can now add an optional description to an API key. This allows you to record where the key is used for example.
- You can set an optional expiry date for the key. The key may be used up to that date but not on the date. The expiry date can be added / edited /removed when editing an API key.
- Expired API keys are automatically deleted after one week (via the scheduler).
API keys are not shown by default but require a password to be entered to show them. If you wish to show the keys (inadvisable), you can set IXP_FE_API_KEYS_SHOW=true in .env. This is only available to mimic historic functionality and will be removed in the future.
By default, a user can create no more than 10 keys. If you wish to change this, set IXP_FE_API_KEYS_MAX=n in .env where n is an integer value > 0.