API Key

Overview

An API Key allows programmatic access to Datascaphe Uplink without going through the standard user authentication flow. API Keys are scoped to a role, which defines the set of operations they are permitted to perform.

API Keys are typically used for server-to-server integrations, automated workflows, or external tools that need to interact with the Uplink API.

API Key fields

Field	Criticality	Description
Description	Optional	A descriptive label to identify the purpose or owner of this API key.
Key	Auto-generated	The API key string (up to 64 characters). Generated automatically on creation. Used as the bearer credential in API requests.
Role	Required	The role assigned to this API key. Determines which API endpoints and operations are accessible.
Status	Required	Default: active. Whether the key is currently usable. Set to inactive to revoke access without deleting the key.