Documentation

11. Controller API Reference Guide

The automation controller API Reference Manual provides in-depth documentation for Red Hat Ansible Automation Platform’s controller REST API, including examples on how to integrate with it.

Swagger UIswagger

Ansible Automation Platform controller API

Versioning

GET/api/
List supported API versions
GET/api/v2/
List top level resources

Authentication

GET/api/o/
Token Handling using OAuth2
GET/api/v2/applications/
List Applications
POST/api/v2/applications/
Create an Application
GET/api/v2/applications/{id}/
Retrieve an Application
PUT/api/v2/applications/{id}/
Update an Application
PATCH/api/v2/applications/{id}/
Update an Application
DELETE/api/v2/applications/{id}/
Delete an Application
GET/api/v2/applications/{id}/activity_stream/
List Activity Streams for an Application
GET/api/v2/applications/{id}/tokens/
List Access Tokens for an Application
POST/api/v2/applications/{id}/tokens/
Create an Access Token for an Application
GET/api/v2/tokens/
List Access Tokens
POST/api/v2/tokens/
Create an Access Token
GET/api/v2/tokens/{id}/
Retrieve an Access Token
PUT/api/v2/tokens/{id}/
Update an Access Token
PATCH/api/v2/tokens/{id}/
Update an Access Token
DELETE/api/v2/tokens/{id}/
Delete an Access Token
GET/api/v2/tokens/{id}/activity_stream/
List Activity Streams for an Access Token

Instances

GET/api/v2/instances/
List Instances
GET/api/v2/instances/{id}/
Retrieve an Instance
PUT/api/v2/instances/{id}/
Update an Instance
PATCH/api/v2/instances/{id}/
Update an Instance
GET/api/v2/instances/{id}/instance_groups/
List Instance Groups for an Instance
POST/api/v2/instances/{id}/instance_groups/
Create an Instance Group for an Instance
GET/api/v2/instances/{id}/jobs/
List Unified Jobs for an Instance

Instance Groups

GET/api/v2/instance_groups/
List Instance Groups
POST/api/v2/instance_groups/
Create an Instance Group
GET/api/v2/instance_groups/{id}/
Retrieve an Instance Group
PUT/api/v2/instance_groups/{id}/
Update an Instance Group
PATCH/api/v2/instance_groups/{id}/
Update an Instance Group
DELETE/api/v2/instance_groups/{id}/
Delete an Instance Group
GET/api/v2/instance_groups/{id}/instances/
List Instances for an Instance Group
POST/api/v2/instance_groups/{id}/instances/
Create an Instance for an Instance Group
GET/api/v2/instance_groups/{id}/jobs/
List Unified Jobs for an Instance Group

System Configuration

GET/api/v2/auth/
List enabled single-sign-on endpoints
GET/api/v2/config/
Return various sitewide configuration settings
POST/api/v2/config/
POST/api/v2/config/attach/
POST/api/v2/config/subscriptions/
GET/api/v2/ping/
Return some basic information about this instance

Settings

GET/api/v2/settings/
List Settings
GET/api/v2/settings/{category_slug}/
Retrieve a Setting
PATCH/api/v2/settings/{category_slug}/
Update a Setting
DELETE/api/v2/settings/{category_slug}/
Delete a Setting
POST/api/v2/settings/logging/test/
Test Logging Configuration

Dashboard

GET/api/v2/dashboard/
Show Dashboard Details
GET/api/v2/dashboard/graphs/jobs/
View Statistics for Job Runs

Organizations

GET/api/v2/organizations/
List Organizations
POST/api/v2/organizations/
Create an Organization
GET/api/v2/organizations/{id}/
Retrieve an Organization
PUT/api/v2/organizations/{id}/
Update an Organization
PATCH/api/v2/organizations/{id}/
Update an Organization
DELETE/api/v2/organizations/{id}/
Delete an Organization
GET/api/v2/organizations/{id}/activity_stream/
List Activity Streams for an Organization
GET/api/v2/organizations/{id}/admins/
List Admin Users for an Organization
POST/api/v2/organizations/{id}/admins/
Create an Admin User for an Organization
GET/api/v2/organizations/{id}/applications/
List Applications for an Organization
POST/api/v2/organizations/{id}/applications/
Create an Application for an Organization
GET/api/v2/organizations/{id}/credentials/
List Credentials for an Organization
POST/api/v2/organizations/{id}/credentials/
Create a Credential for an Organization
GET/api/v2/organizations/{id}/execution_environments/
List Execution Environments for an Organization
POST/api/v2/organizations/{id}/execution_environments/
Create an Execution Environment for an Organization
GET/api/v2/organizations/{id}/galaxy_credentials/
List Credentials for an Organization
POST/api/v2/organizations/{id}/galaxy_credentials/
Create a Credential for an Organization
GET/api/v2/organizations/{id}/instance_groups/
List Instance Groups for an Organization
POST/api/v2/organizations/{id}/instance_groups/
Create an Instance Group for an Organization
GET/api/v2/organizations/{id}/inventories/
List Inventories for an Organization
GET/api/v2/organizations/{id}/job_templates/
List Job Templates for an Organization
POST/api/v2/organizations/{id}/job_templates/
Create a Job Template for an Organization
GET/api/v2/organizations/{id}/notification_templates_approvals/
List Notification Templates for an Organization
POST/api/v2/organizations/{id}/notification_templates_approvals/
Create a Notification Template for an Organization
GET/api/v2/organizations/{id}/notification_templates_error/
List Notification Templates for an Organization
POST/api/v2/organizations/{id}/notification_templates_error/
Create a Notification Template for an Organization
GET/api/v2/organizations/{id}/notification_templates_started/
List Notification Templates for an Organization
POST/api/v2/organizations/{id}/notification_templates_started/
Create a Notification Template for an Organization
GET/api/v2/organizations/{id}/notification_templates_success/
List Notification Templates for an Organization
POST/api/v2/organizations/{id}/notification_templates_success/
Create a Notification Template for an Organization
GET/api/v2/organizations/{id}/notification_templates/
List Notification Templates for an Organization
POST/api/v2/organizations/{id}/notification_templates/
Create a Notification Template for an Organization
GET/api/v2/organizations/{id}/object_roles/
List Roles for an Organization
GET/api/v2/organizations/{id}/projects/
List Projects for an Organization
POST/api/v2/organizations/{id}/projects/
Create a Project for an Organization
GET/api/v2/organizations/{id}/teams/
List Teams for an Organization
POST/api/v2/organizations/{id}/teams/
Create a Team for an Organization
GET/api/v2/organizations/{id}/users/
List Users for an Organization
POST/api/v2/organizations/{id}/users/
Create a User for an Organization
GET/api/v2/organizations/{id}/workflow_job_templates/
List Workflow Job Templates for an Organization
POST/api/v2/organizations/{id}/workflow_job_templates/
Create a Workflow Job Template for an Organization

