Generate and use an API key

When third-party applications need to interact with CAST Imaging (or you need to migrate from V2) you can generate an API key to access the required resources securely. Traditional user/password credentials are deemed a security risk and can also expire, causing recurring problems when the resources are used for automation purposes. An API key solves these issues and CAST recommends using one wherever possible.

Note that:

• An API key is generated on a per-user basis
• Only one key can exist for each user
• When a new key is generated, the old one instantly becomes invalid
• The Edit your name and email section must be populated before the Generate button becomes active

To use the key, add an X-API-KEY attribute in the request header containing your API key. For example, when using curl:

curl -H "X-API-KEY: 06935MrA.G7LStH3Ck9sgeHBYokzIjTdv2DTbicsT" http://imaging.corp.domain.com/rest