Skip to main content

API keys

API key authentication is an alternative method for securing access to nullplatform. This authentication method is particularly useful for programmatic access and automation scenarios. Users can obtain an API key to authenticate and interact with nullplatform programmatically.

Creating API keys

You need an OPS role to create an API key

Click here to see the API documentation on API key creation

Whenever working with API keys bear in mind:

  • the API key is a secret, ensure that you handle the API key with care to prevent unauthorized access
  • there's an underlying user associated with each API key so any action will be subject to and audited with the same rules that apply to any user

Once you have obtained the API key, use it as specified in the API documentation.

Granting access to API keys

You can assign roles to API keys the same way you do with users, please refer to this section for further details.