api_keys

Create Api Key

Changed on

Create an API key for the current user.

Args: ctx: Async request context. api_key_data: Requested key properties.

Returns: The created API key, including its raw (unhashed) value.

post/v2/users/api_keys

Request

  • Base URL
    https://api.galileo.ai
  • URL
    https://api.galileo.ai/v2/users/api_keys
  • Auth
    • API key in header Splunk-AO-API-Key
    • or API key in header Galileo-API-Key
    • or OAuth 2
      Password
      Token URL: https://api.galileo.ai/login
    • or HTTP basic

Request body

descriptionstring required
expires_atstring date-time nullable

Expiry date for the API key

project_idstring uuid4 nullable
project_role'owner' | 'editor' | 'annotator' | 'viewer' | 'custom'
api_keystring nullable

Optional pre-generated API key value. If not provided, one will be generated automatically. This is used for setups where the same API key needs to exist on multiple clusters.

Response

Successful Response

idstring uuid4 required
descriptionstring required
expires_atstring date-time nullable
created_atstring date-time required
updated_atstring date-time required
last_usedstring date-time nullable
project_idstring uuid4 nullable
project_role'owner' | 'editor' | 'annotator' | 'viewer' | 'custom'
created_bystring uuid4 required
truncatedstring required
api_keystring required

Changes

  • cdaf9547c14dRevision changes
    • warning

      added the new custom enum value to the / response property for the response status

    • info

      added the new custom enum value to the request property /

  • 05003e7835a2Revision changes
    • info

      the endpoint scheme security ClassicAPIKeyHeader was added to the API