Data API — API Keys

10 min

api_key_create

sync(client: AuthenticatedClient | Client, body: ApiKeyCreateRequest | Unset = UNSET) -> ApiKeyCreatedResponse | ProblemDetails | list[ErrorResponse] | None

Parameter	Type	Default
client	AuthenticatedClient \| Client	required
body	ApiKeyCreateRequest \| Unset	UNSET

body — Request model for creating a new API key.

Returns: ApiKeyCreatedResponse | ProblemDetails | list[ErrorResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

api_key_delete

sync(id: UUID, client: AuthenticatedClient | Client) -> Any | ProblemDetails | list[ErrorResponse] | None

Parameter	Type	Default
id	UUID	required
client	AuthenticatedClient \| Client	required

Returns: Any | ProblemDetails | list[ErrorResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

api_key_describe

sync(id: UUID, client: AuthenticatedClient | Client) -> ApiKeyResponse | ProblemDetails | list[ErrorResponse] | None

Parameter	Type	Default
id	UUID	required
client	AuthenticatedClient \| Client	required

Returns: ApiKeyResponse | ProblemDetails | list[ErrorResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

api_key_list

sync(client: AuthenticatedClient | Client, owned_by_user_id: UUID | Unset = UNSET, owned_by_profile_id: UUID | Unset = UNSET, include_expired: bool | Unset = UNSET, page: int | Unset = UNSET, page_size: int | Unset = UNSET) -> ProblemDetails | list[ApiKeyListItemResponse] | list[ErrorResponse] | None

Parameter	Type	Default
client	AuthenticatedClient \| Client	required
owned_by_user_id	UUID \| Unset	UNSET
owned_by_profile_id	UUID \| Unset	UNSET
include_expired	bool \| Unset	UNSET
page	int \| Unset	UNSET
page_size	int \| Unset	UNSET

Returns: ProblemDetails | list[ApiKeyListItemResponse] | list[ErrorResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

api_key_validate

sync(hint: str, client: AuthenticatedClient | Client) -> ProblemDetails | bool | list[ErrorResponse] | None

Parameter	Type	Default
hint	str	required
client	AuthenticatedClient \| Client	required

Returns: ProblemDetails | bool | list[ErrorResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.