# Virtual Peaker Publishing API

**Canonical:** https://apis.io/apis/virtual-peaker/virtual-peaker-publishing-api/  
**Provider:** Virtual Peaker — https://apis.io/providers/virtual-peaker/  
**Base URL:** https://partner.virtualpeaker.io/v1  
**Documentation:** https://assets.virtualpeaker.io/gravity-connect/device-partner-api.html

Virtual Peaker Publishing API is one of 8 APIs that [Virtual Peaker](https://apis.io/providers/virtual-peaker/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Publishing. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, an engineering blog, and a getting-started guide.

All of the endpoints below allow the Device Partner to publish data to the Virtual Peaker platform, which avoids Virtual Peaker having to constantly poll the data when there haven't been any changes. Part of the [Device Partner Implementation](example.com) does include endpoint to read poll for data, which could be used by Virtual Peaker to gather the first batch of data or for debugging. **Notes:** - The maximum supported payload size for all requests listed below is 262,144 bytes.

## Operations (5)

| Method | Path | Summary |
|---|---|---|
| POST | `/publish/{PROGRAM_PUBLISH_KEY}/update` | Publish signal/setting value |
| POST | `/publish/{PROGRAM_PUBLISH_KEY}/command` | Publish command status |
| POST | `/publish/{PROGRAM_PUBLISH_KEY}/command/device` | Publish device command status |
| POST | `/publish/{PROGRAM_PUBLISH_KEY}/device` | Publish device enrollment status |
| POST | `/publish/{PROGRAM_PUBLISH_KEY}/enrollment` | Publish device partner driven enrollment |

## Machine-readable artifacts (9)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/virtual-peaker/refs/heads/main/openapi/virtual-peaker-publishing-api-openapi.yml
- **APIReference** — https://assets.virtualpeaker.io/gravity-connect/device-partner-api.html
- **Documentation** — https://virtual-peaker.com/partners/device-partners/
- **Blog** — https://virtual-peaker.com/blog/gravity-connect-api-oem-derms-integrations/
- **GettingStarted** — https://assets.virtualpeaker.io/gravity-connect/device-partner-api.html#section/Getting-Started
- **APIReference** — https://assets.virtualpeaker.io/gravity-connect/vp-api.html
- **Documentation** — https://virtual-peaker.com/apis/
- **Blog** — https://virtual-peaker.com/blog/gravity-connect-v-openadr/
- **Webhooks** — https://raw.githubusercontent.com/api-evangelist/virtual-peaker/refs/heads/main/asyncapi/virtual-peaker-gravity-connect-webhooks.yml

## Other Virtual Peaker APIs (7)

- [Virtual Peaker Commands API](https://apis.io/apis/virtual-peaker/virtual-peaker-commands-api/)
- [Virtual Peaker Devices API](https://apis.io/apis/virtual-peaker/virtual-peaker-devices-api/)
- [Virtual Peaker Energy Interval Endpoint API](https://apis.io/apis/virtual-peaker/virtual-peaker-energy-interval-endpoint-api/)
- [Virtual Peaker Group Management API](https://apis.io/apis/virtual-peaker/virtual-peaker-group-management-api/)
- [Virtual Peaker OAuth Device Discovery (Preferred) API](https://apis.io/apis/virtual-peaker/virtual-peaker-oauth-device-discovery-preferred-api/)
- [Virtual Peaker Pairing Code Device Discovery - End User App API](https://apis.io/apis/virtual-peaker/virtual-peaker-pairing-code-device-discovery-end-user-app-api/)
- [Virtual Peaker Pairing Code Device Discovery - Utility Commissioned Installation API](https://apis.io/apis/virtual-peaker/virtual-peaker-pairing-code-device-discovery-utility-commissioned-installation-api/)

## Tags

Publishing

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/virtual-peaker/virtual-peaker-publishing-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/virtual-peaker/.