Api keys

Last updated 1 month ago

Was this helpful?

Get Api Key

get

Returns the requested API key.

Args: service_account_id: ID of the service account to which the API key belongs. hydrate: Flag deciding whether to hydrate the output model(s) by including metadata fields in the response. api_key_name_or_id: Name or ID of the API key to return.

Returns: The requested API key.

Authorizations

Path parameters

service_account_idstring · uuidRequired

api_key_name_or_idany ofRequired

Query parameters

hydratebooleanOptionalDefault: true

Responses

application/json

objectOptional

Response model for API keys.

application/json

get

GET /api/v1/service_accounts/{service_account_id}/api_keys/{api_key_name_or_id} HTTP/1.1
Host: 
Accept: */*

{
  "body": {
    "created": "2025-04-21T16:49:05.607Z",
    "updated": "2025-04-21T16:49:05.607Z",
    "key": "text",
    "active": true,
    "service_account": {
      "body": {
        "created": "2025-04-21T16:49:05.607Z",
        "updated": "2025-04-21T16:49:05.607Z",
        "active": true
      },
      "metadata": {
        "description": "text"
      },
      "resources": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "permission_denied": true,
      "name": "text"
    }
  },
  "metadata": {
    "description": "text",
    "retain_period_minutes": 1,
    "last_login": "2025-04-21T16:49:05.607Z",
    "last_rotated": "2025-04-21T16:49:05.607Z"
  },
  "resources": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "permission_denied": true,
  "name": "text"
}

Delete Api Key

delete

Deletes an API key.

Args: service_account_id: ID of the service account to which the API key belongs. api_key_name_or_id: Name or ID of the API key to delete.

Authorizations

Path parameters

service_account_idstring · uuidRequired

api_key_name_or_idany ofRequired

Responses

application/json

anyOptional

application/json

delete

DELETE /api/v1/service_accounts/{service_account_id}/api_keys/{api_key_name_or_id} HTTP/1.1
Host: 
Accept: */*

No content

List Api Keys

get

List API keys associated with a service account.

Args: service_account_id: ID of the service account to which the API keys belong. hydrate: Flag deciding whether to hydrate the output model(s) by including metadata fields in the response. filter_model: Filter model used for pagination, sorting, filtering

Returns: All API keys matching the filter and associated with the supplied service account.

Authorizations

Path parameters

service_account_idstring · uuidRequired

Query parameters

hydratebooleanOptionalDefault: false

sort_bystringOptionalDefault: created

logical_operatorstring · enumOptional

Logical Ops to use to combine filters on list methods.

Default: andAvailable options:

pageinteger · min: 1OptionalDefault: 1

sizeinteger · min: 1 · max: 10000OptionalDefault: 20

idany ofOptional

createdany ofOptional

updatedany ofOptional

service_accountany ofOptional

nameany ofOptional

descriptionany ofOptional

activeany ofOptional

last_loginany ofOptional

last_rotatedany ofOptional

Responses

application/json

objectOptional

application/json

get

GET /api/v1/service_accounts/{service_account_id}/api_keys HTTP/1.1
Host: 
Accept: */*

{
  "index": 1,
  "max_size": 1,
  "total_pages": 1,
  "total": 1,
  "items": [
    {
      "body": {
        "created": "2025-04-21T16:49:05.607Z",
        "updated": "2025-04-21T16:49:05.607Z",
        "key": "text",
        "active": true,
        "service_account": {
          "body": {
            "created": "2025-04-21T16:49:05.607Z",
            "updated": "2025-04-21T16:49:05.607Z",
            "active": true
          },
          "metadata": {
            "description": "text"
          },
          "resources": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "permission_denied": true,
          "name": "text"
        }
      },
      "metadata": {
        "description": "text",
        "retain_period_minutes": 1,
        "last_login": "2025-04-21T16:49:05.607Z",
        "last_rotated": "2025-04-21T16:49:05.607Z"
      },
      "resources": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "permission_denied": true,
      "name": "text"
    }
  ]
}

Create Api Key

post

Creates an API key for a service account.

Args: service_account_id: ID of the service account for which to create the API key. api_key: API key to create.

Returns: The created API key.

Authorizations

Path parameters

service_account_idstring · uuidRequired

Body

Request model for API keys.

namestring · max: 255Required

descriptionany ofOptional

Responses

application/json

objectOptional

Response model for API keys.

application/json

post

POST /api/v1/service_accounts/{service_account_id}/api_keys HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "name": "text",
  "description": "text"
}

{
  "body": {
    "created": "2025-04-21T16:49:05.607Z",
    "updated": "2025-04-21T16:49:05.607Z",
    "key": "text",
    "active": true,
    "service_account": {
      "body": {
        "created": "2025-04-21T16:49:05.607Z",
        "updated": "2025-04-21T16:49:05.607Z",
        "active": true
      },
      "metadata": {
        "description": "text"
      },
      "resources": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "permission_denied": true,
      "name": "text"
    }
  },
  "metadata": {
    "description": "text",
    "retain_period_minutes": 1,
    "last_login": "2025-04-21T16:49:05.607Z",
    "last_rotated": "2025-04-21T16:49:05.607Z"
  },
  "resources": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "permission_denied": true,
  "name": "text"
}

Update Api Key

put

Updates an API key for a service account.

Args: service_account_id: ID of the service account to which the API key belongs. api_key_name_or_id: Name or ID of the API key to update. api_key_update: API key update.

Returns: The updated API key.

Authorizations

Path parameters

service_account_idstring · uuidRequired

api_key_name_or_idany ofRequired

Body

Update model for API keys.

nameany ofOptional

descriptionany ofOptional

activeany ofOptional

Responses

application/json

objectOptional

Response model for API keys.

application/json

put

PUT /api/v1/service_accounts/{service_account_id}/api_keys/{api_key_name_or_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 50

{
  "name": "text",
  "description": "text",
  "active": true
}

{
  "body": {
    "created": "2025-04-21T16:49:05.607Z",
    "updated": "2025-04-21T16:49:05.607Z",
    "key": "text",
    "active": true,
    "service_account": {
      "body": {
        "created": "2025-04-21T16:49:05.607Z",
        "updated": "2025-04-21T16:49:05.607Z",
        "active": true
      },
      "metadata": {
        "description": "text"
      },
      "resources": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "permission_denied": true,
      "name": "text"
    }
  },
  "metadata": {
    "description": "text",
    "retain_period_minutes": 1,
    "last_login": "2025-04-21T16:49:05.607Z",
    "last_rotated": "2025-04-21T16:49:05.607Z"
  },
  "resources": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "permission_denied": true,
  "name": "text"
}