{
  "opencollection": "1.0.0",
  "info": {
    "name": "Puppet Enterprise Orchestrator Commands 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."
        }
      ]
    }
  ],
  "bundled": true
}