Puppet

Puppet provides infrastructure automation and configuration management for hybrid and cloud environments. Puppet Enterprise exposes a collection of service APIs (Orchestrator, RBAC, Node Classifier, Code Manager, Activity, Status, Inventory, Value) that enable programmatic management of nodes, users, classifications, code deployments, and operational events.

9 APIs 0 Features

AutomationConfiguration ManagementDevOpsEnterpriseInfrastructure as CodeOrchestrationRBAC

APIs

Puppet Enterprise Orchestrator API

The Orchestrator API enables you to gather details about orchestrator jobs you run and inspect application instances. It powers running tasks and orchestration workflows across ...

Puppet Enterprise RBAC Service API

The RBAC Service API manages access to PE, generates authentication tokens, and provides user, role, group, and permission management. v2 adds user retrieval with filters, token...

Puppet Enterprise Node Classifier Service API

The Node Classifier API enables querying node group matches, assigned classes and parameters, and environment assignments. Used to manage how nodes are classified and configured.

Puppet Enterprise Code Manager API

The Code Manager API supports webhook creation, deployment queueing, and status monitoring for Puppet code, enabling Git-driven control of Puppet environments.

Puppet Enterprise Activity Service API

The Activity Service API queries PE service and user events logged by the activity service, supporting audit and operational visibility.

Puppet Enterprise Status API

The Status API checks the health status of PE services.

Puppet Enterprise Node Inventory API

The Node Inventory API manages inventory service database operations including connection entries and listings.

Puppet Enterprise Value API

The Value API generates automation impact reports on time and cost savings.

Puppet Forge

Puppet Forge is the public module repository providing thousands of downloadable Puppet modules.

Collections

Puppet Enterprise Orchestrator API

OPEN

Pricing Plans

Puppet Plans Pricing

3 plans

PLANS

Rate Limits

Puppet Rate Limits

5 limits

RATE LIMITS

FinOps

Puppet Finops

FINOPS

Resources

GitHubOrganization

Sources

opencollection: 1.0.0
info:
  name: Puppet Enterprise Orchestrator API
  version: v1
request:
  auth:
    type: apikey
    key: X-Authentication
    value: '{{X-Authentication}}'
    placement: header
items:
- info:
    name: Commands
    type: folder
  items:
  - info:
      name: Run Puppet on demand
      type: http
    http:
      method: POST
      url: https://{pe_host}:8143/orchestrator/v1/command/deploy
      body:
        type: json
        data: '{}'
    docs: Executes a Puppet run on the specified scope of nodes.
  - info:
      name: Run a task
      type: http
    http:
      method: POST
      url: https://{pe_host}:8143/orchestrator/v1/command/task
      body:
        type: json
        data: '{}'
    docs: Executes a Puppet task across the specified nodes.
  - info:
      name: Create a task target
      type: http
    http:
      method: POST
      url: https://{pe_host}:8143/orchestrator/v1/command/task_target
      body:
        type: json
        data: '{}'
    docs: Defines a task and node/group target combination for privilege-escalated execution.
  - info:
      name: Run a plan
      type: http
    http:
      method: POST
      url: https://{pe_host}:8143/orchestrator/v1/command/plan_run
      body:
        type: json
        data: '{}'
    docs: Executes a Puppet plan.
  - info:
      name: Run a plan in an environment
      type: http
    http:
      method: POST
      url: https://{pe_host}:8143/orchestrator/v1/command/environment_plan_run
      body:
        type: json
        data: '{}'
    docs: Executes a Puppet plan within a specified environment.
  - info:
      name: Stop a job
      type: http
    http:
      method: POST
      url: https://{pe_host}:8143/orchestrator/v1/command/stop
      body:
        type: json
        data: '{}'
    docs: Halts a currently executing orchestrator job.
  - info:
      name: Stop a plan job
      type: http
    http:
      method: POST
      url: https://{pe_host}:8143/orchestrator/v1/command/stop_plan
      body:
        type: json
        data: '{}'
    docs: Halts a currently executing plan job.
- info:
    name: Jobs
    type: folder
  items:
  - info:
      name: List jobs
      type: http
    http:
      method: GET
      url: https://{pe_host}:8143/orchestrator/v1/jobs
    docs: Retrieves details about all known orchestrator jobs.
  - info:
      name: Get a job
      type: http
    http:
      method: GET
      url: https://{pe_host}:8143/orchestrator/v1/jobs/:job_id
      params:
      - name: job_id
        value: ''
        type: path
        description: Orchestrator job identifier.
    docs: Retrieves details about a specific job.
  - info:
      name: List nodes for a job
      type: http
    http:
      method: GET
      url: https://{pe_host}:8143/orchestrator/v1/jobs/:job_id/nodes
      params:
      - name: job_id
        value: ''
        type: path
        description: Orchestrator job identifier.
    docs: Retrieves information about the nodes associated with a specific job.
  - info:
      name: Job summary report
      type: http
    http:
      method: GET
      url: https://{pe_host}:8143/orchestrator/v1/jobs/:job_id/report
      params:
      - name: job_id
        value: ''
        type: path
        description: Orchestrator job identifier.
    docs: Retrieves a summary report for the specified job.
  - info:
      name: Job events
      type: http
    http:
      method: GET
      url: https://{pe_host}:8143/orchestrator/v1/jobs/:job_id/events
      params:
      - name: job_id
        value: ''
        type: path
        description: Orchestrator job identifier.
    docs: Retrieves a list of events that occurred during the specified job.
bundled: true