auth.login_with_api_key

Authenticate session using API Key.

Deprecated and removed in v27. Use auth.login_ex with mechanism=”API_KEY_PLAIN” (or mechanism=”SCRAM” for SCRAM-based authentication).

DEPRECATED: this method is scheduled to be removed in v27.

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: api_key

api_key

Type: string

API key for authentication (masked for security).

Return value

Result

Type: boolean

Returns true if API key login was successful, false otherwise.

Required roles: