| Created date | Updated date | Affects version | Fix version |
|---|---|---|---|
|
| Management Portal | N/A |
In order to authenticate against Blancco Management Portal API endpoints an API Key is required. API Keys are managed through the Management Portal by navigating to "Support"-tab and then to "API Keys".
All API Keys
This page lists all the created API keys within your tenant with additional details such as the creation date of the API key and the owner of the key.
My API Keys
This page lists your own API keys and allows you to create new API keys as well as manage the existing ones.
Creating new API keys
To create a new API key select "Generate API key" and provide the name and the description for the key to create it. Note that name and description provided are visible for the rest of the users within your tenant if they navigate to "All API Keys" page.
After generating the key a confirmation dialog will be presented allowing you to copy the created API key. The key can be copied also later on from the "My API Keys" page.
Managing existing API keys
Once you have more than one API key created you can view and manage existing API keys from the "My API Keys" tab.
To manage a key, click the settings icon (three dots) next to the name of the key and options to manage the are shown.
The icon from left to right are:
- Copy to clipboard - Copies the selected API key to the clipboard.
- Delete - Deletes the API key.
- Edit - Edit the description and name of the selected key.
Using API key to authenticate requests
In order to authenticate API requests using your API key it needs to be provided as part of the headers of the request.
| Header | Required | Description |
|---|---|---|
| X-BLANCCO-API-KEY | Yes | The content of the header should be the API key. Not, for example, its name. It could look something like this: "8574e755-1f80-4af4-b7ae-a8187afb3909". However, the structure can change at any time. The only guarantee is that all API keys have a unique value. |
A below example shows how to include this as a part of simple curl request. Replace {UUID} with a valid report UUID and {API_KEY} with the key string of your API key:
curl -X "GET" \
"https://api.eu-west-1.blancco.cloud/v1/report/export/{UUID}" \
-H "accept: */*" \
-H "X-BLANCCO-API-KEY: {API_KEY}"
More details on the available API endpoints and how to use them can be found from here: [LINK]