API Information

Integrate with your existing infrastructure

PPA Your Infrastructure

Fits Your Workflow
Use PPA as part of a wider business process.
Widen Your Reach
Extend the capabilities of your existing platforms by calling out to PPA tasks.
Go Interactive
Start a background task over the API and have a human take over if things go wrong.

A Powerful API

Automate PPA
Trigger tasks from any other system.
API First
PPA looks and works the same to both humans and robots.
Devops Friendly
Call a PPA task from your existing scripts with a single HTTP request.

curl -H 'Authorization: Bearer ...' 'https://ppa.example/backend/v1/rest/images?author=eq.Osirium&limit=1'

[
  {
    "uuid": "58407167-e2cc-4f83-9576-1af1eeccf33a",
    "id": 1,
    "name": "Untagged Instance Report",
    "description": "List any EC2 instances that don't have a tag",
    "hash": "sha256:7b07b64698221f9e087bdd9c18cab446737bea0ea7aa1f5fc47bda199a9f2423",
    "author": "Osirium",
    "tag": "1",
    "tags": [
      "Interactive",
      "API",
      "Schedule",
      "Cloud"
    ],
    "updated_at": "2020-08-14T14:40:30.832021+00:00",
    "icon": null,
    "has_yaml": true,
    "deployed": true,
    "latest": {
      "id": 1,
      "tag": "1"
    },
    "total_revisions": 1,
    "is_owner": true,
    "is_delegate": false,
    "os": "linux",
    "agent": "PPA Appliance",
    "available": true,
    "groups": 0,
    "owner": "admin"
  }
]

See our Swagger docs for a complete reference.

Get PPA for free!

Start automating your estate with a free 30 day trial today. No signup required!

Get PPA Express

Documentation

Installation Guide
See how easy it is to get started with our installation guide
Playbooks
View our task writing reference guide
Plugins
See how to integrate with different systems using our plugins reference guide.