# Aerovy Platform

> Documentation for Aerovy Platform.

## Guides

- [Introduction](https://docs.aerovy.com/index.md): A developer's guide to the Aerovy Platform.
- [Quickstart](https://docs.aerovy.com/quickstart.md): Model a device, send your first telemetry reading, and map a raw payload with a template.
- [Overview](https://docs.aerovy.com/platform/overview.md): An intelligence platform that unifies your data and knowledge into an operational ontology.
- [Core concepts](https://docs.aerovy.com/platform/core-concepts.md): An overview of our platform entities
- [Data model](https://docs.aerovy.com/platform/data-model.md): How to define your device types and the data they report.
- [Templates](https://docs.aerovy.com/platform/templates.md): Map external payloads into platform telemetry.
- [Resource filters](https://docs.aerovy.com/platform/resource-filters.md): How to restrict which resources an API key can touch.
- [Rate limits](https://docs.aerovy.com/platform/rate-limits.md): How Enterprise API v2 rate limits work, how they're scoped, and how to stay within them.
- [Data security & retention](https://docs.aerovy.com/platform/security.md): How the Spectra platform protects, isolates, retains, and recovers your data.
- [Overview](https://docs.aerovy.com/console/overview.md): The landing dashboard: fleet-wide health at a glance.
- [Sites](https://docs.aerovy.com/console/sites.md): Model physical locations and the devices deployed there.
- [Fleets](https://docs.aerovy.com/console/fleets.md): Group devices into fleets, independent of physical location.
- [Devices](https://docs.aerovy.com/console/devices.md): Browse devices, read their telemetry, and manage their configuration.
- [Transactions](https://docs.aerovy.com/console/transactions.md): Browse transactions over a time range.
- [Monitors](https://docs.aerovy.com/console/monitors.md): Watch device metrics on a schedule and raise alerts when conditions trip.
- [Ontology](https://docs.aerovy.com/console/ontology.md): Define device types, the metrics they emit, and their property schemas.
- [Integrations](https://docs.aerovy.com/console/integrations.md): Connect external systems to pull data in or push notifications out.
- [API keys](https://docs.aerovy.com/console/api-keys.md): Create, scope, and revoke the keys that authenticate API requests.
- [Organization](https://docs.aerovy.com/console/organization.md): Manage your organization profile, branding, and members.
- [Overview](https://docs.aerovy.com/agentic/overview.md): How the platform builds, maintains, and surfaces your organization's knowledge.
- [Ontology Agent](https://docs.aerovy.com/agentic/ontology-agent.md): The always-on background agent that keeps your ontology correct, linked, and current.
- [Workflows](https://docs.aerovy.com/agentic/workflows.md): Configure workflows that automate company tasks.
- [MCP server](https://docs.aerovy.com/agentic/mcp-server.md): Drive the Aerovy Platform API from an AI agent through two spec-driven tools.
- [API fundamentals](https://docs.aerovy.com/platform/api-fundamentals.md): The conventions every endpoint shares: auth, base URLs, versioning, IDs, etc.
- [Authenticating with API keys](https://docs.aerovy.com/platform/api-keys.md): How to authenticate requests, and what a key controls.
- [Ingesting data](https://docs.aerovy.com/platform/ingesting-data.md): Sending telemetry into the Aerovy Platform
- [Querying data](https://docs.aerovy.com/platform/querying-data.md): How to read telemetry back out (raw, aggregated, and exported)

## API Reference

- [List thing-type definitions](https://docs.aerovy.com/api-reference/thing-type-definitions/get-definitions-thing-types.md): Returns a paginated list of thing-type definition indices for the calling organization. Requires an API key with the read action.
- [Create a thing-type definition](https://docs.aerovy.com/api-reference/thing-type-definitions/post-definitions-thing-types.md): Creates a new thing-type definition (its first version). Requires an API key with the write action.
- [Get a thing-type version](https://docs.aerovy.com/api-reference/thing-type-definitions/get-definitions-thing-types-versions-thingtypedefid.md): Returns a specific thing-type definition version by id. Requires an API key with the read action.
- [Update a thing-type version](https://docs.aerovy.com/api-reference/thing-type-definitions/put-definitions-thing-types-versions-thingtypedefid.md): Updates the metadata of a specific thing-type definition version. Requires an API key with the write action.
- [Get a thing-type definition](https://docs.aerovy.com/api-reference/thing-type-definitions/get-definitions-thing-types-thingtypeid.md): Returns a single thing-type definition index by id. Requires an API key with the read action scoped to the thing type.
- [Update a thing-type definition](https://docs.aerovy.com/api-reference/thing-type-definitions/put-definitions-thing-types-thingtypeid.md): Updates the metadata of a thing-type definition index. Requires an API key with the write action scoped to the thing type.
- [Soft-delete a thing-type definition](https://docs.aerovy.com/api-reference/thing-type-definitions/delete-definitions-thing-types-thingtypeid.md): Soft-deletes a thing-type definition. Requires an API key with the write action scoped to the thing type.
- [List thing-type versions](https://docs.aerovy.com/api-reference/thing-type-definitions/get-definitions-thing-types-thingtypeid-versions.md): Returns the full version history for a thing type. Requires an API key with the read action.
- [Create a thing-type version](https://docs.aerovy.com/api-reference/thing-type-definitions/post-definitions-thing-types-thingtypeid-versions.md): Creates a new version of an existing thing-type definition. Requires an API key with the write action.
- [List metric definitions](https://docs.aerovy.com/api-reference/metric-definitions/get-definitions-metrics.md): Returns a paginated list of metric definitions for the calling organization. Requires an API key with the read action.
- [Create a metric definition](https://docs.aerovy.com/api-reference/metric-definitions/post-definitions-metrics.md): Creates a new metric definition. Requires an API key with the write action.
- [Get the metric schema](https://docs.aerovy.com/api-reference/metric-definitions/get-definitions-metrics-schema.md): Returns the supported data types and the valid aggregations for each — static reference data used when creating metric definitions.
- [Get a metric definition](https://docs.aerovy.com/api-reference/metric-definitions/get-definitions-metrics-metricid.md): Returns a single metric definition by id. Requires an API key with the read action scoped to the metric.
- [Update a metric definition](https://docs.aerovy.com/api-reference/metric-definitions/put-definitions-metrics-metricid.md): Updates the mutable fields of a metric definition. Requires an API key with the write action scoped to the metric.
- [Soft-delete a metric definition](https://docs.aerovy.com/api-reference/metric-definitions/delete-definitions-metrics-metricid.md): Soft-deletes a metric definition. Requires an API key with the write action scoped to the metric.
- [List templates](https://docs.aerovy.com/api-reference/templates/get-templates.md): Lists the calling organization's templates, optionally filtered by target/format and status. Requires an API key with the read action.
- [Create a template](https://docs.aerovy.com/api-reference/templates/post-templates.md): Creates a new template. target and format are immutable after creation. Requires an API key with the write action.
- [Get a template](https://docs.aerovy.com/api-reference/templates/get-templates-templateid.md): Returns a single template by id. Requires an API key with the read action scoped to the template.
- [Update a template](https://docs.aerovy.com/api-reference/templates/put-templates-templateid.md): Updates a template's mutable fields (name, description, spec, tags). target and format are immutable.
- [Delete a template](https://docs.aerovy.com/api-reference/templates/delete-templates-templateid.md): Soft-deletes a template. Requires an API key with the write action scoped to the template.
- [Test a template (dry run)](https://docs.aerovy.com/api-reference/templates/post-templates-templateid-test.md): Maps a sample payload through the template (extractor + transform only — no Thing resolution, no metric intersection, no write) and returns the produced…
- [Create a thing in a fleet](https://docs.aerovy.com/api-reference/things/post-fleets-placeid-things.md): Creates a thing in a fleet. Requires an API key with the write action scoped to the fleet.
- [List things in a fleet](https://docs.aerovy.com/api-reference/things/get-fleets-placeid-things.md): Lists the things in a fleet. Requires an API key with the read action scoped to the fleet.
- [Bulk-create things in a fleet](https://docs.aerovy.com/api-reference/things/post-fleets-placeid-things-bulk.md): Creates multiple things in a fleet. Requires an API key with the write action scoped to the fleet.
- [Create a thing in a site](https://docs.aerovy.com/api-reference/things/post-sites-placeid-things.md): Creates a thing in a site. Requires an API key with the write action scoped to the site.
- [List things in a site](https://docs.aerovy.com/api-reference/things/get-sites-placeid-things.md): Lists the things in a site. Requires an API key with the read action scoped to the site.
- [Bulk-create things in a site](https://docs.aerovy.com/api-reference/things/post-sites-placeid-things-bulk.md): Creates multiple things in a site. Requires an API key with the write action scoped to the site.
- [List things of a type](https://docs.aerovy.com/api-reference/things/get-thing-types-thingtypeid-things.md): Lists things of a given thing type. Requires an API key with the read action. thingTypeId is a ThingTypeDefinitionIndex id (e.g. tdefi…).
- [List things](https://docs.aerovy.com/api-reference/things/get-things.md): Lists all things for the calling organization — all things when no pagination params are supplied, otherwise a single page.
- [Get a thing](https://docs.aerovy.com/api-reference/things/get-things-thingid.md): Gets a single thing by id. Requires an API key with the read action scoped to the thing.
- [Update a thing](https://docs.aerovy.com/api-reference/things/patch-things-thingid.md): Updates a thing's metadata. Requires an API key with the write action scoped to the thing. Place context is resolved server-side from the thing id.
- [Soft-delete a thing](https://docs.aerovy.com/api-reference/things/delete-things-thingid.md): Soft-deletes a thing. Requires an API key with the write action scoped to the thing.
- [Set a thing property](https://docs.aerovy.com/api-reference/things/patch-things-thingid-properties-key.md): Sets a single thing property. Requires an API key with the write action scoped to the thing.
- [Delete a thing property](https://docs.aerovy.com/api-reference/things/delete-things-thingid-properties-key.md): Deletes a single thing property. Requires an API key with the write action scoped to the thing.
- [List sites](https://docs.aerovy.com/api-reference/sites/get-sites.md): Lists the sites for the calling organization. Requires an API key with the read action.
- [Create a site](https://docs.aerovy.com/api-reference/sites/post-sites.md): Creates a new site. Requires an API key with the write action.
- [Get a site](https://docs.aerovy.com/api-reference/sites/get-sites-placeid.md): Returns a single site by id. Requires an API key with the read action scoped to the site.
- [Update a site](https://docs.aerovy.com/api-reference/sites/patch-sites-placeid.md): Updates a site's metadata. Requires an API key with the write action scoped to the site.
- [Soft-delete a site](https://docs.aerovy.com/api-reference/sites/delete-sites-placeid.md): Requires an API key with the write action scoped to the site. Fails if the site still has things, or if a sole-site simulation references it.
- [Preview a site deletion](https://docs.aerovy.com/api-reference/sites/get-sites-placeid-delete-preview.md): Lists the dependent entities a force-delete of this site would remove. Requires an API key with the read action scoped to the site.
- [Force-delete a site](https://docs.aerovy.com/api-reference/sites/delete-sites-placeid-force.md): Destructive: removes the site along with its dependent resources — its things, place-scoped monitors, and sole-site simulations.
- [List fleets](https://docs.aerovy.com/api-reference/fleets/get-fleets.md): Lists the fleets for the calling organization. Requires an API key with the read action.
- [Create a fleet](https://docs.aerovy.com/api-reference/fleets/post-fleets.md): Creates a new fleet. Requires an API key with the write action.
- [Get a fleet](https://docs.aerovy.com/api-reference/fleets/get-fleets-placeid.md): Returns a single fleet by id. Requires an API key with the read action scoped to the fleet.
- [Update a fleet](https://docs.aerovy.com/api-reference/fleets/patch-fleets-placeid.md): Updates a fleet's metadata. Requires an API key with the write action scoped to the fleet.
- [Soft-delete a fleet](https://docs.aerovy.com/api-reference/fleets/delete-fleets-placeid.md): Requires an API key with the write action scoped to the fleet. Fails if the fleet still has things, or if a sole-fleet simulation references it.
- [Ingest thing data](https://docs.aerovy.com/api-reference/ingestion/post-thing-thingid-data.md): Writes one or more timestamped data frames for a thing.
- [Ingest thing data (compact columnar)](https://docs.aerovy.com/api-reference/ingestion/post-thing-thingid-data-columnar.md): A space-efficient alternative to POST /v2/thing/{thingId}/data for high-volume or wide payloads.
- [Ingest thing data via a template](https://docs.aerovy.com/api-reference/ingestion/post-thing-thingid-data-template-templateid.md): Ingests a raw third-party JSON payload for a thing, mapping it through the given template onto the thing's metric definitions and writing the result to…
- [Get a fleet's monitor count](https://docs.aerovy.com/api-reference/timeseries/get-fleets-placeid-monitor-count.md): Returns the count of data points across all monitors in a fleet over a time range. Requires an API key with the read action scoped to the fleet.
- [Get a fleet's summary](https://docs.aerovy.com/api-reference/timeseries/get-fleets-placeid-summary.md): Returns the aggregated summary for an entire fleet over a time range. Requires an API key with the read action scoped to the fleet.
- [Get a fleet's metric summary](https://docs.aerovy.com/api-reference/timeseries/get-fleets-placeid-summary-metrics.md): Returns the aggregated summary for specific metrics across a fleet (max 20 metrics). Requires an API key with the read action scoped to the fleet.
- [Get a fleet's binned timeseries](https://docs.aerovy.com/api-reference/timeseries/get-fleets-placeid-timeseries.md): Returns the binned time-series for an entire fleet. Requires an API key with the read action scoped to the fleet.
- [Get a fleet's metric timeseries](https://docs.aerovy.com/api-reference/timeseries/get-fleets-placeid-timeseries-metrics.md): Returns the binned time-series for specific metrics across a fleet (max 20 metrics). Requires an API key with the read action scoped to the fleet.
- [Get a site's monitor count](https://docs.aerovy.com/api-reference/timeseries/get-sites-placeid-monitor-count.md): Returns the count of data points across all monitors in a site over a time range. Requires an API key with the read action scoped to the site.
- [Get a site's summary](https://docs.aerovy.com/api-reference/timeseries/get-sites-placeid-summary.md): Returns the aggregated summary for an entire site over a time range. Requires an API key with the read action scoped to the site.
- [Get a site's metric summary](https://docs.aerovy.com/api-reference/timeseries/get-sites-placeid-summary-metrics.md): Returns the aggregated summary for specific metrics across a site (max 20 metrics). Requires an API key with the read action scoped to the site.
- [Get a site's binned timeseries](https://docs.aerovy.com/api-reference/timeseries/get-sites-placeid-timeseries.md): Returns the binned time-series for an entire site. Requires an API key with the read action scoped to the site.
- [Get a site's metric timeseries](https://docs.aerovy.com/api-reference/timeseries/get-sites-placeid-timeseries-metrics.md): Returns the binned time-series for specific metrics across a site (max 20 metrics). Requires an API key with the read action scoped to the site.
- [Get a thing's data-point count](https://docs.aerovy.com/api-reference/timeseries/get-things-thingid-count.md): Returns the count of data points for a thing over a time range. Requires an API key with the read action scoped to the thing.
- [Get a thing's events](https://docs.aerovy.com/api-reference/timeseries/get-things-thingid-events.md): Requires an API key with the read action scoped to the thing. binUnit and binValue must be provided together (binned) or both omitted (raw).
- [Get a thing's latest event](https://docs.aerovy.com/api-reference/timeseries/get-things-thingid-latest-event.md): Returns the single latest event for a thing. Requires an API key with the read action scoped to the thing.
- [Get a thing's latest event time](https://docs.aerovy.com/api-reference/timeseries/get-things-thingid-latest-event-time.md): Returns the timestamp of the latest event for a thing. Requires an API key with the read action scoped to the thing.
- [Get a thing's recent data](https://docs.aerovy.com/api-reference/timeseries/get-things-thingid-recent-data.md): Returns recent data points for a thing (unbounded lookback to an optional cutoff). Requires an API key with the read action scoped to the thing.
- [Get a thing's recent events](https://docs.aerovy.com/api-reference/timeseries/get-things-thingid-recent-events.md): Returns the most recent N events for a thing (bounded lookback). Requires an API key with the read action scoped to the thing.
- [Get a thing's summary](https://docs.aerovy.com/api-reference/timeseries/get-things-thingid-summary.md): Returns aggregated summary values for a thing over a time range (no binning). Requires an API key with the read action scoped to the thing.
- [Get a thing's binned timeseries](https://docs.aerovy.com/api-reference/timeseries/get-things-thingid-timeseries.md): Returns the binned time-series for a thing over a time range. Requires an API key with the read action scoped to the thing.
- [List integrations](https://docs.aerovy.com/api-reference/integrations/get-integrations.md): Lists the integrations for the calling organization. Requires an API key with the read action.
- [Create an integration](https://docs.aerovy.com/api-reference/integrations/post-integrations.md): Creates a new integration. Requires an API key with the write action.
- [List integrations by direction](https://docs.aerovy.com/api-reference/integrations/get-integrations-direction-integrationdirection.md): Lists integrations of a given direction (INGRESS or EGRESS). Requires an API key with the read action.
- [List integrations by direction and type](https://docs.aerovy.com/api-reference/integrations/get-integrations-direction-integrationdirection-type-integrationtype.md): Lists integrations of a given direction and type. Requires an API key with the read action.
- [Get the integration mapping](https://docs.aerovy.com/api-reference/integrations/get-integrations-mapping.md): Returns all supported ingress/egress integration types and their valid resources for the caller's organization. Requires an API key with the read action.
- [Get integration properties](https://docs.aerovy.com/api-reference/integrations/get-integrations-properties.md): Returns the property descriptors for each integration type for the caller's organization, each enriched with a wildcarded pathTemplate.
- [Create a resource mapping](https://docs.aerovy.com/api-reference/integrations/post-integrations-resource-mappings.md): Creates an integration resource mapping. Requires an API key with the write action.
- [Get a resource mapping by third-party ids](https://docs.aerovy.com/api-reference/integrations/get-integrations-resource-mappings-thirdpartyid-resourcethirdpartyid.md): Looks up a resource mapping by its third-party ids, scoped to the caller's tenant and organization. Requires an API key with the read action.
- [List resources for a path](https://docs.aerovy.com/api-reference/integrations/get-integrations-resources.md): Returns the Graph resources pointed to by a resource path. Requires an API key with the read action.
- [Validate a resource path](https://docs.aerovy.com/api-reference/integrations/get-integrations-validate-path.md): Returns whether the provided resource path is valid for the caller's organization. Requires an API key with the read action.
- [Get an integration](https://docs.aerovy.com/api-reference/integrations/get-integrations-integrationid.md): Returns a single integration by id. Requires an API key with the read action scoped to the integration.
- [Update an integration](https://docs.aerovy.com/api-reference/integrations/patch-integrations-integrationid.md): Updates an integration's name, properties, and metadata. Requires an API key with the write action scoped to the integration.
- [Delete an integration](https://docs.aerovy.com/api-reference/integrations/delete-integrations-integrationid.md): Deletes an integration. Requires an API key with the write action scoped to the integration.
- [List an integration's resource mappings](https://docs.aerovy.com/api-reference/integrations/get-integrations-integrationid-resource-mappings.md): Returns all resource mappings for an integration. Requires an API key with the read action scoped to the integration.
- [Get an integration resource mapping](https://docs.aerovy.com/api-reference/integrations/get-integrations-integrationid-resource-mappings-resourceid.md): Returns a single resource mapping. Requires an API key with the read action scoped to the integration.
- [Delete a resource mapping](https://docs.aerovy.com/api-reference/integrations/delete-integrations-integrationid-resource-mappings-resourceid.md): Deletes an integration resource mapping. Requires an API key with the write action scoped to the integration.