Users

GET/api/v2/me/
Retrieve Information about the current User
GET/api/v2/users/
List Users
POST/api/v2/users/
Create a User
GET/api/v2/users/{id}/
Retrieve a User
PUT/api/v2/users/{id}/
Update a User
PATCH/api/v2/users/{id}/
Update a User
DELETE/api/v2/users/{id}/
Delete a User
GET/api/v2/users/{id}/activity_stream/
List Activity Streams for a User
GET/api/v2/users/{id}/admin_of_organizations/
List Organizations Administered by this User
POST/api/v2/users/{id}/applications/
Create an Application
GET/api/v2/users/{id}/authorized_tokens/
List Access Tokens for a User
POST/api/v2/users/{id}/authorized_tokens/
Create an Access Token for a User
GET/api/v2/users/{id}/credentials/
List Credentials for a User
POST/api/v2/users/{id}/credentials/
Create a Credential for a User
GET/api/v2/users/{id}/organizations/
List Organizations for a User
GET/api/v2/users/{id}/personal_tokens/
List Access Tokens for a User
POST/api/v2/users/{id}/personal_tokens/
Create an Access Token for a User
GET/api/v2/users/{id}/projects/
List Projects for a User
GET/api/v2/users/{id}/roles/
List Roles for a User
POST/api/v2/users/{id}/roles/
Associate Roles with this User
GET/api/v2/users/{id}/teams/
List Teams for a User
GET/api/v2/users/{id}/tokens/
List Access Tokens for a User
POST/api/v2/users/{id}/tokens/
Create an Access Token for a User

Projects

GET/api/v2/projects/
List Projects
POST/api/v2/projects/
Create a Project
GET/api/v2/projects/{id}/
Retrieve a Project
PUT/api/v2/projects/{id}/
Update a Project
PATCH/api/v2/projects/{id}/
Update a Project
DELETE/api/v2/projects/{id}/
Delete a Project
GET/api/v2/projects/{id}/activity_stream/
List Activity Streams for a Project
POST/api/v2/projects/{id}/copy/
GET/api/v2/projects/{id}/notification_templates_error/
List Notification Templates for a Project
POST/api/v2/projects/{id}/notification_templates_error/
Create a Notification Template for a Project
GET/api/v2/projects/{id}/notification_templates_started/
List Notification Templates for a Project
POST/api/v2/projects/{id}/notification_templates_started/
Create a Notification Template for a Project
GET/api/v2/projects/{id}/notification_templates_success/
List Notification Templates for a Project
POST/api/v2/projects/{id}/notification_templates_success/
Create a Notification Template for a Project
GET/api/v2/projects/{id}/object_roles/
List Roles for a Project
GET/api/v2/projects/{id}/playbooks/
Retrieve Project Playbooks
GET/api/v2/projects/{id}/project_updates/
List Project Updates for a Project
GET/api/v2/projects/{id}/schedules/
List Schedules for a Project
POST/api/v2/projects/{id}/schedules/
Create a Schedule for a Project
GET/api/v2/projects/{id}/scm_inventory_sources/
List Inventory Sources for a Project
POST/api/v2/projects/{id}/update/
Update Project

Project Updates

GET/api/v2/project_updates/
List Project Updates
GET/api/v2/project_updates/{id}/
Retrieve a Project Update
DELETE/api/v2/project_updates/{id}/
Delete a Project Update
GET/api/v2/project_updates/{id}/cancel/
Cancel Project Update
POST/api/v2/project_updates/{id}/cancel/
Cancel Project Update
GET/api/v2/project_updates/{id}/events/
List Project Update Events for a Project Update
GET/api/v2/project_updates/{id}/notifications/
List Notifications for a Project Update
GET/api/v2/project_updates/{id}/scm_inventory_updates/
List Inventory Updates for a Project Update
GET/api/v2/project_updates/{id}/stdout/
Retrieve Project Update Stdout

