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 Commands API

Command specific endpoints

Virtual Peaker Commands 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 Commands. 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 3 operations across 2 paths, and defines 3 schemas. It is described by OpenAPI 3.2.0, at version 2.0.6.

Requests are made against a single base URL, https://example.com.

3 operations 2 paths 3 schemas 1 DELETE1 GET1 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
Authentication
OAuth 2.0, OAuth 2.0
License
BSD
Resource Areas
1

Authentication & Security 2

Virtual Peaker Commands API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (device_partner_api_auth) using the clientCredentials flow, exposing 1 scope. It supports OAuth 2.0 (device_partner_user_auth) using the authorizationCode flow, exposing 1 scope. By default, every request must be authenticated.

  • device_partner_user_auth — If using the OAuth onboarding method, this authentication method is used for the respective endpoints. Please the the FAQ for more details.

Paths & Operations 3

Across 2 paths, the API surfaces 3 operations — 1 DELETE, 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Commands 3

Command specific endpoints

POST
/command
Send command
sendCommand body → 200400401default
GET
/command/{COMMAND_REFERENCE_ID}
Read command state
readCommandState 1 param → 200400401default
DELETE
/command/{COMMAND_REFERENCE_ID}
Cancel command
cancelCommand 1 param → 200400401default

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are CommandState (4 properties), Details (1 property). Each schema is shown below with its type and property counts.

Details
object
1 property 1 required
DeviceKindEnum
string
CommandState
object
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Virtual Peaker publishes across the network.

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
Virtual Peaker Publishing API
Where this information came from

This is an independent, third-party profile of Virtual Peaker Commands 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.