How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Virtual Peaker Publishing API

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.

Virtual Peaker Publishing API is one of 8 APIs that Virtual Peaker publishes on the 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.

This API exposes 5 operations across 5 paths, and defines 7 schemas. It is described by OpenAPI 3.2.0, at version 2.0.6.

Requests are made against a single base URL, https://partner.virtualpeaker.io/v1.

5 operations 5 paths 7 schemas 5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0.6
Base URL
https://partner.virtualpeaker.io/v1
License
BSD
Resource Areas
1

Paths & Operations 5

Across 5 paths, the API surfaces 5 operations — 5 POST. Each is listed below with its method, path, parameters, and response codes.

Publishing 5

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…

POST
/publish/{PROGRAM_PUBLISH_KEY}/update
Publish signal/setting value
publishSignalSetting 2 params body → 202400401default
POST
/publish/{PROGRAM_PUBLISH_KEY}/command
Publish command status
publishCommand 2 params body → 202400401default
POST
/publish/{PROGRAM_PUBLISH_KEY}/command/device
Publish device command status
publishDeviceCommand 2 params body → 202400401default
POST
/publish/{PROGRAM_PUBLISH_KEY}/device
Publish device enrollment status
publishDeviceEnrollment 2 params body → 202400401default
POST
/publish/{PROGRAM_PUBLISH_KEY}/enrollment
Publish device partner driven enrollment
publishDevicePartnerDrivenEnrollment 2 params body → 202400401default

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are UserDetails (6 properties), ServiceAddress (6 properties), DeviceDetails (5 properties), CommandState (4 properties). Each schema is shown below with its type and property counts.

Details
object
1 property 1 required
SignalSetting
object
3 properties 3 required
DeviceDetails
object
5 properties 3 required
DeviceKindEnum
string
ServiceAddress
object
Service address associated with the user account. Optional, but strongly recommended.
6 properties
UserDetails
object
6 properties 1 required
CommandState
object
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

virtual-peaker-publishing-api-openapi.yml Raw ↑

Other APIs Virtual Peaker publishes across the network.

Virtual Peaker Commands API
Virtual Peaker Devices API
Virtual Peaker Energy Interval Endpoint API
Virtual Peaker Group Management API
Virtual Peaker OAuth Device Discovery (Preferred) API
Virtual Peaker Pairing Code Device Discovery - End User App API
Virtual Peaker Pairing Code Device Discovery - Utility Commissioned Installation API
Where this information came from

This is an independent, third-party profile of Virtual Peaker Publishing API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.