Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Simple curl example added
Created dateUpdated dateAffects versionFix version

 

 

Management PortalN/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 → API Keys.

...

  1. Copy to clipboard - Copies the selected API key to the clipboard.
  2. Delete - Deletes the API key.
  3. 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.

HeaderRequiredDescription
X-BLANCCO-API-KEYYes

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:

Code Block
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]