Creating and managing API keys

An API key authorizes requests to the Data Export API. You create and manage API keys in Account Administration, and you supply the key when you submit requests from the interactive documentation page or from your own applications.

Each request to the Data Export API must include a valid API key in the x-api-key request header. The key authenticates the request to your account (tenant).

To create API keys, you must have Administrator access to Account Administration. In addition, your account must have a paid subscription with a Data Export API usage plan.

Use the procedures in this topic to:

  • Create a new API key.
  • Edit the name, expiration, or description of an existing key.
  • Rotate a key to replace its secret value without changing the key's identity.
  • Remove a key from the system, due to security breach or expiration.
Note: When you create or rotate an API key, there is a brief window before the key is registered and ready to use. Generally, this window is less than one minute.
  • To create a new API key:
    1. In the left pane of Account Administration, click API Keys.
    2. Click Create API Key.
    3. Enter a name and description for this key.
    4. For Expiration date, choose a date up to 367 days in the future.
    5. For Licenses, choose RPI Data Export Usage Plan for API Keys.
    6. Click Next.
      The key is generated and saved.
    7. Click Copy to copy the generated key to your clipboard. Store it securely.
      Important: The full key value is displayed only when the key is created. You cannot access it again. If you lose the value, you must rotate the key to generate a new one.
    1. Click I saved my key to close the dialog.
  • To edit an existing API key:
    1. In the left pane of Account Administration, click API Keys.
    2. Locate the key that you want to change. Right-click the row for the key and select Edit API Key.
    3. Update the name, expiration date or description as needed.
      Editing a key does not change the key value. Applications that already use the key continue to work without changes.
    4. Click OK.
  • To rotate an API key:
    1. In the left pane of Account Administration, click API Keys.
    2. Locate the key that you want to rotate. Right-click the row for the key and select Rotate API Key.
    3. Set the Overlap period in days to the number of days that you want both the existing key and the rotated version to be active at the same time.
    4. Set a new Expiration date for the key.
    5. Click OK.
    6. Click Copy to copy the generated key to your clipboard. Store it securely.
      Important: The full key value is displayed only when the key is created. You cannot access it again. If you lose the value, you must rotate the key to generate a new one.
    7. Update any applications, scripts, or saved interactive documentation sessions that use the key before the overlap period expires.
  • To remove a key from the system:
    1. In the left pane of Account Administration, click API Keys.
    2. Locate the key that you want to rotate. Right-click the row for the key and select Delete Immediately.
    3. In the dialog, select Yes, delete the key.
      This step is required, because deletion is permanent. After you delete the key, you cannot recover it.
    4. Click OK.

You can use the new or updated API key on the interactive documentation page to test the Data Export API, and in any application that submits requests to the API.

Parent topic: Working with the Data Export API – BETA