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

# Versioning

> How VMArea versions the Public API and what backwards-compatibility guarantees you can rely on.

## Path-based versioning

The VMArea Public API uses path-based versioning. All current endpoints are under:

```
https://api.vmarea.com/api/public/v1/
```

The version segment is part of every URL. There is no content-negotiation or header-based version selection.

## Backwards-compatibility policy

Within a major version (`v1`), VMArea commits to **additive-only changes**:

* New optional request fields may be added.
* New response fields may be added (design your client to ignore unknown fields).
* New endpoints may be added.
* New event types may be added to the webhook event list.

**Breaking changes** — removal of fields, changed field types, renamed endpoints, changed authentication behavior — will only be introduced in a new major version (`v2`, etc.).

When a new major version is released, the previous version will be supported for a **minimum of 6 months** from the announcement date, giving you time to migrate. Deprecation timelines are announced in the changelog.

<AccordionGroup>
  <Accordion title="What counts as a breaking change?">
    Removing a field from a response, changing a field's type, renaming or removing an endpoint, or altering authentication behavior. Adding new fields to responses, new optional request parameters, or new endpoints are not considered breaking changes.
  </Accordion>

  <Accordion title="How will I be notified of deprecations?">
    Deprecation notices will be published in the changelog at [docs.vmarea.com](https://docs.vmarea.com) with a minimum 6-month migration window before the deprecated version is retired.
  </Accordion>

  <Accordion title="Can I pin to a specific minor version?">
    No. There are no minor-version selectors. The URL path only carries the major version (`v1`). Additive changes are deployed continuously and are designed to be safe for existing clients.
  </Accordion>
</AccordionGroup>

## Changelog

Coming soon. Changelog entries will be published at [docs.vmarea.com](https://docs.vmarea.com) when available.