Teams

GET/api/v2/teams/
List Teams
POST/api/v2/teams/
Create a Team
GET/api/v2/teams/{id}/
Retrieve a Team
PUT/api/v2/teams/{id}/
Update a Team
PATCH/api/v2/teams/{id}/
Update a Team
DELETE/api/v2/teams/{id}/
Delete a Team
GET/api/v2/teams/{id}/activity_stream/
List Activity Streams for a Team
GET/api/v2/teams/{id}/credentials/
List Credentials for a Team
POST/api/v2/teams/{id}/credentials/
Create a Credential for a Team
GET/api/v2/teams/{id}/object_roles/
List Roles for a Team
GET/api/v2/teams/{id}/projects/
List Projects for a Team
GET/api/v2/teams/{id}/roles/
List Roles for a Team
POST/api/v2/teams/{id}/roles/
Associate Roles with this Team
GET/api/v2/teams/{id}/users/
List Users for a Team
POST/api/v2/teams/{id}/users/
Create a User for a Team

Credentials

GET/api/v2/credentials/
List Credentials
POST/api/v2/credentials/
Create a Credential
GET/api/v2/credentials/{id}/
Retrieve a Credential
PUT/api/v2/credentials/{id}/
Update a Credential
PATCH/api/v2/credentials/{id}/
Update a Credential
DELETE/api/v2/credentials/{id}/
Delete a Credential
GET/api/v2/credentials/{id}/activity_stream/
List Activity Streams for a Credential
POST/api/v2/credentials/{id}/copy/
GET/api/v2/credentials/{id}/input_sources/
List Credential Input Sources for a Credential
POST/api/v2/credentials/{id}/input_sources/
Create a Credential Input Source for a Credential
GET/api/v2/credentials/{id}/object_roles/
List Roles for a Credential
GET/api/v2/credentials/{id}/owner_teams/
List Teams for a Credential
GET/api/v2/credentials/{id}/owner_users/
List Users for a Credential
GET/api/v2/credentials/{id}/test/
Retrieve a Credential
POST/api/v2/credentials/{id}/test/
Retrieve a Credential

Credential Types

GET/api/v2/credential_types/
List Credential Types
POST/api/v2/credential_types/
Create a Credential Type
GET/api/v2/credential_types/{id}/
Retrieve a Credential Type
PUT/api/v2/credential_types/{id}/
Update a Credential Type
PATCH/api/v2/credential_types/{id}/
Update a Credential Type
DELETE/api/v2/credential_types/{id}/
Delete a Credential Type
GET/api/v2/credential_types/{id}/activity_stream/
List Activity Streams for a Credential Type
GET/api/v2/credential_types/{id}/credentials/
List Credentials for a Credential Type
POST/api/v2/credential_types/{id}/credentials/
Create a Credential for a Credential Type
GET/api/v2/credential_types/{id}/test/
Retrieve a Credential Type
POST/api/v2/credential_types/{id}/test/
Retrieve a Credential Type

Inventories

GET/api/v2/inventories/
List Inventories
POST/api/v2/inventories/
Create an Inventory
GET/api/v2/inventories/{id}/
Retrieve an Inventory
PUT/api/v2/inventories/{id}/
Update an Inventory
PATCH/api/v2/inventories/{id}/
Update an Inventory
DELETE/api/v2/inventories/{id}/
Delete an Inventory
GET/api/v2/inventories/{id}/activity_stream/
List Activity Streams for an Inventory
GET/api/v2/inventories/{id}/ad_hoc_commands/
List Ad Hoc Commands for an Inventory
POST/api/v2/inventories/{id}/ad_hoc_commands/
Create an Ad Hoc Command for an Inventory
POST/api/v2/inventories/{id}/copy/
GET/api/v2/inventories/{id}/groups/
List Groups for an Inventory
POST/api/v2/inventories/{id}/groups/
Create a Group for an Inventory
GET/api/v2/inventories/{id}/hosts/
List Hosts for an Inventory
POST/api/v2/inventories/{id}/hosts/
Create a Host for an Inventory
GET/api/v2/inventories/{id}/instance_groups/
List Instance Groups for an Inventory
POST/api/v2/inventories/{id}/instance_groups/
Create an Instance Group for an Inventory
GET/api/v2/inventories/{id}/inventory_sources/
List Inventory Sources for an Inventory
POST/api/v2/inventories/{id}/inventory_sources/
Create an Inventory Source for an Inventory
GET/api/v2/inventories/{id}/job_templates/
List Job Templates for an Inventory
GET/api/v2/inventories/{id}/object_roles/
List Roles for an Inventory
GET/api/v2/inventories/{id}/root_groups/
List Root Groups for an Inventory
POST/api/v2/inventories/{id}/root_groups/
GET/api/v2/inventories/{id}/script/
Generate inventory group and host data as needed for an inventory script.
GET/api/v2/inventories/{id}/tree/
Group Tree for an Inventory
POST/api/v2/inventories/{id}/update_inventory_sources/
Update Inventory Sources
GET/api/v2/inventories/{id}/variable_data/
Retrieve Inventory Variable Data
PUT/api/v2/inventories/{id}/variable_data/
Update Inventory Variable Data
PATCH/api/v2/inventories/{id}/variable_data/
Update Inventory Variable Data

