Skip to main content
POST
/
v2
/
api-keys
/
{api_key_id}
/
refresh
curl --request POST \
  --url https://api.arize.com/v2/api-keys/{api_key_id}/refresh \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "id": "QXBp1001",
  "name": "CI pipeline key",
  "key_type": "user",
  "status": "active",
  "key": "ak-abc123def456ghi789jkl012mno345pqr678stu901vwx234yz",
  "redacted_key": "ak-abc...xyz",
  "created_by_user_id": "Usr1001",
  "created_at": "2024-01-15T10:30:00Z",
  "expires_at": "2025-01-15T10:30:00Z"
}

Authorizations

​
Authorization
string
header
required

Most Arize AI endpoints require authentication. For those endpoints that require authentication, include your API key in the request header using the format

Path Parameters

​
api_key_id
string
required

The unique API key identifier (base64) A universally unique identifier (base64-encoded opaque string).

Example:

"RW50aXR5OjEyMzQ1"

Body

application/json

Optional body for setting expiry on the new key and/or a grace period on the old key.

​
expires_at
string<date-time>

Expiration timestamp for the refreshed key. If omitted, the refreshed key has no expiration (infinite lifetime).

Example:

"2027-01-01T00:00:00Z"

​
grace_period_seconds
integer

Grace period in seconds during which the old key remains valid after the refresh. When set, the old key's expiration is updated to now + grace_period_seconds instead of being immediately revoked — it expires naturally at the end of the window. If the old key already has an expires_at that is sooner than the grace window end, the shorter value is used (the grace period cannot extend a key's original lifetime). Defaults to 0 (immediate revocation). Maximum is 86400 (24 hours).

Required range: 0 <= x <= 86400
Example:

300

Response

API key successfully created or refreshed. The raw key is only returned once.

​
id
string
required

Unique identifier for the API key.

​
name
string
required

User-defined name for the API key.

​
key_type
enum<string>
required

Type of the API key.

  • user - Key associated with a specific user.
  • service - Key associated with a bot user for service authentication.
Available options:
user,
service
​
status
enum<string>
required

Current status of the API key.

  • active - The key is valid for use.
  • deleted - The key has been deleted by a user.
Available options:
active,
deleted
​
redacted_key
string
required

Redacted version of the key suitable for display (e.g., "ak-abc...xyz").

​
created_at
string<date-time>
required

Timestamp when the key was created.

​
created_by_user_id
string
required

ID of the user who created the key.

​
key
string
required

The full API key value. Only returned once at creation or refresh time. Store it securely — it cannot be retrieved again.

​
description
string

Optional user-defined description for the API key.

​
expires_at
string<date-time>

Optional timestamp when the key will expire.

​
last_used_at
string<date-time>

Approximate timestamp when the key was last used for authentication. This value is periodically updated and may not reflect the most recent usage.