Manage Your API Key

Your API key provides the credentials needed to authenticate clients to your account.

When you generate your API key, copy it directly from the Hazelcast Viridian Cloud console.

Create an API Key

You can create only one API key and secret pair on your account. If you need to change your API credentials, you must first remove your existing credentials, and then create new credentials.

To create a set of API credentials, do the following:

  1. Sign into the Viridian Cloud console

  2. Select Account from the side navigation bar

  3. Select Developer from the Account options

    The Developer screen displays.

  4. Select the Generate New API Key button

Use these credentials in your applications to manage all clusters in your account.

After creating your credentials, ensure that you applications are correctly configured to use the API credentials.

Keep your keys and secrets secure. Anyone who has these credentials has full access to your clusters.

Copy API Key

To copy your API key, do the following:

  1. Sign into the Viridian Cloud console

  2. Select Account from the side navigation bar

  3. Select Developer from the Account options

    The Developer screen displays.

  4. Select the Copy (overlapping squares) button

    Copy it now and store it somewhere safe, as the secret is not shown again after you leave this screen. Next time this screen displays, you can view only the API key.

The API key is copied to your clipboard. You can now paste the API key into your application configuration.

Delete an API Key

If you delete your API key, any application using the key will not work unless you update the configuration with a new set of credentials.

To create a set of API credentials, do the following:

  1. Sign into the Viridian Cloud console

  2. Select Account from the side navigation bar

  3. Select Developer from the Account options

    The Developer screen displays.

  4. Select the Delete API Key button

    A confirmation dialog box displays.

  5. Select the OK button to delete your API key. Selecting the Cancel button returns you to the Developer screen without deleting your API key

If you want to continue using your applications with Hazelcast Viridian Cloud, you must create an API key again and ensure that your applications are correctly configured to use the updated API credentials.