Custom Inventory Scripts

Inventory Sources

GET/api/v2/inventory_sources/
List Inventory Sources
POST/api/v2/inventory_sources/
Create an Inventory Source
GET/api/v2/inventory_sources/{id}/
Retrieve an Inventory Source
PUT/api/v2/inventory_sources/{id}/
Update an Inventory Source
PATCH/api/v2/inventory_sources/{id}/
Update an Inventory Source
DELETE/api/v2/inventory_sources/{id}/
Delete an Inventory Source
GET/api/v2/inventory_sources/{id}/activity_stream/
List Activity Streams for an Inventory Source
GET/api/v2/inventory_sources/{id}/credentials/
List Credentials for an Inventory Source
POST/api/v2/inventory_sources/{id}/credentials/
Create a Credential for an Inventory Source
GET/api/v2/inventory_sources/{id}/groups/
List Groups for an Inventory Source
DELETE/api/v2/inventory_sources/{id}/groups/
Create a Group for an Inventory Source
GET/api/v2/inventory_sources/{id}/hosts/
List Hosts for an Inventory Source
DELETE/api/v2/inventory_sources/{id}/hosts/
Create a Host for an Inventory Source
GET/api/v2/inventory_sources/{id}/inventory_updates/
List Inventory Updates for an Inventory Source
GET/api/v2/inventory_sources/{id}/notification_templates_error/
List Notification Templates for an Inventory Source
POST/api/v2/inventory_sources/{id}/notification_templates_error/
Create a Notification Template for an Inventory Source
GET/api/v2/inventory_sources/{id}/notification_templates_started/
List Notification Templates for an Inventory Source
POST/api/v2/inventory_sources/{id}/notification_templates_started/
Create a Notification Template for an Inventory Source
GET/api/v2/inventory_sources/{id}/notification_templates_success/
List Notification Templates for an Inventory Source
POST/api/v2/inventory_sources/{id}/notification_templates_success/
Create a Notification Template for an Inventory Source
GET/api/v2/inventory_sources/{id}/schedules/
List Schedules for an Inventory Source
POST/api/v2/inventory_sources/{id}/schedules/
Create a Schedule for an Inventory Source
GET/api/v2/inventory_sources/{id}/update/
Update Inventory Source
POST/api/v2/inventory_sources/{id}/update/
Update Inventory Source

Inventory Updates

GET/api/v2/inventory_updates/
List Inventory Updates
GET/api/v2/inventory_updates/{id}/
Retrieve an Inventory Update
DELETE/api/v2/inventory_updates/{id}/
Delete an Inventory Update
GET/api/v2/inventory_updates/{id}/cancel/
Retrieve an Inventory Update
POST/api/v2/inventory_updates/{id}/cancel/
Retrieve an Inventory Update
GET/api/v2/inventory_updates/{id}/credentials/
List Credentials for an Inventory Update
GET/api/v2/inventory_updates/{id}/events/
List Inventory Update Events for an Inventory Update
GET/api/v2/inventory_updates/{id}/notifications/
List Notifications for an Inventory Update
GET/api/v2/inventory_updates/{id}/stdout/
Retrieve Inventory Update Stdout

Groups

GET/api/v2/groups/
List Groups
POST/api/v2/groups/
Create a Group
GET/api/v2/groups/{id}/
Retrieve a Group
PUT/api/v2/groups/{id}/
Update a Group
PATCH/api/v2/groups/{id}/
Update a Group
DELETE/api/v2/groups/{id}/
Delete a Group
GET/api/v2/groups/{id}/activity_stream/
List Activity Streams for a Group
GET/api/v2/groups/{id}/ad_hoc_commands/
List Ad Hoc Commands for a Group
POST/api/v2/groups/{id}/ad_hoc_commands/
Create an Ad Hoc Command for a Group
GET/api/v2/groups/{id}/all_hosts/
List All Hosts for a Group
GET/api/v2/groups/{id}/children/
List Groups for a Group
POST/api/v2/groups/{id}/children/
Create a Group for a Group
GET/api/v2/groups/{id}/hosts/
List Hosts for a Group
POST/api/v2/groups/{id}/hosts/
Create a Host for a Group
GET/api/v2/groups/{id}/inventory_sources/
List Inventory Sources for a Group
GET/api/v2/groups/{id}/job_events/
List Job Events for a Group
GET/api/v2/groups/{id}/job_host_summaries/
List Job Host Summaries for a Group
GET/api/v2/groups/{id}/potential_children/
List Potential Child Groups for a Group
GET/api/v2/groups/{id}/variable_data/
Retrieve Group Variable Data
PUT/api/v2/groups/{id}/variable_data/
Update Group Variable Data
PATCH/api/v2/groups/{id}/variable_data/
Update Group Variable Data

Hosts

