REST API

Launch forms and manage AnsibleForms from scripts

---

Everything the web interface does goes through the REST API, so scripts and other tools can do the same.

Overview

The API is served under /api/v2 on the AnsibleForms server:

• Interactive documentation : every endpoint is described, and can be tried, at /api/v2/docs (Swagger).
• Permissions : a call runs as the user whose token it carries, with that user’s roles, as in the browser.
• Launch validation : jobs launched through the API can be checked like browser launches (see Launch validation).

In this section

Each topic has a page of its own:

• Authentication : log in, refresh the token, or use a long-lived token
• Jobs : launch a form, follow the job, abort, relaunch or approve it
• Responses and errors : the shape of a response, and the status codes