> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Pydantic Logfire

> How to set up the Pydantic Logfire connector, plus the actions that are available.

![Pydantic Logfire](https://stackone-logos.com/api/pydantic-logfire/filled/svg)

v4.0.0[See changelog](https://docs.stackone.com/connectors/logfire/changelog.md)

[51 actions](#actions) · 4 auth methods

Observability

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [Organization API Key · Connector Profile](https://docs.stackone.com/connectors/logfire/guides/connector-profile/organization-api-key.md)
>
> Organization-wide key covering projects, alerts, dashboards, variables, notification channels, schedules, invitations an...

> [card] [Project API Key · Connector Profile](https://docs.stackone.com/connectors/logfire/guides/connector-profile/project-api-key.md)
>
> Scoped to a single project, and required for querying telemetry (logs, traces, exceptions, metrics) and for variable typ...

> [card] [Query API — Read Token · Connector Profile](https://docs.stackone.com/connectors/logfire/guides/connector-profile/query-api-read-token.md)
>
> Read-only token tied to a single project. Queries that project's telemetry (logs, traces, exceptions, metrics) and nothi...

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/logfire/guides/connector-profile/oauth-2-0.md)
>
> Requires registering an OAuth app in Logfire, separately in each data region. Access is limited to the one Logfire proje...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [Organization API Key · Link Account](https://docs.stackone.com/connectors/logfire/guides/link-account/organization-api-key.md)

> [card] [Project API Key · Link Account](https://docs.stackone.com/connectors/logfire/guides/link-account/project-api-key.md)

> [card] [Query API — Read Token · Link Account](https://docs.stackone.com/connectors/logfire/guides/link-account/query-api-read-token.md)

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/logfire/guides/link-account/oauth-2-0.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Authentication type

Select all
|
Clear

OAuth 2.0

Organization API Key

Project API Key

Query API — Read Token

No auth methods found

Scopes

Select all
|
Clear

instance:admin

organization:create\_project

organization:read

organization:read\_channel

organization:read\_invitation

organization:write

organization:write\_channel

organization:write\_invitation

project:read

project:read\_alert

project:read\_dashboard

project:read\_otlp

project:read\_variables

project:write

project:write\_alert

project:write\_dashboard

project:write\_token

project:write\_variables

No scopes found

51 actions

ActionDescriptionRequired scopes

List Alerts`logfire_list_alerts`

List all alerts for a project.

`project:read_alert`

Create Alert`logfire_create_alert`

Create a new alert.

`project:write_alert`

Get Alert`logfire_get_alert`

Get an alert.

`project:read_alert`

Update Alert`logfire_update_alert`

Update an alert.

`project:write_alert`

Delete Alert`logfire_delete_alert`

Delete an alert.

`project:write_alert`

List Channels`logfire_list_channels`

List all notification channels for the organization the project belongs to.

`organization:read_channel`

Create Channel`logfire_create_channel`

Create a notification channel. The pagerduty-integration and slack-integration types require that integration to be inst...

`organization:write_channel`

Get Channel`logfire_get_channel`

Get a single notification channel by ID

`organization:read_channel`

Update Channel`logfire_update_channel`

Update a notification channel. The pagerduty-integration and slack-integration types require that integration to be inst...

`organization:write_channel`

Delete Channel`logfire_delete_channel`

Delete a notification channel.

`organization:write_channel`

List Dashboards`logfire_list_dashboards`

List Dashboards

`project:read_dashboard`

Create Dashboard`logfire_create_dashboard`

Create Dashboard

`project:write_dashboard`

Get Dashboard`logfire_get_dashboard`

Get Dashboard

`project:read_dashboard`

Update Dashboard`logfire_update_dashboard`

Update Dashboard

`project:write_dashboard`

Delete Dashboard`logfire_delete_dashboard`

Delete Dashboard

`project:write_dashboard`

Query Records (SQL)`logfire_query_records`

Run an arbitrary SQL query against the project's telemetry (spans, logs and metrics).

`project:read_otlp`

Get Query Schemas`logfire_get_schemas`

List the tables and columns available to SQL queries for this project.

`project:read_otlp`

Get Read Token Info`logfire_get_read_token_info`

Show which organization and project the Project API Key is bound to.

`project:read_otlp`

Search Records`logfire_search_records`

Search spans and logs by level, service, message text, span name, trace or exception flag.

`project:read_otlp`

Get Trace`logfire_get_trace`

Return every span and log belonging to one trace, in execution order.

`project:read_otlp`

List Exceptions`logfire_list_exceptions`

List records that recorded an exception, newest first.

`project:read_otlp`

List Services`logfire_list_services`

List the services reporting telemetry in a time window, with record counts.

`project:read_otlp`

Get Current Organization`logfire_get_current_organization`

Read the details of the organization the API key belongs to.

`organization:read`

Update Current Organization`logfire_update_current_organization`

Update the details of the organization the API key belongs to.

`organization:write`

Delete Current Organization`logfire_delete_current_organization`

Permanently delete the organization the API key belongs to.

`organization:write`

List Instance Organizations`logfire_list_instance_organizations`

List all organizations across the self-hosted instance. Requires the instance:admin scope — returns HTTP 403 on Logfire...

`instance:admin`

Create Instance Organization`logfire_create_instance_organization`

Create an organization across the self-hosted instance. Requires the instance:admin scope — returns HTTP 403 on Logfire...

`instance:admin`

Create Organization Invitation`logfire_create_organization_invitation`

Create a single-use organization invitation for the current organization.

`organization:write_invitation`

List Organization Invitations`logfire_list_organization_invitations`

List the outstanding invitations for the organization the API key belongs to, including each invitation's expiry and usa...

`organization:read_invitation`

List Projects`logfire_list_projects`

List all projects accessible to the authenticated user

`project:read`

Create Project`logfire_create_project`

Create a new project. Returns HTTP 400 "Projects limit reached" when the account's project quota is full.

`organization:create_project`

Get Project Info`logfire_get_project_info`

Get details of a specific project

`project:read`

Update Project`logfire_update_project`

Update an existing project

`project:write`

Create Project Write Token`logfire_create_project_write_token`

Mint a write token for a project, used to send telemetry into it.

`project:write_token`

List Project Write Tokens`logfire_list_project_write_tokens`

List the write tokens on a project.

`project:write_token`

Delete Project Write Token`logfire_delete_project_write_token`

Permanently delete a project write token.

`project:write_token`

Rotate Project Write Token`logfire_rotate_project_write_token`

Rotate a write token, issuing a replacement.

`project:write_token`

Expire Project Write Token`logfire_expire_project_write_token`

Expire a write token without deleting it.

`project:write_token`

Delete Project`logfire_delete_project`

Delete a project

`project:write`

Create Schedule`logfire_create_schedule`

Create a notification schedule that restricts when an alert channel is notified. Use the returned id as channel\_assignme...

`organization:write_channel`

Delete Schedule`logfire_delete_schedule`

Permanently delete a notification schedule.

`organization:write_channel`

Get Schedule`logfire_get_schedule`

Retrieve a notification schedule by id.

`organization:read_channel`

Update Schedule`logfire_update_schedule`

Update a notification schedule's label, timezone or windows.

`organization:write_channel`

Get Variables Config`logfire_get_variables_config`

Get the full variables configuration for a project.

`project:read_variables`

Create Variable`logfire_create_variable`

Create a new variable definition, optionally with labels and versions.

`project:write_variables`

Get Variable By Name`logfire_get_variable_by_name`

Get a variable definition by name with current labels and latest version.

`project:read_variables`

Update Variable`logfire_update_variable`

Update an existing variable definition, optionally with labels and versions.

`project:write_variables`

List Variable Types`logfire_list_variable_types`

List the reusable variable type definitions for a project, including each type's id. Requires a Project API Key connecti...

`project:read_variables`

Create Variable Type`logfire_create_variable_type`

Create or update (upsert by name) a reusable variable type definition. Requires a Project API Key connection.

`project:write_variables`

Get Variable Type By Name`logfire_get_variable_type_by_name`

Look up one reusable variable type by its exact name and return its id. Requires a Project API Key connection.

`project:read_variables`

Delete Variable`logfire_delete_variable`

Permanently delete a managed variable by its exact name. Requires a Project API Key or OAuth connection.

`project:write_variables`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.