GET/api/v2/hosts/
List Hosts
POST/api/v2/hosts/
`host_filter` is available on this endpoint. The filter supports: relational queries, `and` `or` boolean logic, as well as expression grouping via `()`.
GET/api/v2/hosts/{id}/
Retrieve a Host
PUT/api/v2/hosts/{id}/
Update a Host
PATCH/api/v2/hosts/{id}/
Update a Host
DELETE/api/v2/hosts/{id}/
Delete a Host
GET/api/v2/hosts/{id}/activity_stream/
List Activity Streams for a Host
GET/api/v2/hosts/{id}/ad_hoc_command_events/
List Ad Hoc Command Events for a Host
GET/api/v2/hosts/{id}/ad_hoc_commands/
List Ad Hoc Commands for a Host
POST/api/v2/hosts/{id}/ad_hoc_commands/
Create an Ad Hoc Command for a Host
GET/api/v2/hosts/{id}/all_groups/
List All Groups for a Host
GET/api/v2/hosts/{id}/groups/
List Groups for a Host
POST/api/v2/hosts/{id}/groups/
Create a Group for a Host
GET/api/v2/hosts/{id}/inventory_sources/
List Inventory Sources for a Host
GET/api/v2/hosts/{id}/job_events/
List Job Events for a Host
GET/api/v2/hosts/{id}/job_host_summaries/
List Job Host Summaries for a Host
GET/api/v2/hosts/{id}/smart_inventories/
List Inventories for a Host
GET/api/v2/hosts/{id}/variable_data/
Retrieve Host Variable Data
PUT/api/v2/hosts/{id}/variable_data/
Update Host Variable Data
PATCH/api/v2/hosts/{id}/variable_data/
Update Host Variable Data

Job Templates

GET/api/v2/job_templates/
List Job Templates
POST/api/v2/job_templates/
Create a Job Template
GET/api/v2/job_templates/{id}/
Retrieve a Job Template
PUT/api/v2/job_templates/{id}/
Update a Job Template
PATCH/api/v2/job_templates/{id}/
Update a Job Template
DELETE/api/v2/job_templates/{id}/
Delete a Job Template
GET/api/v2/job_templates/{id}/activity_stream/
List Activity Streams for a Job Template
GET/api/v2/job_templates/{id}/callback/
The job template callback allows for ephemeral hosts to launch a new job.
POST/api/v2/job_templates/{id}/callback/
The job template callback allows for ephemeral hosts to launch a new job.
POST/api/v2/job_templates/{id}/copy/
GET/api/v2/job_templates/{id}/credentials/
List Credentials for a Job Template
POST/api/v2/job_templates/{id}/credentials/
Create a Credential for a Job Template
POST/api/v2/job_templates/{id}/github/
POST/api/v2/job_templates/{id}/gitlab/
GET/api/v2/job_templates/{id}/instance_groups/
List Instance Groups for a Job Template
POST/api/v2/job_templates/{id}/instance_groups/
Create an Instance Group for a Job Template
GET/api/v2/job_templates/{id}/jobs/
List Jobs for a Job Template
GET/api/v2/job_templates/{id}/labels/
List Labels for a Job Template
POST/api/v2/job_templates/{id}/labels/
Create a Label for a Job Template
GET/api/v2/job_templates/{id}/launch/
Launch a Job Template
POST/api/v2/job_templates/{id}/launch/
Launch a Job Template
GET/api/v2/job_templates/{id}/notification_templates_error/
List Notification Templates for a Job Template
POST/api/v2/job_templates/{id}/notification_templates_error/
Create a Notification Template for a Job Template
GET/api/v2/job_templates/{id}/notification_templates_started/
List Notification Templates for a Job Template
POST/api/v2/job_templates/{id}/notification_templates_started/
Create a Notification Template for a Job Template
GET/api/v2/job_templates/{id}/notification_templates_success/
List Notification Templates for a Job Template
POST/api/v2/job_templates/{id}/notification_templates_success/
Create a Notification Template for a Job Template
GET/api/v2/job_templates/{id}/object_roles/
List Roles for a Job Template
GET/api/v2/job_templates/{id}/schedules/
List Schedules for a Job Template
POST/api/v2/job_templates/{id}/schedules/
Create a Schedule for a Job Template
GET/api/v2/job_templates/{id}/slice_workflow_jobs/
List Workflow Jobs for a Job Template
POST/api/v2/job_templates/{id}/slice_workflow_jobs/
Create a Workflow Job for a Job Template
GET/api/v2/job_templates/{id}/survey_spec/
POST requests to this resource should include the full specification for a Job Template's Survey
POST/api/v2/job_templates/{id}/survey_spec/
POST requests to this resource should include the full specification for a Job Template's Survey
DELETE/api/v2/job_templates/{id}/survey_spec/
POST requests to this resource should include the full specification for a Job Template's Survey
POST/api/v2/job_templates/{id}/webhook_key/

Jobs

GET/api/v2/jobs/
List Jobs
GET/api/v2/jobs/{id}/
Retrieve a Job Host Summary
DELETE/api/v2/jobs/{id}/
Delete a Job
GET/api/v2/jobs/{id}/activity_stream/
List Activity Streams for a Job
GET/api/v2/jobs/{id}/cancel/
Determine if a Job can be canceled
POST/api/v2/jobs/{id}/cancel/
Cancel a Job
GET/api/v2/jobs/{id}/create_schedule/
Create a schedule based on a job
POST/api/v2/jobs/{id}/create_schedule/
Create a schedule based on a job
GET/api/v2/jobs/{id}/credentials/
List Credentials for a Job
GET/api/v2/jobs/{id}/job_events/
List Job Events for a Job
GET/api/v2/jobs/{id}/job_host_summaries/
List Job Host Summaries for a Job
GET/api/v2/jobs/{id}/labels/
List Labels for a Job
GET/api/v2/jobs/{id}/notifications/
List Notifications for a Job
GET/api/v2/jobs/{id}/relaunch/
Relaunch a Job
POST/api/v2/jobs/{id}/relaunch/
Relaunch a Job
GET/api/v2/jobs/{id}/stdout/
Retrieve Job Stdout

