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

Puppet Commands API

POST endpoints that trigger orchestrator actions.

Puppet Commands API is one of 15 APIs that Puppet 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.

This API exposes 7 operations across 7 paths, and defines 1 schema. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://{pe_host}:8143/orchestrator/v1.

7 operations 7 paths 1 schemas 7 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Server
https://{pe_host}:8143/orchestrator/v1
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Puppet Commands API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Authentication (rbacToken). By default, every request must be authenticated.

  • rbacToken — Puppet Enterprise RBAC user authentication token. May be retrieved via puppet-access show. Required on every request.

Paths & Operations 7

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

Commands 7

POST endpoints that trigger orchestrator actions.

POST
/command/deploy
Run Puppet on demand
commandDeploy body → 202401
POST
/command/task
Run a task
commandTask body → 202401
POST
/command/task_target
Create a task target
commandTaskTarget body → 200401
POST
/command/plan_run
Run a plan
commandPlanRun body → 202401
POST
/command/environment_plan_run
Run a plan in an environment
commandEnvironmentPlanRun body → 202401
POST
/command/stop
Stop a job
commandStop body → 202401
POST
/command/stop_plan
Stop a plan job
commandStopPlan body → 202401

Schemas 1

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

CommandRequest
object
Generic orchestrator command request body. The exact shape varies per command (environment, scope, task, planname, parameters, etc.).
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

puppet-commands-api-openapi.yml Raw ↑

Other APIs Puppet publishes across the network.

Puppet Enterprise Orchestrator API
Puppet Enterprise RBAC Service API
Puppet Enterprise Node Classifier Service API
Puppet Enterprise Code Manager API
Puppet Enterprise Activity Service API
Puppet Enterprise Status API
Puppet Enterprise Node Inventory API
Puppet Enterprise Value API
Puppet Forge
Puppet Jobs API
Puppet Module Operations API
Puppet Release Operations API
Where this information came from

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