API Key Management

You can create and manage multiple API keys for your organization from the Keys & Secrets page in the Datastreamer Portal.

API keys authenticate requests to Datastreamer endpoints. Use separate keys for different services, environments, or integrations so that you can manage them independently.

API key limits and requirements

• You can create up to 10 API keys per organization.
• Each API key requires a name.
• You can optionally add a description.

Create an API key

1. Log in to the Datastreamer Portal.
2. Go to Keys & Secrets in the left sidebar.
3. In the API Keys section, select Create API Key.
4. Enter a descriptive Name for the key.
5. Optionally enter a Description, such as Used for CI/CD pipelines.
6. Select Create.
7. Use the copy button beside the new key to copy it to a secure location.

Use a descriptive name that identifies the key's purpose, environment, or service. For example, Production ingestion or Development CI/CD.

Use an API key

Send the API key in the apikey header when authenticating requests to Datastreamer API endpoints:

curl -H "apikey: YOUR_API_KEY" \
  https://api.platform.datastreamer.io/api/users/keys/rotate

Treat API keys as passwords. Store them in a secrets manager or an equivalent secure configuration system. Do not commit them to source control or include them in client-side applications.

View and copy an API key

The API Keys table lists each key by its name, description, masked value, and status. Select the copy button beside a key to copy its value to the clipboard.

Block or unblock an API key

Blocking temporarily disables an API key without deleting it. A blocked key cannot authenticate requests until it is unblocked.

To block or unblock a key:

1. Find the key in the API Keys table.
2. Turn the Block Key switch on or off.

The last active and unblocked key cannot be blocked.

Rotate an API key

Rotating a key immediately invalidates the selected key and generates a replacement. Any service using the selected key will stop working, so update the service configuration with the replacement key immediately.

To rotate a key:

1. Find the key in the API Keys table.
2. Select Rotate.
3. Review the warning in the confirmation dialog.
4. Select Rotate to confirm, or Cancel to keep the current key.

Rotation affects only the selected key. Other API keys in the organization remain unchanged.

Delete an API key

Deleting a key permanently removes it and cannot be undone.

1. Find the key in the API Keys table.
2. Select the delete icon.
3. Confirm the key name, then select Delete.

Because of caching, a deleted key may remain valid for a couple of minutes. Remove the key from services and secret stores as soon as it is deleted.

The last active and unblocked key cannot be deleted. Create or unblock another key before deleting it.

Recommended key-management practices

• Create separate keys for production, development, CI/CD, and individual services.
• Use descriptive names and descriptions so that each key can be identified quickly.
• Rotate keys when a service, environment, or team member changes.
• Block a key immediately if you suspect it has been exposed.
• Delete keys that are no longer needed.