# Foxglove REST API > The Foxglove REST API provides programmatic access to Foxglove including devices, recordings, events, and more. Base URL: https://api.foxglove.dev/v1 Interactive documentation: https://docs.foxglove.dev/api For product documentation (visualization, panels, layouts, extensions, SDKs), see https://docs.foxglove.dev/llms.txt **Python client** Foxglove provides a Python client library ([`foxglove-client`](https://github.com/foxglove/foxglove-python)) to more easily interact with the Foxglove API. The Python client can be downloaded from [PyPI](https://pypi.org/project/foxglove-client/) and source is available on [GitHub](https://github.com/foxglove/foxglove-python). **Authentication** All routes excluding the [Site Bucket Notifications endpoint](https://docs.foxglove.dev/api/sites/notify-object-created-or-removed) require an [API key](https://docs.foxglove.dev/docs/settings#api-keys) with specific capabilities. Organization admins can create organization API keys, and members can create [personal access tokens](https://docs.foxglove.dev/docs/personal-access-tokens) that act as them. Some routes, such as those that manage credentials, don't accept personal access tokens. API keys and personal access tokens can be limited to projects. A key limited to projects can read organization-wide resources (layouts, extensions, event types, custom properties, and sites), but can't create, change, or delete them. It also can't read or change a site's ingest path policy or backfill jobs, manage site tokens or site inbox notification tokens, or list organization members. These operations return a 403 error with the code `ProjectLimitedCredentialDenied`. A key limited to more than one project must send `projectId` to most endpoints that accept one. See [Limit API keys and personal access tokens](https://docs.foxglove.dev/docs/projects#limit-api-keys-and-personal-access-tokens) for the full rules and the errors a limited key can get. Requests must include the API key in the `Authorization` header as a bearer token: ``` Authorization: Bearer fox_sk_1234... ``` Each endpoint in the API reference lists the capabilities required for access. An endpoint with Authorizations `ApiKey (devices.list)` would require an api key with the `devices.list` capability. Applications that integrate with Foxglove can instead call the API with an [OAuth](https://docs.foxglove.dev/docs/oauth) access token, which acts as the user who approved the application. An endpoint accepts an OAuth access token only when it lists `OAuthToken` among its authorizations. **Sorting and pagination** Some GET endpoints support sorting and pagination. Where supported, you will see the following query parameters in the endpoint documentation: * `sortBy` – Field name to sort by (endpoint specific) * `sortOrder` – "asc" or "desc" * `limit` – Number of records in the response * `offset` – Number of records to skip If no limit is provided, endpoints will default to a limit of 2000 items. Requesting a limit greater than 2000 items will result in a 400 response. **Timestamps** Unless otherwise documented, all timestamp related fields (start, end, created, etc) use the ISO8601 conforming [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) UTC "Zulu" format. In the documentation this will appear as `string` types with `` formatting (i.e. `string `). These timestamps support nanosecond resolution with up to nine fractional digits. Examples: - 2023-04-06T09:15:30Z - 2023-04-06T18:27:45.876543210Z > Note: Variants of RFC3339 using durations or offsets which are not conforming to ISO8601 are not supported. **Rate limits** To help ensure responsiveness for all clients, requests to the API may be rate-limited. In this case, a request will receive a status code of 429. Your client may refer to headers, such as "Retry-After", to determine when a request should be retried. In general, if your client experiences an error, you should adjust the rate at which your client makes requests, and you may issue retries with a strategy such as exponential backoff. **Related resources** - [Full REST API reference for LLMs](https://docs.foxglove.dev/api/llms-full.txt) - [Product documentation for LLMs](https://docs.foxglove.dev/llms.txt) - [Full product documentation for LLMs](https://docs.foxglove.dev/llms-full.txt) - [Python SDK API reference](https://sdk-docs.foxglove.dev/python/): Modules, classes, and functions of the `foxglove-sdk` Python package - [Rust SDK API reference](https://docs.rs/foxglove/latest/foxglove/): Crate documentation for the `foxglove` Rust crate - [C++ SDK API reference](https://sdk-docs.foxglove.dev/cpp/): Classes and functions of the Foxglove C++ SDK ## Automations - [`GET /automations`](https://docs.foxglove.dev/api/automations/list-automations): List automations - [`POST /automations`](https://docs.foxglove.dev/api/automations/create-an-automation): Create an automation - [`GET /automations/{automationId}`](https://docs.foxglove.dev/api/automations/get-an-automation): Get an automation - [`PATCH /automations/{automationId}`](https://docs.foxglove.dev/api/automations/edit-an-automation): Edit an automation - [`DELETE /automations/{automationId}`](https://docs.foxglove.dev/api/automations/delete-an-automation): Delete an automation - [`GET /automations/{automationId}/trigger`](https://docs.foxglove.dev/api/automations/get-an-automation-trigger): Get an automation trigger - [`PUT /automations/{automationId}/trigger`](https://docs.foxglove.dev/api/automations/set-an-automation-trigger): Set an automation trigger - [`DELETE /automations/{automationId}/trigger`](https://docs.foxglove.dev/api/automations/delete-an-automation-trigger): Delete an automation trigger - [`POST /automations/runs`](https://docs.foxglove.dev/api/automations/create-an-automation-run): Create an automation run - [`GET /automations/runs`](https://docs.foxglove.dev/api/automations/list-automation-runs): List automation runs - [`GET /automations/runs/{runId}`](https://docs.foxglove.dev/api/automations/get-an-automation-run): Get an automation run - [`DELETE /automations/runs/{runId}`](https://docs.foxglove.dev/api/automations/delete-an-automation-run): Delete an automation run ## Coverage - [`GET /data/coverage`](https://docs.foxglove.dev/api/coverage/list-coverage): List coverage ## Custom Properties - [`GET /custom-properties`](https://docs.foxglove.dev/api/custom-properties/list-custom-properties): List custom properties - [`POST /custom-properties`](https://docs.foxglove.dev/api/custom-properties/create-a-custom-property): Create a custom property - [`GET /custom-properties/{id}`](https://docs.foxglove.dev/api/custom-properties/get-a-custom-property): Get a custom property - [`PATCH /custom-properties/{id}`](https://docs.foxglove.dev/api/custom-properties/edit-a-custom-property): Edit a custom property - [`DELETE /custom-properties/{id}`](https://docs.foxglove.dev/api/custom-properties/delete-a-custom-property): Delete a custom property ## Datasets - [`POST /datasets`](https://docs.foxglove.dev/api/datasets/create-a-dataset): Create a dataset - [`GET /datasets`](https://docs.foxglove.dev/api/datasets/list-datasets): List datasets - [`GET /datasets/{id}`](https://docs.foxglove.dev/api/datasets/get-a-dataset): Get a dataset - [`PATCH /datasets/{id}`](https://docs.foxglove.dev/api/datasets/edit-a-dataset): Edit a dataset - [`DELETE /datasets/{id}`](https://docs.foxglove.dev/api/datasets/delete-a-dataset): Delete a dataset - [`GET /datasets/{id}/episodes`](https://docs.foxglove.dev/api/datasets/list-dataset-episodes): List dataset episodes - [`PATCH /datasets/{id}/episodes`](https://docs.foxglove.dev/api/datasets/add-update-or-remove-dataset-episodes): Add, update, or remove dataset episodes - [`POST /datasets/{id}/commit`](https://docs.foxglove.dev/api/datasets/commit-a-new-dataset-version): Commit a new dataset version - [`POST /datasets/{id}/discard`](https://docs.foxglove.dev/api/datasets/discard-the-editable-version-s-changes): Discard the editable version's changes - [`GET /datasets/{id}/versions`](https://docs.foxglove.dev/api/datasets/list-dataset-versions): List dataset versions - [`GET /datasets/{id}/versions/{versionNumber}`](https://docs.foxglove.dev/api/datasets/get-a-dataset-version): Get a dataset version - [`PATCH /datasets/{id}/versions/{versionNumber}`](https://docs.foxglove.dev/api/datasets/update-a-dataset-version): Update a dataset version - [`GET /datasets/{id}/versions/{versionNumber}/episodes`](https://docs.foxglove.dev/api/datasets/list-a-dataset-version-s-episodes): List a dataset version's episodes - [`GET /datasets/{id}/versions/{versionNumber}/compare`](https://docs.foxglove.dev/api/datasets/compare-two-dataset-versions): Compare two dataset versions - [`POST /datasets/{id}/versions/{versionNumber}/restore`](https://docs.foxglove.dev/api/datasets/restore-a-previous-version): Restore a previous version - [`POST /datasets/{id}/versions/{versionNumber}/clone`](https://docs.foxglove.dev/api/datasets/clone-a-dataset-version): Clone a dataset version ## Device Tokens - [`GET /device-tokens`](https://docs.foxglove.dev/api/device-tokens/list-device-tokens): List device tokens - [`POST /device-tokens`](https://docs.foxglove.dev/api/device-tokens/create-a-device-token): Create a device token - [`GET /device-tokens/{id}`](https://docs.foxglove.dev/api/device-tokens/get-a-device-token): Get a device token - [`PATCH /device-tokens/{id}`](https://docs.foxglove.dev/api/device-tokens/edit-a-device-token): Edit a device token - [`DELETE /device-tokens/{id}`](https://docs.foxglove.dev/api/device-tokens/delete-a-device-token): Delete a device token ## Devices - [`GET /devices`](https://docs.foxglove.dev/api/devices/list-devices): List devices - [`POST /devices`](https://docs.foxglove.dev/api/devices/create-a-device): Create a device - [`POST /actions/devices/{nameOrId}/update-property-time-interval`](https://docs.foxglove.dev/api/devices/update-property-time-interval): Update property time interval - [`GET /devices/{nameOrId}`](https://docs.foxglove.dev/api/devices/get-a-device): Get a device - [`DELETE /devices/{nameOrId}`](https://docs.foxglove.dev/api/devices/delete-a-device): Delete a device - [`PATCH /devices/{nameOrId}`](https://docs.foxglove.dev/api/devices/update-a-device): Update a device - [`GET /devices/{nameOrId}/property-time-intervals`](https://docs.foxglove.dev/api/devices/list-property-time-intervals): List property time intervals - [`GET /devices/{nameOrId}/property-time-intervals/{id}`](https://docs.foxglove.dev/api/devices/get-a-device-property-time-interval): Get a device property time interval ## Episodes - [`POST /episodes`](https://docs.foxglove.dev/api/episodes/get-or-create-episodes): Get or create episodes - [`GET /episodes`](https://docs.foxglove.dev/api/episodes/list-episodes): List episodes - [`PATCH /episodes`](https://docs.foxglove.dev/api/episodes/update-episodes): Update episodes - [`GET /episodes/{id}/versions`](https://docs.foxglove.dev/api/episodes/list-episode-versions): List episode versions - [`GET /episodes/{id}`](https://docs.foxglove.dev/api/episodes/get-an-episode): Get an episode - [`PATCH /episodes/{id}`](https://docs.foxglove.dev/api/episodes/update-an-episode): Update an episode - [`DELETE /episodes/{id}`](https://docs.foxglove.dev/api/episodes/delete-an-episode): Delete an episode ## Events - [`GET /events`](https://docs.foxglove.dev/api/events/list-events): List events - [`POST /events`](https://docs.foxglove.dev/api/events/create-an-event): Create an event - [`GET /events/{id}`](https://docs.foxglove.dev/api/events/get-an-event): Get an event - [`DELETE /events/{id}`](https://docs.foxglove.dev/api/events/delete-an-event): Delete an event - [`PATCH /events/{id}`](https://docs.foxglove.dev/api/events/update-an-event): Update an event ## Event Types - [`GET /event-types`](https://docs.foxglove.dev/api/event-types/list-event-types): List event types - [`POST /event-types`](https://docs.foxglove.dev/api/event-types/create-an-event-type): Create an event type - [`GET /event-types/{id}`](https://docs.foxglove.dev/api/event-types/get-an-event-type): Get an event type - [`PATCH /event-types/{id}`](https://docs.foxglove.dev/api/event-types/update-an-event-type): Update an event type - [`DELETE /event-types/{id}`](https://docs.foxglove.dev/api/event-types/delete-an-event-type): Delete an event type ## Imports - [`GET /data/imports`](https://docs.foxglove.dev/api/imports/list-imports): List imports (deprecated) - [`DELETE /data/imports`](https://docs.foxglove.dev/api/imports/delete-multiple-imports): Delete multiple imports (deprecated) - [`DELETE /data/imports/{importId}`](https://docs.foxglove.dev/api/imports/delete-an-import): Delete an import (deprecated) ## Lake files - [`GET /lake-files`](https://docs.foxglove.dev/api/lake-files/list-lake-files): List lake files ## Projects - [`GET /projects`](https://docs.foxglove.dev/api/projects/list-projects): List projects - [`PATCH /projects/{id}/members`](https://docs.foxglove.dev/api/projects/add-or-remove-project-members): Add or remove project members ## Recording Attachments - [`GET /recording-attachments`](https://docs.foxglove.dev/api/recording-attachments/list-attachments): List attachments - [`GET /recording-attachments/{id}`](https://docs.foxglove.dev/api/recording-attachments/get-an-attachment): Get an attachment - [`GET /recording-attachments/{id}/download`](https://docs.foxglove.dev/api/recording-attachments/download-an-attachment): Download an attachment ## Recordings - [`GET /recordings`](https://docs.foxglove.dev/api/recordings/list-recordings): List recordings - [`GET /recordings/{keyOrId}`](https://docs.foxglove.dev/api/recordings/get-a-recording): Get a recording - [`DELETE /recordings/{keyOrId}`](https://docs.foxglove.dev/api/recordings/delete-a-recording): Delete a recording - [`POST /recordings/{keyOrId}/import`](https://docs.foxglove.dev/api/recordings/import-from-edge): Import from edge - [`GET /data/pending-imports`](https://docs.foxglove.dev/api/recordings/list-pending-imports): List pending imports - [`GET /data/import-errors`](https://docs.foxglove.dev/api/recordings/list-import-errors): List import errors - [`POST /data/upload`](https://docs.foxglove.dev/api/recordings/upload-a-recording): Upload a recording ## Sessions - [`GET /sessions`](https://docs.foxglove.dev/api/sessions/list-sessions): List sessions - [`POST /sessions`](https://docs.foxglove.dev/api/sessions/create-a-session): Create a session - [`GET /sessions/{keyOrId}`](https://docs.foxglove.dev/api/sessions/get-a-session): Get a session - [`PATCH /sessions/{keyOrId}`](https://docs.foxglove.dev/api/sessions/update-a-session): Update a session - [`DELETE /sessions/{keyOrId}`](https://docs.foxglove.dev/api/sessions/delete-a-session): Delete a session ## Site Tokens - [`GET /site-tokens`](https://docs.foxglove.dev/api/site-tokens/list-site-tokens): List site tokens - [`POST /site-tokens`](https://docs.foxglove.dev/api/site-tokens/create-a-site-token): Create a site token - [`DELETE /site-tokens/{id}`](https://docs.foxglove.dev/api/site-tokens/delete-a-site-token): Delete a site token ## Site Inbox Notification Tokens - [`GET /site-inbox-notification-tokens`](https://docs.foxglove.dev/api/site-inbox-notification-tokens/list-inbox-notification-tokens): List inbox notification tokens - [`POST /site-inbox-notification-tokens`](https://docs.foxglove.dev/api/site-inbox-notification-tokens/create-a-site-inbox-notification-token): Create a site inbox notification token - [`DELETE /site-inbox-notification-tokens/{id}`](https://docs.foxglove.dev/api/site-inbox-notification-tokens/delete-an-inbox-notification-token): Delete an inbox notification token ## Sites - [`GET /sites`](https://docs.foxglove.dev/api/sites/list-sites): List sites - [`POST /sites`](https://docs.foxglove.dev/api/sites/create-a-site): Create a Site - [`GET /sites/{id}`](https://docs.foxglove.dev/api/sites/get-site-details): Get site details - [`PATCH /sites/{id}`](https://docs.foxglove.dev/api/sites/update-site-details): Update site details - [`DELETE /sites/{id}`](https://docs.foxglove.dev/api/sites/delete-a-site): Delete a site - [`GET /sites/{id}/ingest-path-policy`](https://docs.foxglove.dev/api/sites/get-the-latest-site-ingest-path-policy): Get the latest site ingest path policy - [`POST /sites/{id}/ingest-path-policy`](https://docs.foxglove.dev/api/sites/save-a-site-ingest-path-policy): Save a site ingest path policy - [`POST /site-bucket-notifications`](https://docs.foxglove.dev/api/sites/notify-object-created-or-removed): Notify object created or removed ## Stream data - [`POST /data/stream`](https://docs.foxglove.dev/api/stream-data/download-data): Download data ## Topics - [`GET /data/topics`](https://docs.foxglove.dev/api/topics/list-topics): List topics ## Webhook Payloads - [`WEBHOOK recording.created`](https://docs.foxglove.dev/api/webhook-payloads/recording-created): recording.created - [`WEBHOOK recording.imported`](https://docs.foxglove.dev/api/webhook-payloads/recording-imported): recording.imported - [`WEBHOOK session.created`](https://docs.foxglove.dev/api/webhook-payloads/session-created): session.created - [`WEBHOOK device.created`](https://docs.foxglove.dev/api/webhook-payloads/device-created): device.created - [`WEBHOOK device.updated`](https://docs.foxglove.dev/api/webhook-payloads/device-updated): device.updated - [`WEBHOOK event.created`](https://docs.foxglove.dev/api/webhook-payloads/event-created): event.created - [`WEBHOOK event.updated`](https://docs.foxglove.dev/api/webhook-payloads/event-updated): event.updated - [`WEBHOOK dataset.version.committed`](https://docs.foxglove.dev/api/webhook-payloads/dataset-version-committed): dataset.version.committed - [`WEBHOOK dataset.created`](https://docs.foxglove.dev/api/webhook-payloads/dataset-created): dataset.created - [`WEBHOOK dataset.updated`](https://docs.foxglove.dev/api/webhook-payloads/dataset-updated): dataset.updated - [`WEBHOOK dataset.deleted`](https://docs.foxglove.dev/api/webhook-payloads/dataset-deleted): dataset.deleted - [`WEBHOOK episode.created`](https://docs.foxglove.dev/api/webhook-payloads/episode-created): episode.created - [`WEBHOOK episode.updated`](https://docs.foxglove.dev/api/webhook-payloads/episode-updated): episode.updated - [`WEBHOOK episode.deleted`](https://docs.foxglove.dev/api/webhook-payloads/episode-deleted): episode.deleted - [`WEBHOOK automation_run.finished`](https://docs.foxglove.dev/api/webhook-payloads/automation-run-finished): automation_run.finished - [`WEBHOOK ping`](https://docs.foxglove.dev/api/webhook-payloads/ping): ping ## Extensions - [`POST /extension-upload`](https://docs.foxglove.dev/api/extensions/publish-an-extension): Publish an extension - [`GET /extensions`](https://docs.foxglove.dev/api/extensions/list-extensions): List extensions - [`GET /extensions/{id}`](https://docs.foxglove.dev/api/extensions/get-an-extension): Get an extension - [`DELETE /extensions/{id}`](https://docs.foxglove.dev/api/extensions/delete-an-extension): Delete an extension ## Layouts - [`GET /layouts`](https://docs.foxglove.dev/api/layouts/list-layouts): List layouts - [`POST /layouts`](https://docs.foxglove.dev/api/layouts/create-a-layout): Create a layout - [`GET /layouts/{id}`](https://docs.foxglove.dev/api/layouts/get-a-layout): Get a layout - [`DELETE /layouts/{id}`](https://docs.foxglove.dev/api/layouts/delete-a-layout): Delete a layout - [`PATCH /layouts/{id}`](https://docs.foxglove.dev/api/layouts/update-a-layout): Update a layout - [`POST /layouts/{id}/restore`](https://docs.foxglove.dev/api/layouts/restore-a-layout): Restore a layout