Job Events

GET/api/v2/job_events/{id}/
Retrieve a Job Event
GET/api/v2/job_events/{id}/children/
List Job Events for a Job Event

Job Host Summaries

GET/api/v2/job_host_summaries/{id}/
Retrieve a Job Host Summary

Ad Hoc Commands

GET/api/v2/ad_hoc_commands/
List Ad Hoc Commands
POST/api/v2/ad_hoc_commands/
Create an Ad Hoc Command
GET/api/v2/ad_hoc_commands/{id}/
Retrieve an Ad Hoc Command
DELETE/api/v2/ad_hoc_commands/{id}/
Delete an Ad Hoc Command
GET/api/v2/ad_hoc_commands/{id}/activity_stream/
List Activity Streams for an Ad Hoc Command
GET/api/v2/ad_hoc_commands/{id}/cancel/
Retrieve an Ad Hoc Command
POST/api/v2/ad_hoc_commands/{id}/cancel/
Retrieve an Ad Hoc Command
GET/api/v2/ad_hoc_commands/{id}/events/
List Ad Hoc Command Events for an Ad Hoc Command
GET/api/v2/ad_hoc_commands/{id}/notifications/
List Notifications for an Ad Hoc Command
GET/api/v2/ad_hoc_commands/{id}/relaunch/
Relaunch an Ad Hoc Command
POST/api/v2/ad_hoc_commands/{id}/relaunch/
Relaunch an Ad Hoc Command
GET/api/v2/ad_hoc_commands/{id}/stdout/
Retrieve Ad Hoc Command Stdout

Ad Hoc Command Events

GET/api/v2/ad_hoc_command_events/
List Ad Hoc Command Events
GET/api/v2/ad_hoc_command_events/{id}/
Retrieve an Ad Hoc Command Event

System Job Templates

GET/api/v2/system_job_templates/
List System Job Templates
GET/api/v2/system_job_templates/{id}/
Retrieve a System Job Template
GET/api/v2/system_job_templates/{id}/jobs/
List System Jobs for a System Job Template
POST/api/v2/system_job_templates/{id}/launch/
Launch a Job Template
GET/api/v2/system_job_templates/{id}/notification_templates_error/
List Notification Templates for a System Job Template
POST/api/v2/system_job_templates/{id}/notification_templates_error/
Create a Notification Template for a System Job Template
GET/api/v2/system_job_templates/{id}/notification_templates_started/
List Notification Templates for a System Job Template
POST/api/v2/system_job_templates/{id}/notification_templates_started/
Create a Notification Template for a System Job Template
GET/api/v2/system_job_templates/{id}/notification_templates_success/
List Notification Templates for a System Job Template
POST/api/v2/system_job_templates/{id}/notification_templates_success/
Create a Notification Template for a System Job Template
GET/api/v2/system_job_templates/{id}/schedules/
List Schedules for a System Job Template
POST/api/v2/system_job_templates/{id}/schedules/
Create a Schedule for a System Job Template

System Jobs

GET/api/v2/system_jobs/
List System Jobs
GET/api/v2/system_jobs/{id}/
Retrieve a System Job
DELETE/api/v2/system_jobs/{id}/
Delete a System Job
GET/api/v2/system_jobs/{id}/cancel/
Retrieve a System Job
POST/api/v2/system_jobs/{id}/cancel/
Retrieve a System Job
GET/api/v2/system_jobs/{id}/events/
List System Job Events for a System Job
GET/api/v2/system_jobs/{id}/notifications/
List Notifications for a System Job

Schedules

GET/api/v2/schedules/
List Schedules
POST/api/v2/schedules/
Schedule Details
GET/api/v2/schedules/{id}/
Retrieve a Schedule
PUT/api/v2/schedules/{id}/
Update a Schedule
PATCH/api/v2/schedules/{id}/
Update a Schedule
DELETE/api/v2/schedules/{id}/
Delete a Schedule
GET/api/v2/schedules/{id}/credentials/
List Credentials for a Schedule
POST/api/v2/schedules/{id}/credentials/
Create a Credential for a Schedule
GET/api/v2/schedules/{id}/jobs/
List Unified Jobs for a Schedule
POST/api/v2/schedules/preview/

Roles

GET/api/v2/roles/
List Roles
GET/api/v2/roles/{id}/
Retrieve a Role
GET/api/v2/roles/{id}/children/
List Roles for a Role
GET/api/v2/roles/{id}/parents/
List Roles for a Role
GET/api/v2/roles/{id}/teams/
List Teams for a Role
POST/api/v2/roles/{id}/teams/
Create a Team for a Role
GET/api/v2/roles/{id}/users/
List Users for a Role
POST/api/v2/roles/{id}/users/
Create a User for a Role

Notification Templates

GET/api/v2/notification_templates/
List Notification Templates
POST/api/v2/notification_templates/
Create a Notification Template
GET/api/v2/notification_templates/{id}/
Retrieve a Notification Template
PUT/api/v2/notification_templates/{id}/
Update a Notification Template
PATCH/api/v2/notification_templates/{id}/
Update a Notification Template
DELETE/api/v2/notification_templates/{id}/
Delete a Notification Template
POST/api/v2/notification_templates/{id}/copy/
GET/api/v2/notification_templates/{id}/notifications/
List Notifications for a Notification Template
POST/api/v2/notification_templates/{id}/test/
Test a Notification Template

