API Catalog and Documentation
Ansible automation controller API V1
Ansible Automation Platform controller API
Operations
Ansible Automation Platform controller API
Authentication
HTTP Authentication, scheme: basic
Operations
List supported API versions
GET /api/
Token Handling using OAuth2
GET /api/o/
List top level resources
GET /api/v2/
List Activity Streams
GET /api/v2/activity_stream/
Retrieve an Activity Stream
GET /api/v2/activity_stream/{id}/
Retrieve an Ad Hoc Command Event
GET /api/v2/ad_hoc_command_events/{id}/
List Ad Hoc Commands
GET /api/v2/ad_hoc_commands/
Create an Ad Hoc Command
POST /api/v2/ad_hoc_commands/
Delete an Ad Hoc Command
DELETE /api/v2/ad_hoc_commands/{id}/
Retrieve an Ad Hoc Command
GET /api/v2/ad_hoc_commands/{id}/
List Activity Streams for an Ad Hoc Command
GET /api/v2/ad_hoc_commands/{id}/activity_stream/
Retrieve 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/
List Ad Hoc Command Events for an Ad Hoc Command
GET /api/v2/ad_hoc_commands/{id}/events/
List Notifications for an Ad Hoc Command
GET /api/v2/ad_hoc_commands/{id}/notifications/
Relaunch 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/
Retrieve Ad Hoc Command Stdout
GET /api/v2/ad_hoc_commands/{id}/stdout/
GET /api/v2/analytics/
GET /api/v2/analytics/adoption_rate/
POST /api/v2/analytics/adoption_rate/
GET /api/v2/analytics/adoption_rate_options/
POST /api/v2/analytics/adoption_rate_options/
GET /api/v2/analytics/authorized/
POST /api/v2/analytics/authorized/
GET /api/v2/analytics/event_explorer/
POST /api/v2/analytics/event_explorer/
GET /api/v2/analytics/event_explorer_options/
POST /api/v2/analytics/event_explorer_options/
GET /api/v2/analytics/host_explorer/
POST /api/v2/analytics/host_explorer/
GET /api/v2/analytics/host_explorer_options/
POST /api/v2/analytics/host_explorer_options/
GET /api/v2/analytics/job_explorer/
POST /api/v2/analytics/job_explorer/
GET /api/v2/analytics/job_explorer_options/
POST /api/v2/analytics/job_explorer_options/
GET /api/v2/analytics/probe_template_for_hosts/
POST /api/v2/analytics/probe_template_for_hosts/
GET /api/v2/analytics/probe_template_for_hosts_options/
POST /api/v2/analytics/probe_template_for_hosts_options/
GET /api/v2/analytics/probe_templates/
POST /api/v2/analytics/probe_templates/
GET /api/v2/analytics/probe_templates_options/
POST /api/v2/analytics/probe_templates_options/
GET /api/v2/analytics/report/{slug}/
POST /api/v2/analytics/report/{slug}/
GET /api/v2/analytics/report_options/
POST /api/v2/analytics/report_options/
GET /api/v2/analytics/reports/
POST /api/v2/analytics/reports/
GET /api/v2/analytics/roi_templates/
POST /api/v2/analytics/roi_templates/
GET /api/v2/analytics/roi_templates_options/
POST /api/v2/analytics/roi_templates_options/
List Applications
GET /api/v2/applications/
Create an Application
POST /api/v2/applications/
Delete an Application
DELETE /api/v2/applications/{id}/
Retrieve an Application
GET /api/v2/applications/{id}/
Update an Application
PATCH /api/v2/applications/{id}/
Update an Application
PUT /api/v2/applications/{id}/
List Activity Streams for an Application
GET /api/v2/applications/{id}/activity_stream/
List Access Tokens for an Application
GET /api/v2/applications/{id}/tokens/
Create an Access Token for an Application
POST /api/v2/applications/{id}/tokens/
List enabled single-sign-on endpoints
GET /api/v2/auth/
List top level resources
GET /api/v2/bulk/
Bulk Host Create
GET /api/v2/bulk/host_create/
Bulk Host Create
POST /api/v2/bulk/host_create/
Bulk Job Launch
GET /api/v2/bulk/job_launch/
Bulk Job Launch
POST /api/v2/bulk/job_launch/
Delete an existing license
DELETE /api/v2/config/
Return various sitewide configuration settings
GET /api/v2/config/
Install or update an existing license
POST /api/v2/config/
POST /api/v2/config/attach/
POST /api/v2/config/subscriptions/
List Inventories
GET /api/v2/constructed_inventories/
Create an Inventory
POST /api/v2/constructed_inventories/
Delete an Inventory
DELETE /api/v2/constructed_inventories/{id}/
Retrieve an Inventory
GET /api/v2/constructed_inventories/{id}/
Update an Inventory
PATCH /api/v2/constructed_inventories/{id}/
Update an Inventory
PUT /api/v2/constructed_inventories/{id}/
List Credential Input Sources
GET /api/v2/credential_input_sources/
Create a Credential Input Source
POST /api/v2/credential_input_sources/
Delete a Credential Input Source
DELETE /api/v2/credential_input_sources/{id}/
Retrieve a Credential Input Source
GET /api/v2/credential_input_sources/{id}/
Update a Credential Input Source
PATCH /api/v2/credential_input_sources/{id}/
Update a Credential Input Source
PUT /api/v2/credential_input_sources/{id}/
List Credential Types
GET /api/v2/credential_types/
Create a Credential Type
POST /api/v2/credential_types/
Delete a Credential Type
DELETE /api/v2/credential_types/{id}/
Retrieve a Credential Type
GET /api/v2/credential_types/{id}/
Update a Credential Type
PATCH /api/v2/credential_types/{id}/
Update a Credential Type
PUT /api/v2/credential_types/{id}/
List Activity Streams for a Credential Type
GET /api/v2/credential_types/{id}/activity_stream/
List Credentials for a Credential Type
GET /api/v2/credential_types/{id}/credentials/
Create a Credential for a Credential Type
POST /api/v2/credential_types/{id}/credentials/
Retrieve a Credential Type
GET /api/v2/credential_types/{id}/test/
Retrieve a Credential Type
POST /api/v2/credential_types/{id}/test/
List Credentials
GET /api/v2/credentials/
Create a Credential
POST /api/v2/credentials/
Delete a Credential
DELETE /api/v2/credentials/{id}/
Retrieve a Credential
GET /api/v2/credentials/{id}/
Update a Credential
PATCH /api/v2/credentials/{id}/
Update a Credential
PUT /api/v2/credentials/{id}/
List Users
GET /api/v2/credentials/{id}/access_list/
List Activity Streams for a Credential
GET /api/v2/credentials/{id}/activity_stream/
GET /api/v2/credentials/{id}/copy/
POST /api/v2/credentials/{id}/copy/
List Credential Input Sources for a Credential
GET /api/v2/credentials/{id}/input_sources/
Create a Credential Input Source for a Credential
POST /api/v2/credentials/{id}/input_sources/
List Roles for a Credential
GET /api/v2/credentials/{id}/object_roles/
List Teams for a Credential
GET /api/v2/credentials/{id}/owner_teams/
List Users for a Credential
GET /api/v2/credentials/{id}/owner_users/
Retrieve a Credential
GET /api/v2/credentials/{id}/test/
Retrieve a Credential
POST /api/v2/credentials/{id}/test/
Show Dashboard Details
GET /api/v2/dashboard/
View Statistics for Job Runs
GET /api/v2/dashboard/graphs/jobs/
List Execution Environments
GET /api/v2/execution_environments/
Create an Execution Environment
POST /api/v2/execution_environments/
Delete an Execution Environment
DELETE /api/v2/execution_environments/{id}/
Retrieve an Execution Environment
GET /api/v2/execution_environments/{id}/
Update an Execution Environment
PATCH /api/v2/execution_environments/{id}/
Update an Execution Environment
PUT /api/v2/execution_environments/{id}/
List Activity Streams for an Execution Environment
GET /api/v2/execution_environments/{id}/activity_stream/
GET /api/v2/execution_environments/{id}/copy/
POST /api/v2/execution_environments/{id}/copy/
List Unified Job Templates for an Execution Environment
GET /api/v2/execution_environments/{id}/unified_job_templates/
List Groups
GET /api/v2/groups/
Create a Group
POST /api/v2/groups/
Delete a Group
DELETE /api/v2/groups/{id}/
Retrieve a Group
GET /api/v2/groups/{id}/
Update a Group
PATCH /api/v2/groups/{id}/
Update a Group
PUT /api/v2/groups/{id}/
List Activity Streams for a Group
GET /api/v2/groups/{id}/activity_stream/
List Ad Hoc Commands for a Group
GET /api/v2/groups/{id}/ad_hoc_commands/
Create an Ad Hoc Command for a Group
POST /api/v2/groups/{id}/ad_hoc_commands/
List All Hosts for a Group
GET /api/v2/groups/{id}/all_hosts/
List Groups for a Group
GET /api/v2/groups/{id}/children/
Create a Group for a Group
POST /api/v2/groups/{id}/children/
List Hosts for a Group
GET /api/v2/groups/{id}/hosts/
Create a Host for a Group
POST /api/v2/groups/{id}/hosts/
List Inventory Sources for a Group
GET /api/v2/groups/{id}/inventory_sources/
List Job Events for a Group
GET /api/v2/groups/{id}/job_events/
List Job Host Summaries for a Group
GET /api/v2/groups/{id}/job_host_summaries/
List Potential Child Groups for a Group
GET /api/v2/groups/{id}/potential_children/
Retrieve Group Variable Data
GET /api/v2/groups/{id}/variable_data/
Update Group Variable Data
PATCH /api/v2/groups/{id}/variable_data/
Update Group Variable Data
PUT /api/v2/groups/{id}/variable_data/
List Host Metric Summary Monthlys
GET /api/v2/host_metric_summary_monthly/
List Host Metrics
GET /api/v2/host_metrics/
Delete a Host Metric
DELETE /api/v2/host_metrics/{id}/
Retrieve a Host Metric
GET /api/v2/host_metrics/{id}/
List Hosts
GET /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 `()`.
POST /api/v2/hosts/
Delete a Host
DELETE /api/v2/hosts/{id}/
Retrieve a Host
GET /api/v2/hosts/{id}/
Update a Host
PATCH /api/v2/hosts/{id}/
Update a Host
PUT /api/v2/hosts/{id}/
List Activity Streams for a Host
GET /api/v2/hosts/{id}/activity_stream/
List Ad Hoc Command Events for a Host
GET /api/v2/hosts/{id}/ad_hoc_command_events/
List Ad Hoc Commands for a Host
GET /api/v2/hosts/{id}/ad_hoc_commands/
Create an Ad Hoc Command for a Host
POST /api/v2/hosts/{id}/ad_hoc_commands/
List All Groups for a Host
GET /api/v2/hosts/{id}/all_groups/
Retrieve a Host
GET /api/v2/hosts/{id}/ansible_facts/
List Groups for a Host
GET /api/v2/hosts/{id}/groups/
Create a Group for a Host
POST /api/v2/hosts/{id}/groups/
List Inventory Sources for a Host
GET /api/v2/hosts/{id}/inventory_sources/
List Job Events for a Host
GET /api/v2/hosts/{id}/job_events/
List Job Host Summaries for a Host
GET /api/v2/hosts/{id}/job_host_summaries/
List Inventories for a Host
GET /api/v2/hosts/{id}/smart_inventories/
Retrieve Host Variable Data
GET /api/v2/hosts/{id}/variable_data/
Update Host Variable Data
PATCH /api/v2/hosts/{id}/variable_data/
Update Host Variable Data
PUT /api/v2/hosts/{id}/variable_data/
List Instance Groups
GET /api/v2/instance_groups/
Create an Instance Group
POST /api/v2/instance_groups/
Delete an Instance Group
DELETE /api/v2/instance_groups/{id}/
Retrieve an Instance Group
GET /api/v2/instance_groups/{id}/
Update an Instance Group
PATCH /api/v2/instance_groups/{id}/
Update an Instance Group
PUT /api/v2/instance_groups/{id}/
List Users
GET /api/v2/instance_groups/{id}/access_list/
List Instances for an Instance Group
GET /api/v2/instance_groups/{id}/instances/
Create an Instance for an Instance Group
POST /api/v2/instance_groups/{id}/instances/
List Unified Jobs for an Instance Group
GET /api/v2/instance_groups/{id}/jobs/
List Roles for an Instance Group
GET /api/v2/instance_groups/{id}/object_roles/
List Instances
GET /api/v2/instances/
Create an Instance
POST /api/v2/instances/
Retrieve an Instance
GET /api/v2/instances/{id}/
Update an Instance
PATCH /api/v2/instances/{id}/
Update an Instance
PUT /api/v2/instances/{id}/
Health Check Data
GET /api/v2/instances/{id}/health_check/
Manually Initiate a Health Check
POST /api/v2/instances/{id}/health_check/
GET /api/v2/instances/{id}/install_bundle/
List Instance Groups for an Instance
GET /api/v2/instances/{id}/instance_groups/
Create an Instance Group for an Instance
POST /api/v2/instances/{id}/instance_groups/
List Unified Jobs for an Instance
GET /api/v2/instances/{id}/jobs/
List Instances for an Instance
GET /api/v2/instances/{id}/peers/
List Inventories
GET /api/v2/inventories/
Create an Inventory
POST /api/v2/inventories/
Delete an Inventory
DELETE /api/v2/inventories/{id}/
Retrieve an Inventory
GET /api/v2/inventories/{id}/
Update an Inventory
PATCH /api/v2/inventories/{id}/
Update an Inventory
PUT /api/v2/inventories/{id}/
List Users
GET /api/v2/inventories/{id}/access_list/
List Activity Streams for an Inventory
GET /api/v2/inventories/{id}/activity_stream/
List Ad Hoc Commands for an Inventory
GET /api/v2/inventories/{id}/ad_hoc_commands/
Create an Ad Hoc Command for an Inventory
POST /api/v2/inventories/{id}/ad_hoc_commands/
GET /api/v2/inventories/{id}/copy/
POST /api/v2/inventories/{id}/copy/
List Groups for an Inventory
GET /api/v2/inventories/{id}/groups/
Create a Group for an Inventory
POST /api/v2/inventories/{id}/groups/
List Hosts for an Inventory
GET /api/v2/inventories/{id}/hosts/
Create a Host for an Inventory
POST /api/v2/inventories/{id}/hosts/
List Inventories for an Inventory
GET /api/v2/inventories/{id}/input_inventories/
Create an Inventory for an Inventory
POST /api/v2/inventories/{id}/input_inventories/
List Instance Groups for an Inventory
GET /api/v2/inventories/{id}/instance_groups/
Create an Instance Group for an Inventory
POST /api/v2/inventories/{id}/instance_groups/
List Inventory Sources for an Inventory
GET /api/v2/inventories/{id}/inventory_sources/
Create an Inventory Source for an Inventory
POST /api/v2/inventories/{id}/inventory_sources/
List Job Templates for an Inventory
GET /api/v2/inventories/{id}/job_templates/
List Labels for an Inventory
GET /api/v2/inventories/{id}/labels/
Create a Label for an Inventory
POST /api/v2/inventories/{id}/labels/
List Roles for an Inventory
GET /api/v2/inventories/{id}/object_roles/
List Root Groups for an Inventory
GET /api/v2/inventories/{id}/root_groups/
POST /api/v2/inventories/{id}/root_groups/
Generate inventory group and host data as needed for an inventory script.
GET /api/v2/inventories/{id}/script/
Group Tree for an Inventory
GET /api/v2/inventories/{id}/tree/
Update Inventory Sources
GET /api/v2/inventories/{id}/update_inventory_sources/
Update Inventory Sources
POST /api/v2/inventories/{id}/update_inventory_sources/
Retrieve Inventory Variable Data
GET /api/v2/inventories/{id}/variable_data/
Update Inventory Variable Data
PATCH /api/v2/inventories/{id}/variable_data/
Update Inventory Variable Data
PUT /api/v2/inventories/{id}/variable_data/
List Inventory Sources
GET /api/v2/inventory_sources/
Create an Inventory Source
POST /api/v2/inventory_sources/
Delete an Inventory Source
DELETE /api/v2/inventory_sources/{id}/
Retrieve an Inventory Source
GET /api/v2/inventory_sources/{id}/
Update an Inventory Source
PATCH /api/v2/inventory_sources/{id}/
Update an Inventory Source
PUT /api/v2/inventory_sources/{id}/
List Activity Streams for an Inventory Source
GET /api/v2/inventory_sources/{id}/activity_stream/
List Credentials for an Inventory Source
GET /api/v2/inventory_sources/{id}/credentials/
Create a Credential for an Inventory Source
POST /api/v2/inventory_sources/{id}/credentials/
Create a Group for an Inventory Source
DELETE /api/v2/inventory_sources/{id}/groups/
List Groups for an Inventory Source
GET /api/v2/inventory_sources/{id}/groups/
Create a Host for an Inventory Source
DELETE /api/v2/inventory_sources/{id}/hosts/
List Hosts for an Inventory Source
GET /api/v2/inventory_sources/{id}/hosts/
List Inventory Updates for an Inventory Source
GET /api/v2/inventory_sources/{id}/inventory_updates/
List Notification Templates for an Inventory Source
GET /api/v2/inventory_sources/{id}/notification_templates_error/
Create a Notification Template for an Inventory Source
POST /api/v2/inventory_sources/{id}/notification_templates_error/
List Notification Templates for an Inventory Source
GET /api/v2/inventory_sources/{id}/notification_templates_started/
Create a Notification Template for an Inventory Source
POST /api/v2/inventory_sources/{id}/notification_templates_started/
List Notification Templates for an Inventory Source
GET /api/v2/inventory_sources/{id}/notification_templates_success/
Create a Notification Template for an Inventory Source
POST /api/v2/inventory_sources/{id}/notification_templates_success/
List Schedules for an Inventory Source
GET /api/v2/inventory_sources/{id}/schedules/
Create a Schedule for an Inventory Source
POST /api/v2/inventory_sources/{id}/schedules/
Update Inventory Source
GET /api/v2/inventory_sources/{id}/update/
Update Inventory Source
POST /api/v2/inventory_sources/{id}/update/
List Inventory Updates
GET /api/v2/inventory_updates/
Delete an Inventory Update
DELETE /api/v2/inventory_updates/{id}/
Retrieve an Inventory Update
GET /api/v2/inventory_updates/{id}/
Retrieve an Inventory Update
GET /api/v2/inventory_updates/{id}/cancel/
Retrieve an Inventory Update
POST /api/v2/inventory_updates/{id}/cancel/
List Credentials for an Inventory Update
GET /api/v2/inventory_updates/{id}/credentials/
List Inventory Update Events for an Inventory Update
GET /api/v2/inventory_updates/{id}/events/
List Notifications for an Inventory Update
GET /api/v2/inventory_updates/{id}/notifications/
Retrieve Inventory Update Stdout
GET /api/v2/inventory_updates/{id}/stdout/
Retrieve a Job Event
GET /api/v2/job_events/{id}/
List Job Events for a Job Event
GET /api/v2/job_events/{id}/children/
Retrieve a Job Host Summary
GET /api/v2/job_host_summaries/{id}/
List Job Templates
GET /api/v2/job_templates/
Create a Job Template
POST /api/v2/job_templates/
Delete a Job Template
DELETE /api/v2/job_templates/{id}/
Retrieve a Job Template
GET /api/v2/job_templates/{id}/
Update a Job Template
PATCH /api/v2/job_templates/{id}/
Update a Job Template
PUT /api/v2/job_templates/{id}/
List Users
GET /api/v2/job_templates/{id}/access_list/
List Activity Streams for a Job Template
GET /api/v2/job_templates/{id}/activity_stream/
The job template callback allows for ephemeral hosts to launch a new job.
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/
GET /api/v2/job_templates/{id}/copy/
POST /api/v2/job_templates/{id}/copy/
List Credentials for a Job Template
GET /api/v2/job_templates/{id}/credentials/
Create a Credential for a Job Template
POST /api/v2/job_templates/{id}/credentials/
POST /api/v2/job_templates/{id}/github/
POST /api/v2/job_templates/{id}/gitlab/
List Instance Groups for a Job Template
GET /api/v2/job_templates/{id}/instance_groups/
Create an Instance Group for a Job Template
POST /api/v2/job_templates/{id}/instance_groups/
List Jobs for a Job Template
GET /api/v2/job_templates/{id}/jobs/
List Labels for a Job Template
GET /api/v2/job_templates/{id}/labels/
Create a Label for a Job Template
POST /api/v2/job_templates/{id}/labels/
Launch a Job Template
GET /api/v2/job_templates/{id}/launch/
Launch a Job Template
POST /api/v2/job_templates/{id}/launch/
List Notification Templates for a Job Template
GET /api/v2/job_templates/{id}/notification_templates_error/
Create a Notification Template for a Job Template
POST /api/v2/job_templates/{id}/notification_templates_error/
List Notification Templates for a Job Template
GET /api/v2/job_templates/{id}/notification_templates_started/
Create a Notification Template for a Job Template
POST /api/v2/job_templates/{id}/notification_templates_started/
List Notification Templates for a Job Template
GET /api/v2/job_templates/{id}/notification_templates_success/
Create a Notification Template for a Job Template
POST /api/v2/job_templates/{id}/notification_templates_success/
List Roles for a Job Template
GET /api/v2/job_templates/{id}/object_roles/
List Schedules for a Job Template
GET /api/v2/job_templates/{id}/schedules/
Create a Schedule for a Job Template
POST /api/v2/job_templates/{id}/schedules/
List Workflow Jobs for a Job Template
GET /api/v2/job_templates/{id}/slice_workflow_jobs/
Create a Workflow Job for a Job Template
POST /api/v2/job_templates/{id}/slice_workflow_jobs/
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
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/
GET /api/v2/job_templates/{id}/webhook_key/
POST /api/v2/job_templates/{id}/webhook_key/
List Jobs
GET /api/v2/jobs/
Delete a Job
DELETE /api/v2/jobs/{id}/
Retrieve a Job Host Summary
GET /api/v2/jobs/{id}/
List Activity Streams for a Job
GET /api/v2/jobs/{id}/activity_stream/
Determine if a Job can be canceled
GET /api/v2/jobs/{id}/cancel/
Cancel a Job
POST /api/v2/jobs/{id}/cancel/
Create a schedule based on a job
GET /api/v2/jobs/{id}/create_schedule/
Create a schedule based on a job
POST /api/v2/jobs/{id}/create_schedule/
List Credentials for a Job
GET /api/v2/jobs/{id}/credentials/
List Job Events for a Job
GET /api/v2/jobs/{id}/job_events/
View a summary of children events
GET /api/v2/jobs/{id}/job_events/children_summary/
List Job Host Summaries for a Job
GET /api/v2/jobs/{id}/job_host_summaries/
List Labels for a Job
GET /api/v2/jobs/{id}/labels/
List Notifications for a Job
GET /api/v2/jobs/{id}/notifications/
Relaunch a Job
GET /api/v2/jobs/{id}/relaunch/
Relaunch a Job
POST /api/v2/jobs/{id}/relaunch/
Retrieve Job Stdout
GET /api/v2/jobs/{id}/stdout/
List Labels
GET /api/v2/labels/
Create a Label
POST /api/v2/labels/
Retrieve a Label
GET /api/v2/labels/{id}/
Update a Label
PATCH /api/v2/labels/{id}/
Update a Label
PUT /api/v2/labels/{id}/
Retrieve Information about the current User
GET /api/v2/me/
Make a GET request to this resource to obtain a list all Receptor Nodes and their links.
GET /api/v2/mesh_visualizer/
Show Metrics Details
GET /api/v2/metrics/
List Notification Templates
GET /api/v2/notification_templates/
Create a Notification Template
POST /api/v2/notification_templates/
Delete a Notification Template
DELETE /api/v2/notification_templates/{id}/
Retrieve a Notification Template
GET /api/v2/notification_templates/{id}/
Update a Notification Template
PATCH /api/v2/notification_templates/{id}/
Update a Notification Template
PUT /api/v2/notification_templates/{id}/
GET /api/v2/notification_templates/{id}/copy/
POST /api/v2/notification_templates/{id}/copy/
List Notifications for a Notification Template
GET /api/v2/notification_templates/{id}/notifications/
Test a Notification Template
POST /api/v2/notification_templates/{id}/test/
List Notifications
GET /api/v2/notifications/
Retrieve a Notification
GET /api/v2/notifications/{id}/
List Organizations
GET /api/v2/organizations/
Create an Organization
POST /api/v2/organizations/
Delete an Organization
DELETE /api/v2/organizations/{id}/
Retrieve an Organization
GET /api/v2/organizations/{id}/
Update an Organization
PATCH /api/v2/organizations/{id}/
Update an Organization
PUT /api/v2/organizations/{id}/
List Users
GET /api/v2/organizations/{id}/access_list/
List Activity Streams for an Organization
GET /api/v2/organizations/{id}/activity_stream/
List Admin Users for an Organization
GET /api/v2/organizations/{id}/admins/
Create an Admin User for an Organization
POST /api/v2/organizations/{id}/admins/
List Applications for an Organization
GET /api/v2/organizations/{id}/applications/
Create an Application for an Organization
POST /api/v2/organizations/{id}/applications/
List Credentials for an Organization
GET /api/v2/organizations/{id}/credentials/
Create a Credential for an Organization
POST /api/v2/organizations/{id}/credentials/
List Execution Environments for an Organization
GET /api/v2/organizations/{id}/execution_environments/
Create an Execution Environment for an Organization
POST /api/v2/organizations/{id}/execution_environments/
List Credentials for an Organization
GET /api/v2/organizations/{id}/galaxy_credentials/
Create a Credential for an Organization
POST /api/v2/organizations/{id}/galaxy_credentials/
List Instance Groups for an Organization
GET /api/v2/organizations/{id}/instance_groups/
Create an Instance Group for an Organization
POST /api/v2/organizations/{id}/instance_groups/
List Inventories for an Organization
GET /api/v2/organizations/{id}/inventories/
List Job Templates for an Organization
GET /api/v2/organizations/{id}/job_templates/
Create a Job Template for an Organization
POST /api/v2/organizations/{id}/job_templates/
List Notification Templates for an Organization
GET /api/v2/organizations/{id}/notification_templates/
Create a Notification Template for an Organization
POST /api/v2/organizations/{id}/notification_templates/
List Notification Templates for an Organization
GET /api/v2/organizations/{id}/notification_templates_approvals/
Create a Notification Template for an Organization
POST /api/v2/organizations/{id}/notification_templates_approvals/
List Notification Templates for an Organization
GET /api/v2/organizations/{id}/notification_templates_error/
Create a Notification Template for an Organization
POST /api/v2/organizations/{id}/notification_templates_error/
List Notification Templates for an Organization
GET /api/v2/organizations/{id}/notification_templates_started/
Create a Notification Template for an Organization
POST /api/v2/organizations/{id}/notification_templates_started/
List Notification Templates for an Organization
GET /api/v2/organizations/{id}/notification_templates_success/
Create a Notification Template for an Organization
POST /api/v2/organizations/{id}/notification_templates_success/
List Roles for an Organization
GET /api/v2/organizations/{id}/object_roles/
List Projects for an Organization
GET /api/v2/organizations/{id}/projects/
Create a Project for an Organization
POST /api/v2/organizations/{id}/projects/
List Teams for an Organization
GET /api/v2/organizations/{id}/teams/
Create a Team for an Organization
POST /api/v2/organizations/{id}/teams/
List Users for an Organization
GET /api/v2/organizations/{id}/users/
Create a User for an Organization
POST /api/v2/organizations/{id}/users/
List Workflow Job Templates for an Organization
GET /api/v2/organizations/{id}/workflow_job_templates/
Create a Workflow Job Template for an Organization
POST /api/v2/organizations/{id}/workflow_job_templates/
Return some basic information about this instance
GET /api/v2/ping/
List Project Updates
GET /api/v2/project_updates/
Delete a Project Update
DELETE /api/v2/project_updates/{id}/
Retrieve a Project Update
GET /api/v2/project_updates/{id}/
Cancel Project Update
GET /api/v2/project_updates/{id}/cancel/
Cancel Project Update
POST /api/v2/project_updates/{id}/cancel/
List Project Update Events for a Project Update
GET /api/v2/project_updates/{id}/events/
List Notifications for a Project Update
GET /api/v2/project_updates/{id}/notifications/
List Inventory Updates for a Project Update
GET /api/v2/project_updates/{id}/scm_inventory_updates/
Retrieve Project Update Stdout
GET /api/v2/project_updates/{id}/stdout/
List Projects
GET /api/v2/projects/
Create a Project
POST /api/v2/projects/
Delete a Project
DELETE /api/v2/projects/{id}/
Retrieve a Project
GET /api/v2/projects/{id}/
Update a Project
PATCH /api/v2/projects/{id}/
Update a Project
PUT /api/v2/projects/{id}/
List Users
GET /api/v2/projects/{id}/access_list/
List Activity Streams for a Project
GET /api/v2/projects/{id}/activity_stream/
GET /api/v2/projects/{id}/copy/
POST /api/v2/projects/{id}/copy/
Retrieve a Project
GET /api/v2/projects/{id}/inventories/
List Notification Templates for a Project
GET /api/v2/projects/{id}/notification_templates_error/
Create a Notification Template for a Project
POST /api/v2/projects/{id}/notification_templates_error/
List Notification Templates for a Project
GET /api/v2/projects/{id}/notification_templates_started/
Create a Notification Template for a Project
POST /api/v2/projects/{id}/notification_templates_started/
List Notification Templates for a Project
GET /api/v2/projects/{id}/notification_templates_success/
Create a Notification Template for a Project
POST /api/v2/projects/{id}/notification_templates_success/
List Roles for a Project
GET /api/v2/projects/{id}/object_roles/
Retrieve Project Playbooks
GET /api/v2/projects/{id}/playbooks/
List Project Updates for a Project
GET /api/v2/projects/{id}/project_updates/
List Schedules for a Project
GET /api/v2/projects/{id}/schedules/
Create a Schedule for a Project
POST /api/v2/projects/{id}/schedules/
List Inventory Sources for a Project
GET /api/v2/projects/{id}/scm_inventory_sources/
List Teams
GET /api/v2/projects/{id}/teams/
Update Project
GET /api/v2/projects/{id}/update/
Update Project
POST /api/v2/projects/{id}/update/
List Roles
GET /api/v2/roles/
Retrieve a Role
GET /api/v2/roles/{id}/
List Roles for a Role
GET /api/v2/roles/{id}/children/
List Roles for a Role
GET /api/v2/roles/{id}/parents/
List Teams for a Role
GET /api/v2/roles/{id}/teams/
Create a Team for a Role
POST /api/v2/roles/{id}/teams/
List Users for a Role
GET /api/v2/roles/{id}/users/
Create a User for a Role
POST /api/v2/roles/{id}/users/
List Schedules
GET /api/v2/schedules/
Schedule Details
POST /api/v2/schedules/
POST /api/v2/schedules/preview/
GET /api/v2/schedules/zoneinfo/
Delete a Schedule
DELETE /api/v2/schedules/{id}/
Retrieve a Schedule
GET /api/v2/schedules/{id}/
Update a Schedule
PATCH /api/v2/schedules/{id}/
Update a Schedule
PUT /api/v2/schedules/{id}/
List Credentials for a Schedule
GET /api/v2/schedules/{id}/credentials/
Create a Credential for a Schedule
POST /api/v2/schedules/{id}/credentials/
List Instance Groups for a Schedule
GET /api/v2/schedules/{id}/instance_groups/
Create an Instance Group for a Schedule
POST /api/v2/schedules/{id}/instance_groups/
List Unified Jobs for a Schedule
GET /api/v2/schedules/{id}/jobs/
List Labels for a Schedule
GET /api/v2/schedules/{id}/labels/
Create a Label for a Schedule
POST /api/v2/schedules/{id}/labels/
List Settings
GET /api/v2/settings/
Test Logging Configuration
POST /api/v2/settings/logging/test/
Delete a Setting
DELETE /api/v2/settings/{category_slug}/
Retrieve a Setting
GET /api/v2/settings/{category_slug}/
Update a Setting
PATCH /api/v2/settings/{category_slug}/
Update a Setting
PUT /api/v2/settings/{category_slug}/
List System Job Templates
GET /api/v2/system_job_templates/
Retrieve a System Job Template
GET /api/v2/system_job_templates/{id}/
List System Jobs for a System Job Template
GET /api/v2/system_job_templates/{id}/jobs/
Launch a Job Template
GET /api/v2/system_job_templates/{id}/launch/
Launch a Job Template
POST /api/v2/system_job_templates/{id}/launch/
List Notification Templates for a System Job Template
GET /api/v2/system_job_templates/{id}/notification_templates_error/
Create a Notification Template for a System Job Template
POST /api/v2/system_job_templates/{id}/notification_templates_error/
List Notification Templates for a System Job Template
GET /api/v2/system_job_templates/{id}/notification_templates_started/
Create a Notification Template for a System Job Template
POST /api/v2/system_job_templates/{id}/notification_templates_started/
List Notification Templates for a System Job Template
GET /api/v2/system_job_templates/{id}/notification_templates_success/
Create a Notification Template for a System Job Template
POST /api/v2/system_job_templates/{id}/notification_templates_success/
List Schedules for a System Job Template
GET /api/v2/system_job_templates/{id}/schedules/
Create a Schedule for a System Job Template
POST /api/v2/system_job_templates/{id}/schedules/
List System Jobs
GET /api/v2/system_jobs/
Delete a System Job
DELETE /api/v2/system_jobs/{id}/
Retrieve a System Job
GET /api/v2/system_jobs/{id}/
Retrieve a System Job
GET /api/v2/system_jobs/{id}/cancel/
Retrieve a System Job
POST /api/v2/system_jobs/{id}/cancel/
List System Job Events for a System Job
GET /api/v2/system_jobs/{id}/events/
List Notifications for a System Job
GET /api/v2/system_jobs/{id}/notifications/
List Teams
GET /api/v2/teams/
Create a Team
POST /api/v2/teams/
Delete a Team
DELETE /api/v2/teams/{id}/
Retrieve a Team
GET /api/v2/teams/{id}/
Update a Team
PATCH /api/v2/teams/{id}/
Update a Team
PUT /api/v2/teams/{id}/
List Users
GET /api/v2/teams/{id}/access_list/
List Activity Streams for a Team
GET /api/v2/teams/{id}/activity_stream/
List Credentials for a Team
GET /api/v2/teams/{id}/credentials/
Create a Credential for a Team
POST /api/v2/teams/{id}/credentials/
List Roles for a Team
GET /api/v2/teams/{id}/object_roles/
List Projects for a Team
GET /api/v2/teams/{id}/projects/
List Roles for a Team
GET /api/v2/teams/{id}/roles/
Associate Roles with this Team
POST /api/v2/teams/{id}/roles/
List Users for a Team
GET /api/v2/teams/{id}/users/
Create a User for a Team
POST /api/v2/teams/{id}/users/
List Access Tokens
GET /api/v2/tokens/
Create an Access Token
POST /api/v2/tokens/
Delete an Access Token
DELETE /api/v2/tokens/{id}/
Retrieve an Access Token
GET /api/v2/tokens/{id}/
Update an Access Token
PATCH /api/v2/tokens/{id}/
Update an Access Token
PUT /api/v2/tokens/{id}/
List Activity Streams for an Access Token
GET /api/v2/tokens/{id}/activity_stream/
List Unified Job Templates
GET /api/v2/unified_job_templates/
List Unified Jobs
GET /api/v2/unified_jobs/
List Users
GET /api/v2/users/
Create a User
POST /api/v2/users/
Delete a User
DELETE /api/v2/users/{id}/
Retrieve a User
GET /api/v2/users/{id}/
Update a User
PATCH /api/v2/users/{id}/
Update a User
PUT /api/v2/users/{id}/
List Users
GET /api/v2/users/{id}/access_list/
List Activity Streams for a User
GET /api/v2/users/{id}/activity_stream/
List Organizations Administered by this User
GET /api/v2/users/{id}/admin_of_organizations/
List Applications
GET /api/v2/users/{id}/applications/
Create an Application
POST /api/v2/users/{id}/applications/
List Access Tokens for a User
GET /api/v2/users/{id}/authorized_tokens/
Create an Access Token for a User
POST /api/v2/users/{id}/authorized_tokens/
List Credentials for a User
GET /api/v2/users/{id}/credentials/
Create a Credential for a User
POST /api/v2/users/{id}/credentials/
List Organizations for a User
GET /api/v2/users/{id}/organizations/
List Access Tokens for a User
GET /api/v2/users/{id}/personal_tokens/
Create an Access Token for a User
POST /api/v2/users/{id}/personal_tokens/
List Projects for a User
GET /api/v2/users/{id}/projects/
List Roles for a User
GET /api/v2/users/{id}/roles/
Associate Roles with this User
POST /api/v2/users/{id}/roles/
List Teams for a User
GET /api/v2/users/{id}/teams/
List Access Tokens for a User
GET /api/v2/users/{id}/tokens/
Create an Access Token for a User
POST /api/v2/users/{id}/tokens/
Delete a Workflow Approval Template
DELETE /api/v2/workflow_approval_templates/{id}/
Retrieve a Workflow Approval Template
GET /api/v2/workflow_approval_templates/{id}/
Update a Workflow Approval Template
PATCH /api/v2/workflow_approval_templates/{id}/
Update a Workflow Approval Template
PUT /api/v2/workflow_approval_templates/{id}/
List Workflow Approvals for a Workflow Approval Template
GET /api/v2/workflow_approval_templates/{id}/approvals/
List Workflow Approvals
GET /api/v2/workflow_approvals/
Delete a Workflow Approval
DELETE /api/v2/workflow_approvals/{id}/
Retrieve a Workflow Approval
GET /api/v2/workflow_approvals/{id}/
Retrieve 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/
List Workflow Job Nodes
GET /api/v2/workflow_job_nodes/
Retrieve a Workflow Job Node
GET /api/v2/workflow_job_nodes/{id}/
List Workflow Job Nodes for a Workflow Job Node
GET /api/v2/workflow_job_nodes/{id}/always_nodes/
List Credentials for a Workflow Job Node
GET /api/v2/workflow_job_nodes/{id}/credentials/
List Workflow Job Nodes for a Workflow Job Node
GET /api/v2/workflow_job_nodes/{id}/failure_nodes/
List Instance Groups for a Workflow Job Node
GET /api/v2/workflow_job_nodes/{id}/instance_groups/
Create an Instance Group for a Workflow Job Node
POST /api/v2/workflow_job_nodes/{id}/instance_groups/
List Labels for a Workflow Job Node
GET /api/v2/workflow_job_nodes/{id}/labels/
List Workflow Job Nodes for a Workflow Job Node
GET /api/v2/workflow_job_nodes/{id}/success_nodes/
List Workflow Job Template Nodes
GET /api/v2/workflow_job_template_nodes/
Create a Workflow Job Template Node
POST /api/v2/workflow_job_template_nodes/
Delete a Workflow Job Template Node
DELETE /api/v2/workflow_job_template_nodes/{id}/
Retrieve a Workflow Job Template Node
GET /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
PUT /api/v2/workflow_job_template_nodes/{id}/
List Workflow Job Template Nodes for a Workflow Job Template Node
GET /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}/always_nodes/
Retrieve a Workflow Job Template Node
GET /api/v2/workflow_job_template_nodes/{id}/create_approval_template/
Retrieve a Workflow Job Template Node
POST /api/v2/workflow_job_template_nodes/{id}/create_approval_template/
List Credentials for a Workflow Job Template Node
GET /api/v2/workflow_job_template_nodes/{id}/credentials/
Create a Credential for a Workflow Job Template Node
POST /api/v2/workflow_job_template_nodes/{id}/credentials/
List Workflow Job Template Nodes for a Workflow Job Template Node
GET /api/v2/workflow_job_template_nodes/{id}/failure_nodes/
Create a Workflow Job Template Node for a Workflow Job Template Node
POST /api/v2/workflow_job_template_nodes/{id}/failure_nodes/
List Instance Groups for a Workflow Job Template Node
GET /api/v2/workflow_job_template_nodes/{id}/instance_groups/
Create an Instance Group for a Workflow Job Template Node
POST /api/v2/workflow_job_template_nodes/{id}/instance_groups/
List Labels for a Workflow Job Template Node
GET /api/v2/workflow_job_template_nodes/{id}/labels/
Create a Label for a Workflow Job Template Node
POST /api/v2/workflow_job_template_nodes/{id}/labels/
List Workflow Job Template Nodes for a Workflow Job Template Node
GET /api/v2/workflow_job_template_nodes/{id}/success_nodes/
Create a Workflow Job Template Node for a Workflow Job Template Node
POST /api/v2/workflow_job_template_nodes/{id}/success_nodes/
List Workflow Job Templates
GET /api/v2/workflow_job_templates/
Create a Workflow Job Template
POST /api/v2/workflow_job_templates/
Delete a Workflow Job Template
DELETE /api/v2/workflow_job_templates/{id}/
Retrieve a Workflow Job Template
GET /api/v2/workflow_job_templates/{id}/
Update a Workflow Job Template
PATCH /api/v2/workflow_job_templates/{id}/
Update a Workflow Job Template
PUT /api/v2/workflow_job_templates/{id}/
List Users
GET /api/v2/workflow_job_templates/{id}/access_list/
List Activity Streams for a Workflow Job Template
GET /api/v2/workflow_job_templates/{id}/activity_stream/
Copy 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/
POST /api/v2/workflow_job_templates/{id}/github/
POST /api/v2/workflow_job_templates/{id}/gitlab/
List Labels for a Workflow Job Template
GET /api/v2/workflow_job_templates/{id}/labels/
Create a Label for a Workflow Job Template
POST /api/v2/workflow_job_templates/{id}/labels/
Launch 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/
List Notification Templates for a Workflow Job Template
GET /api/v2/workflow_job_templates/{id}/notification_templates_approvals/
Create a Notification Template for a Workflow Job Template
POST /api/v2/workflow_job_templates/{id}/notification_templates_approvals/
List Notification Templates for a Workflow Job Template
GET /api/v2/workflow_job_templates/{id}/notification_templates_error/
Create a Notification Template for a Workflow Job Template
POST /api/v2/workflow_job_templates/{id}/notification_templates_error/
List Notification Templates for a Workflow Job Template
GET /api/v2/workflow_job_templates/{id}/notification_templates_started/
Create a Notification Template for a Workflow Job Template
POST /api/v2/workflow_job_templates/{id}/notification_templates_started/
List Notification Templates for a Workflow Job Template
GET /api/v2/workflow_job_templates/{id}/notification_templates_success/
Create a Notification Template for a Workflow Job Template
POST /api/v2/workflow_job_templates/{id}/notification_templates_success/
List Roles for a Workflow Job Template
GET /api/v2/workflow_job_templates/{id}/object_roles/
List Schedules for a Workflow Job Template
GET /api/v2/workflow_job_templates/{id}/schedules/
Create a Schedule for a Workflow Job Template
POST /api/v2/workflow_job_templates/{id}/schedules/
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
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/
GET /api/v2/workflow_job_templates/{id}/webhook_key/
POST /api/v2/workflow_job_templates/{id}/webhook_key/
List Workflow Jobs for a Workflow Job Template
GET /api/v2/workflow_job_templates/{id}/workflow_jobs/
Workflow Job Template Workflow Node List
GET /api/v2/workflow_job_templates/{id}/workflow_nodes/
Workflow Job Template Workflow Node List
POST /api/v2/workflow_job_templates/{id}/workflow_nodes/
List Workflow Jobs
GET /api/v2/workflow_jobs/
Delete a Workflow Job
DELETE /api/v2/workflow_jobs/{id}/
Retrieve a Workflow Job
GET /api/v2/workflow_jobs/{id}/
List Activity Streams for a Workflow Job
GET /api/v2/workflow_jobs/{id}/activity_stream/
Cancel Workflow Job
GET /api/v2/workflow_jobs/{id}/cancel/
Cancel Workflow Job
POST /api/v2/workflow_jobs/{id}/cancel/
List Labels for a Workflow Job
GET /api/v2/workflow_jobs/{id}/labels/
List Notifications for a Workflow Job
GET /api/v2/workflow_jobs/{id}/notifications/
Relaunch a workflow job
GET /api/v2/workflow_jobs/{id}/relaunch/
Relaunch a workflow job
POST /api/v2/workflow_jobs/{id}/relaunch/
List Workflow Job Nodes for a Workflow Job
GET /api/v2/workflow_jobs/{id}/workflow_nodes/
Back to top