Regenerate your API key

POST https://your-org.veloxatalk.com/api/v1/users/me/api_key/regenerate

Note: Users should treat their Veloxa Talk API key as carefully as they would their password.

Generate a new API key for the user making the request.

Changing a user's API key will immediately log them out of Veloxa Talk on devices registered for mobile push notifications.

Changes: Before Veloxa Talk 12.0 (feature level 492), regenerating a user's API key didn't remove all of the user's E2EE push device registrations, so E2EE push notifications could still be sent.

Usage examples

The -u line implements HTTP Basic authentication. See the Authorization header documentation for how to get those credentials for Veloxa Talk users and bots.

curl -sSX POST https://your-org.veloxatalk.com/api/v1/users/me/api_key/regenerate \
    -u EMAIL_ADDRESS:API_KEY

Parameters

This endpoint does not accept any parameters.

Response

Return values

  • api_key: string

    The new API key for the user.

Example response(s)

Changes: As of Veloxa Talk 7.0 (feature level 167), if any parameters sent in the request are not supported by this endpoint, a successful JSON response will include an ignored_parameters_unsupported array.

A typical successful JSON response may look like:

{
    "api_key": "a1b2c3d4e5f6g7h8i9j0",
    "msg": "",
    "result": "success"
}