Notifications

GET/api/v2/notifications/
List Notifications
GET/api/v2/notifications/{id}/
Retrieve a Notification

Labels

GET/api/v2/labels/
List Labels
POST/api/v2/labels/
Create a Label
GET/api/v2/labels/{id}/
Retrieve a Label
PUT/api/v2/labels/{id}/
Update a Label
PATCH/api/v2/labels/{id}/
Update a Label

Unified Job Templates

GET/api/v2/unified_job_templates/
List Unified Job Templates

Unified Jobs

GET/api/v2/unified_jobs/
List Unified Jobs

Activity Streams

GET/api/v2/activity_stream/
List Activity Streams
GET/api/v2/activity_stream/{id}/
Retrieve an Activity Stream

Workflow Job Templates

GET/api/v2/workflow_job_templates/
List Workflow Job Templates
POST/api/v2/workflow_job_templates/
Create a Workflow Job Template
GET/api/v2/workflow_job_templates/{id}/
Retrieve a Workflow Job Template
PUT/api/v2/workflow_job_templates/{id}/
Update a Workflow Job Template
PATCH/api/v2/workflow_job_templates/{id}/
Update a Workflow Job Template
DELETE/api/v2/workflow_job_templates/{id}/
Delete a Workflow Job Template
GET/api/v2/workflow_job_templates/{id}/activity_stream/
List Activity Streams for a Workflow Job Template
GET/api/v2/workflow_job_templates/{id}/copy/
Copy a Workflow Job Template
POST/api/v2/workflow_job_templates/{id}/copy/
Copy a Workflow Job Template
POST/api/v2/workflow_job_templates/{id}/github/
POST/api/v2/workflow_job_templates/{id}/gitlab/
GET/api/v2/workflow_job_templates/{id}/labels/
List Labels for a Workflow Job Template
POST/api/v2/workflow_job_templates/{id}/labels/
Create a Label for a Workflow Job Template
GET/api/v2/workflow_job_templates/{id}/launch/
Launch a Workflow Job Template
POST/api/v2/workflow_job_templates/{id}/launch/
Launch a Workflow Job Template
GET/api/v2/workflow_job_templates/{id}/notification_templates_approvals/
List Notification Templates for a Workflow Job Template
POST/api/v2/workflow_job_templates/{id}/notification_templates_approvals/
Create a Notification Template for a Workflow Job Template
GET/api/v2/workflow_job_templates/{id}/notification_templates_error/
List Notification Templates for a Workflow Job Template
POST/api/v2/workflow_job_templates/{id}/notification_templates_error/
Create a Notification Template for a Workflow Job Template
GET/api/v2/workflow_job_templates/{id}/notification_templates_started/
List Notification Templates for a Workflow Job Template
POST/api/v2/workflow_job_templates/{id}/notification_templates_started/
Create a Notification Template for a Workflow Job Template
GET/api/v2/workflow_job_templates/{id}/notification_templates_success/
List Notification Templates for a Workflow Job Template
POST/api/v2/workflow_job_templates/{id}/notification_templates_success/
Create a Notification Template for a Workflow Job Template
GET/api/v2/workflow_job_templates/{id}/object_roles/
List Roles for a Workflow Job Template
GET/api/v2/workflow_job_templates/{id}/schedules/
List Schedules for a Workflow Job Template
POST/api/v2/workflow_job_templates/{id}/schedules/
Create a Schedule for a Workflow Job Template
GET/api/v2/workflow_job_templates/{id}/survey_spec/
POST requests to this resource should include the full specification for a Workflow Job Template's Survey
POST/api/v2/workflow_job_templates/{id}/survey_spec/
POST requests to this resource should include the full specification for a Workflow Job Template's Survey
DELETE/api/v2/workflow_job_templates/{id}/survey_spec/
POST requests to this resource should include the full specification for a Workflow Job Template's Survey
POST/api/v2/workflow_job_templates/{id}/webhook_key/
GET/api/v2/workflow_job_templates/{id}/workflow_jobs/
List Workflow Jobs for a Workflow Job Template
GET/api/v2/workflow_job_templates/{id}/workflow_nodes/
Workflow Job Template Workflow Node List
POST/api/v2/workflow_job_templates/{id}/workflow_nodes/
Workflow Job Template Workflow Node List

Workflow Jobs

GET/api/v2/workflow_jobs/
List Workflow Jobs
GET/api/v2/workflow_jobs/{id}/
Retrieve a Workflow Job
DELETE/api/v2/workflow_jobs/{id}/
Delete a Workflow Job
GET/api/v2/workflow_jobs/{id}/activity_stream/
List Activity Streams for a Workflow Job
GET/api/v2/workflow_jobs/{id}/cancel/
Cancel Workflow Job
POST/api/v2/workflow_jobs/{id}/cancel/
Cancel Workflow Job
GET/api/v2/workflow_jobs/{id}/labels/
List Labels for a Workflow Job
GET/api/v2/workflow_jobs/{id}/notifications/
List Notifications for a Workflow Job
GET/api/v2/workflow_jobs/{id}/relaunch/
Relaunch a workflow job
POST/api/v2/workflow_jobs/{id}/relaunch/
Relaunch a workflow job
GET/api/v2/workflow_jobs/{id}/workflow_nodes/
List Workflow Job Nodes for a Workflow Job

