Projects

Create Host Enrollment

Enroll one managed Collector host and return its runtime credential and OpAMP URL.

Policies that reference LOGFIRE_TOKEN also receive a dedicated ingest credential. Those policies require project:write_token in addition to the Fleet enrollment scope.

post/v1/projects/{project_id}/fleet/host-enrollments/

Request

Base URL
https://logfire-api.pydantic.dev/api
Auth
OAuth 2
Authorization codeapi/oauth/authorize
Token URL/api/oauth/token
Scopesproject:enroll_fleet
TypeScript
https://skmtc.dev/pydantic/apis/pydantic-logfire-api/docs/v1/projects/:project_id/fleet/host-enrollments/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

project_idstring uuid required

Request body

assignment_idstring uuid required

namestring required

environmentstring required

registration_keystring uuid required

Response

Successful Response

telemetry_tokenstring password

Installation-owned Logfire ingest credential. Present only when issued with this runtime credential.

tokenstring password required

opamp_urlstring required

credential_delivery'issued' | 'replaced' required

replaced on a retry: every earlier credential of the installation is now revoked

Changes

No recorded changes to this operation across all 1 revision of this API.