Using an API Key

An API Key can be used to query the Platform REST APIs, and needs to be sent through query parameters or headers.

Example:

For example, available tasks can be listed using the API Key in query parameters:

GET /api/scenario/application?api-key=36e2326d-a3f5-4a1c-80cd-9c5e61111f5d

Or in the HTTP request headers:

GET /api/scenario/application
X-Api-Key: 36e2326d-a3f5-4a1c-80cd-9c5e61111f5d