Workflow Job Template Nodes

GET/api/v2/workflow_job_template_nodes/
List Workflow Job Template Nodes
POST/api/v2/workflow_job_template_nodes/
Create a Workflow Job Template Node
GET/api/v2/workflow_job_template_nodes/{id}/
Retrieve a Workflow Job Template Node
PUT/api/v2/workflow_job_template_nodes/{id}/
Update a Workflow Job Template Node
PATCH/api/v2/workflow_job_template_nodes/{id}/
Update a Workflow Job Template Node
DELETE/api/v2/workflow_job_template_nodes/{id}/
Delete a Workflow Job Template Node
GET/api/v2/workflow_job_template_nodes/{id}/always_nodes/
List Workflow Job Template Nodes for a Workflow Job Template Node
POST/api/v2/workflow_job_template_nodes/{id}/always_nodes/
Create a Workflow Job Template Node for a Workflow Job Template Node
POST/api/v2/workflow_job_template_nodes/{id}/create_approval_template/
Retrieve a Workflow Job Template Node
GET/api/v2/workflow_job_template_nodes/{id}/credentials/
List Credentials for a Workflow Job Template Node
POST/api/v2/workflow_job_template_nodes/{id}/credentials/
Create a Credential for a Workflow Job Template Node
GET/api/v2/workflow_job_template_nodes/{id}/failure_nodes/
List Workflow Job Template Nodes for a Workflow Job Template Node
POST/api/v2/workflow_job_template_nodes/{id}/failure_nodes/
Create a Workflow Job Template Node for a Workflow Job Template Node
GET/api/v2/workflow_job_template_nodes/{id}/success_nodes/
List Workflow Job Template Nodes for a Workflow Job Template Node
POST/api/v2/workflow_job_template_nodes/{id}/success_nodes/
Create a Workflow Job Template Node for a Workflow Job Template Node

Workflow Job Nodes

GET/api/v2/workflow_job_nodes/
List Workflow Job Nodes
GET/api/v2/workflow_job_nodes/{id}/
Retrieve a Workflow Job Node
GET/api/v2/workflow_job_nodes/{id}/always_nodes/
List Workflow Job Nodes for a Workflow Job Node
GET/api/v2/workflow_job_nodes/{id}/credentials/
List Credentials for a Workflow Job Node
GET/api/v2/workflow_job_nodes/{id}/failure_nodes/
List Workflow Job Nodes for a Workflow Job Node
GET/api/v2/workflow_job_nodes/{id}/success_nodes/
List Workflow Job Nodes for a Workflow Job Node

Credential Input Sources

GET/api/v2/credential_input_sources/
List Credential Input Sources
POST/api/v2/credential_input_sources/
Create a Credential Input Source
GET/api/v2/credential_input_sources/{id}/
Retrieve a Credential Input Source
PUT/api/v2/credential_input_sources/{id}/
Update a Credential Input Source
PATCH/api/v2/credential_input_sources/{id}/
Update a Credential Input Source
DELETE/api/v2/credential_input_sources/{id}/
Delete a Credential Input Source

Execution Environments

GET/api/v2/execution_environments/
List Execution Environments
POST/api/v2/execution_environments/
Create an Execution Environment
GET/api/v2/execution_environments/{id}/
Retrieve an Execution Environment
PUT/api/v2/execution_environments/{id}/
Update an Execution Environment
PATCH/api/v2/execution_environments/{id}/
Update an Execution Environment
DELETE/api/v2/execution_environments/{id}/
Delete an Execution Environment
GET/api/v2/execution_environments/{id}/activity_stream/
List Activity Streams for an Execution Environment
POST/api/v2/execution_environments/{id}/copy/
GET/api/v2/execution_environments/{id}/unified_job_templates/
List Unified Job Templates for an Execution Environment

Metrics

GET/api/v2/metrics/
Show Metrics Details

Workflow Approval Templates

GET/api/v2/workflow_approval_templates/{id}/
Retrieve a Workflow Approval Template
PUT/api/v2/workflow_approval_templates/{id}/
Update a Workflow Approval Template
PATCH/api/v2/workflow_approval_templates/{id}/
Update a Workflow Approval Template
DELETE/api/v2/workflow_approval_templates/{id}/
Delete a Workflow Approval Template
GET/api/v2/workflow_approval_templates/{id}/approvals/
List Workflow Approvals for a Workflow Approval Template

Workflow Approvals

GET/api/v2/workflow_approvals/
List Workflow Approvals
POST/api/v2/workflow_approvals/
Create a Workflow Approval
GET/api/v2/workflow_approvals/{id}/
Retrieve a Workflow Approval
DELETE/api/v2/workflow_approvals/{id}/
Delete a Workflow Approval
GET/api/v2/workflow_approvals/{id}/approve/
Retrieve a Workflow Approval
POST/api/v2/workflow_approvals/{id}/approve/
Retrieve a Workflow Approval
GET/api/v2/workflow_approvals/{id}/deny/
Retrieve a Workflow Approval
POST/api/v2/workflow_approvals/{id}/deny/
Retrieve a Workflow Approval