Skip to main content
Pydantic Logfire
v3.0.1
50 actions · 2 auth methods
Observability

​
Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See Organizations & Projects.
2

Configure the Connector

Enable the connector and create a Connector Profile in your project. See Setup Connector Profile.

Organization API Key · Connector Profile

Organization-wide key covering projects, alerts, dashboards, variables, notification channels, schedules, invitations an…

Project API Key · Connector Profile

Scoped to a single project. Required for querying telemetry (logs, traces, exceptions, metrics) and for variable types,…
3

Link an Account

Link an account from the dashboard (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:

Organization API Key · Link Account

Project API Key · Link Account

4

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.

​
Actions

|
|
50 actions
Action
Description
Required scopes
List Alerts
List all alerts for a project.
Create Alert
Create a new alert.
Get Alert
Get an alert.
Update Alert
Update an alert.
Delete Alert
Delete an alert.
List Channels
List all notification channels for the organization the project belongs to.
Create Channel
Create a notification channel. The pagerduty-integration and slack-integration types require that integration to be inst…
Get Channel
Get a single notification channel by ID
Update Channel
Update a notification channel. The pagerduty-integration and slack-integration types require that integration to be inst…
Delete Channel
Delete a notification channel.
List Dashboards
List Dashboards
Create Dashboard
Create Dashboard
Get Dashboard
Get Dashboard
Update Dashboard
Update Dashboard
Delete Dashboard
Delete Dashboard
Query Records (SQL)
Run an arbitrary SQL query against the project’s telemetry (spans, logs and metrics).
Get Query Schemas
List the tables and columns available to SQL queries for this project.
Get Read Token Info
Show which organization and project the Project API Key is bound to.
Search Records
Search spans and logs by level, service, message text, span name, trace or exception flag.
Get Trace
Return every span and log belonging to one trace, in execution order.
List Exceptions
List records that recorded an exception, newest first.
List Services
List the services reporting telemetry in a time window, with record counts.
Get Current Organization
Read the details of the organization the API key belongs to.
Update Current Organization
Update the details of the organization the API key belongs to.
Delete Current Organization
Permanently delete the organization the API key belongs to.
List Instance Organizations
List all organizations across the self-hosted instance. Requires the instance:admin scope — returns HTTP 403 on Logfire…
Create Instance Organization
Create an organization across the self-hosted instance. Requires the instance:admin scope — returns HTTP 403 on Logfire…
Create Organization Invitation
Create a single-use organization invitation for the current organization.
List Organization Invitations
List the outstanding invitations for the organization the API key belongs to, including each invitation’s expiry and usa…
List Projects
List all projects accessible to the authenticated user
Create Project
Create a new project. Returns HTTP 400 “Projects limit reached” when the account’s project quota is full.
Get Project Info
Get details of a specific project
Update Project
Update an existing project
Create Project Write Token
Mint a write token for a project, used to send telemetry into it.
List Project Write Tokens
List the write tokens on a project.
Delete Project Write Token
Permanently delete a project write token.
Rotate Project Write Token
Rotate a write token, issuing a replacement.
Expire Project Write Token
Expire a write token without deleting it.
Delete Project
Delete a project
Create Schedule
Create a notification schedule that restricts when an alert channel is notified. Use the returned id as channel_assignme…
Delete Schedule
Permanently delete a notification schedule.
Get Schedule
Retrieve a notification schedule by id.
Update Schedule
Update a notification schedule’s label, timezone or windows.
Get Variables Config
Get the full variables configuration for a project.
Create Variable
Create a new variable definition, optionally with labels and versions.
Get Variable By Name
Get a variable definition by name with current labels and latest version.
Update Variable
Update an existing variable definition, optionally with labels and versions.
List Variable Types
List the reusable variable type definitions for a project, including each type’s id. Requires a Project API Key connecti…
Create Variable Type
Create or update (upsert by name) a reusable variable type definition. Requires a Project API Key connection.
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.