All REST Endpoints

Activity Streams

REST API endpoints for Activity Streams

List Activity Streams
Method: get
Path: /api/v2/activity_stream/
Retrieve an Activity Stream
Method: get
Path: /api/v2/activity_stream/{id}/
Ad Hoc Command Events

REST API endpoints for Ad Hoc Command Events

List Ad Hoc Command Events
Method: get
Path: /api/v2/ad_hoc_command_events/
Retrieve an Ad Hoc Command Event
Method: get
Path: /api/v2/ad_hoc_command_events/{id}/
Ad Hoc Commands

REST API endpoints for Ad Hoc Commands

Create an Ad Hoc Command
Method: post
Path: /api/v2/ad_hoc_commands/
Delete an Ad Hoc Command
Method: delete
Path: /api/v2/ad_hoc_commands/{id}/
List Activity Streams for an Ad Hoc Command
Method: get
Path: /api/v2/ad_hoc_commands/{id}/activity_stream/
List Ad Hoc Command Events for an Ad Hoc Command
Method: get
Path: /api/v2/ad_hoc_commands/{id}/events/
List Ad Hoc Commands
Method: get
Path: /api/v2/ad_hoc_commands/
List Notifications for an Ad Hoc Command
Method: get
Path: /api/v2/ad_hoc_commands/{id}/notifications/
Retrieve Ad Hoc Command Stdout
Method: get
Path: /api/v2/ad_hoc_commands/{id}/stdout/
Retrieve an Ad Hoc Command
Method: get
Path: /api/v2/ad_hoc_commands/{id}/
Retrieve an Ad Hoc Command
Method: get
Path: /api/v2/ad_hoc_commands/{id}/cancel/
Retrieve an Ad Hoc Command
Method: post
Path: /api/v2/ad_hoc_commands/{id}/cancel/
Relaunch an Ad Hoc Command
Method: get
Path: /api/v2/ad_hoc_commands/{id}/relaunch/
Relaunch an Ad Hoc Command
Method: post
Path: /api/v2/ad_hoc_commands/{id}/relaunch/
Authentication

REST API endpoints for Authentication

Create an Access Token
Method: post
Path: /api/v2/tokens/
Create an Access Token for an Application
Method: post
Path: /api/v2/applications/{id}/tokens/
Create an Application
Method: post
Path: /api/v2/applications/
Delete an Access Token
Method: delete
Path: /api/v2/tokens/{id}/
Delete an Application
Method: delete
Path: /api/v2/applications/{id}/
List Access Tokens
Method: get
Path: /api/v2/tokens/
List Access Tokens for an Application
Method: get
Path: /api/v2/applications/{id}/tokens/
List Activity Streams for an Access Token
Method: get
Path: /api/v2/tokens/{id}/activity_stream/
List Activity Streams for an Application
Method: get
Path: /api/v2/applications/{id}/activity_stream/
List Applications
Method: get
Path: /api/v2/applications/
Retrieve an Access Token
Method: get
Path: /api/v2/tokens/{id}/
Retrieve an Application
Method: get
Path: /api/v2/applications/{id}/
Token Handling Using OAuth2
Method: get
Path: /api/o/
Update an Access Token
Method: patch
Path: /api/v2/tokens/{id}/
Update an Access Token
Method: put
Path: /api/v2/tokens/{id}/
Update an Application
Method: patch
Path: /api/v2/applications/{id}/
Update an Application
Method: put
Path: /api/v2/applications/{id}/
Credential Input Sources

REST API endpoints for Credential Input Sources

Create a Credential Input Source
Method: post
Path: /api/v2/credential_input_sources/
Delete a Credential Input Source
Method: delete
Path: /api/v2/credential_input_sources/{id}/
List Credential Input Sources
Method: get
Path: /api/v2/credential_input_sources/
Retrieve a Credential Input Source
Method: get
Path: /api/v2/credential_input_sources/{id}/
Update a Credential Input Source
Method: patch
Path: /api/v2/credential_input_sources/{id}/
Update a Credential Input Source
Method: put
Path: /api/v2/credential_input_sources/{id}/
Credential Types

REST API endpoints for Credential Types

Create a Credential for a Credential Type
Method: post
Path: /api/v2/credential_types/{id}/credentials/
Create a Credential Type
Method: post
Path: /api/v2/credential_types/
Delete a Credential Type
Method: delete
Path: /api/v2/credential_types/{id}/
List Activity Streams for a Credential Type
Method: get
Path: /api/v2/credential_types/{id}/activity_stream/
List Credential Types
Method: get
Path: /api/v2/credential_types/
List Credentials for a Credential Type
Method: get
Path: /api/v2/credential_types/{id}/credentials/
Retrieve a Credential Type
Method: get
Path: /api/v2/credential_types/{id}/
Retrieve a Credential Type
Method: get
Path: /api/v2/credential_types/{id}/test/
Retrieve a Credential Type
Method: post
Path: /api/v2/credential_types/{id}/test/
Update a Credential Type
Method: patch
Path: /api/v2/credential_types/{id}/
Update a Credential Type
Method: put
Path: /api/v2/credential_types/{id}/
Credentials

REST API endpoints for Credentials

Create a Credential
Method: post
Path: /api/v2/credentials/
Create a Credential Input Source for a Credential
Method: post
Path: /api/v2/credentials/{id}/input_sources/
Delete a Credential
Method: delete
Path: /api/v2/credentials/{id}/
List Activity Streams for a Credential
Method: get
Path: /api/v2/credentials/{id}/activity_stream/
List Credential Input Sources for a Credential
Method: get
Path: /api/v2/credentials/{id}/input_sources/
List Credentials
Method: get
Path: /api/v2/credentials/
List Roles for a Credential
Method: get
Path: /api/v2/credentials/{id}/object_roles/
List Teams for a Credential
Method: get
Path: /api/v2/credentials/{id}/owner_teams/
List Users
Method: get
Path: /api/v2/credentials/{id}/access_list/
List Users for a Credential
Method: get
Path: /api/v2/credentials/{id}/owner_users/
Retrieve a Credential
Method: get
Path: /api/v2/credentials/{id}/
Retrieve a Credential
Method: get
Path: /api/v2/credentials/{id}/test/
Retrieve a Credential
Method: post
Path: /api/v2/credentials/{id}/test/
Update a Credential
Method: patch
Path: /api/v2/credentials/{id}/
Update a Credential
Method: put
Path: /api/v2/credentials/{id}/
Credentials Copy Create
Method: post
Path: /api/v2/credentials/{id}/copy/
Credentials Copy List
Method: get
Path: /api/v2/credentials/{id}/copy/
Custom Inventory Scripts

REST API endpoints for Custom Inventory Scripts

Create a Custom Inventory Script
Method: post
Path: /api/v2/inventory_scripts/
Delete a Custom Inventory Script
Method: delete
Path: /api/v2/inventory_scripts/{id}/
List Custom Inventory Scripts
Method: get
Path: /api/v2/inventory_scripts/
List Roles for a Custom Inventory Script
Method: get
Path: /api/v2/inventory_scripts/{id}/object_roles/
Retrieve a Custom Inventory Script
Method: get
Path: /api/v2/inventory_scripts/{id}/
Update a Custom Inventory Script
Method: patch
Path: /api/v2/inventory_scripts/{id}/
Update a Custom Inventory Script
Method: put
Path: /api/v2/inventory_scripts/{id}/
Inventory Scripts Copy Create
Method: post
Path: /api/v2/inventory_scripts/{id}/copy/
Inventory Scripts Copy List
Method: get
Path: /api/v2/inventory_scripts/{id}/copy/
Dashboard

REST API endpoints for Dashboard

View Statistics for Job Runs
Method: get
Path: /api/v2/dashboard/graphs/jobs/
Show Dashboard Details
Method: get
Path: /api/v2/dashboard/
Groups

REST API endpoints for Groups

Create a Group
Method: post
Path: /api/v2/groups/
Create a Group for a Group
Method: post
Path: /api/v2/groups/{id}/children/
Create a Host for a Group
Method: post
Path: /api/v2/groups/{id}/hosts/
Create an Ad Hoc Command for a Group
Method: post
Path: /api/v2/groups/{id}/ad_hoc_commands/
Delete a Group
Method: delete
Path: /api/v2/groups/{id}/
List Activity Streams for a Group
Method: get
Path: /api/v2/groups/{id}/activity_stream/
List Ad Hoc Commands for a Group
Method: get
Path: /api/v2/groups/{id}/ad_hoc_commands/
List All Hosts for a Group
Method: get
Path: /api/v2/groups/{id}/all_hosts/
List Groups
Method: get
Path: /api/v2/groups/
List Groups for a Group
Method: get
Path: /api/v2/groups/{id}/children/
List Hosts for a Group
Method: get
Path: /api/v2/groups/{id}/hosts/
List Inventory Sources for a Group
Method: get
Path: /api/v2/groups/{id}/inventory_sources/
List Job Events for a Group
Method: get
Path: /api/v2/groups/{id}/job_events/
List Job Host Summaries for a Group
Method: get
Path: /api/v2/groups/{id}/job_host_summaries/
List Potential Child Groups for a Group
Method: get
Path: /api/v2/groups/{id}/potential_children/
Retrieve a Group
Method: get
Path: /api/v2/groups/{id}/
Retrieve Group Variable Data
Method: get
Path: /api/v2/groups/{id}/variable_data/
Update a Group
Method: patch
Path: /api/v2/groups/{id}/
Update a Group
Method: put
Path: /api/v2/groups/{id}/
Update Group Variable Data
Method: patch
Path: /api/v2/groups/{id}/variable_data/
Update Group Variable Data
Method: put
Path: /api/v2/groups/{id}/variable_data/
Hosts

REST API endpoints for Hosts

Create a Group for a Host
Method: post
Path: /api/v2/hosts/{id}/groups/
Create an Ad Hoc Command for a Host
Method: post
Path: /api/v2/hosts/{id}/ad_hoc_commands/
Delete a Host
Method: delete
Path: /api/v2/hosts/{id}/
List Activity Streams for a Host
Method: get
Path: /api/v2/hosts/{id}/activity_stream/
List Ad Hoc Command Events for a Host
Method: get
Path: /api/v2/hosts/{id}/ad_hoc_command_events/
List Ad Hoc Commands for a Host
Method: get
Path: /api/v2/hosts/{id}/ad_hoc_commands/
List All Groups for a Host
Method: get
Path: /api/v2/hosts/{id}/all_groups/
List Groups for a Host
Method: get
Path: /api/v2/hosts/{id}/groups/
List Hosts
Method: get
Path: /api/v2/hosts/
List Inventories for a Host
Method: get
Path: /api/v2/hosts/{id}/smart_inventories/
List Inventory Sources for a Host
Method: get
Path: /api/v2/hosts/{id}/inventory_sources/
List Job Events for a Host
Method: get
Path: /api/v2/hosts/{id}/job_events/
List Job Host Summaries for a Host
Method: get
Path: /api/v2/hosts/{id}/job_host_summaries/
List Red Hat Insights for a Host
Method: get
Path: /api/v2/hosts/{id}/insights/
Retrieve a Host
Method: get
Path: /api/v2/hosts/{id}/
Retrieve a Host
Method: get
Path: /api/v2/hosts/{id}/ansible_facts/
Retrieve Host Variable Data
Method: get
Path: /api/v2/hosts/{id}/variable_data/
Update a Host
Method: patch
Path: /api/v2/hosts/{id}/
Update a Host
Method: put
Path: /api/v2/hosts/{id}/
Update Host Variable Data
Method: patch
Path: /api/v2/hosts/{id}/variable_data/
Update Host Variable Data
Method: put
Path: /api/v2/hosts/{id}/variable_data/
`Host_filter` Is Available on This Endpoint. The Filter Supports: Relational Queries, `And` `Or` Boolean Logic, as Well as Expression Grouping via `()`.
Method: post
Path: /api/v2/hosts/
Instance Groups

REST API endpoints for Instance Groups

Create an Instance for an Instance Group
Method: post
Path: /api/v2/instance_groups/{id}/instances/
Create an Instance Group
Method: post
Path: /api/v2/instance_groups/
Delete an Instance Group
Method: delete
Path: /api/v2/instance_groups/{id}/
List Instance Groups
Method: get
Path: /api/v2/instance_groups/
List Instances for an Instance Group
Method: get
Path: /api/v2/instance_groups/{id}/instances/
List Unified Jobs for an Instance Group
Method: get
Path: /api/v2/instance_groups/{id}/jobs/
Retrieve an Instance Group
Method: get
Path: /api/v2/instance_groups/{id}/
Update an Instance Group
Method: patch
Path: /api/v2/instance_groups/{id}/
Update an Instance Group
Method: put
Path: /api/v2/instance_groups/{id}/
Instances

REST API endpoints for Instances

Create an Instance Group for an Instance
Method: post
Path: /api/v2/instances/{id}/instance_groups/
List Instance Groups for an Instance
Method: get
Path: /api/v2/instances/{id}/instance_groups/
List Instances
Method: get
Path: /api/v2/instances/
List Unified Jobs for an Instance
Method: get
Path: /api/v2/instances/{id}/jobs/
Retrieve an Instance
Method: get
Path: /api/v2/instances/{id}/
Update an Instance
Method: patch
Path: /api/v2/instances/{id}/
Update an Instance
Method: put
Path: /api/v2/instances/{id}/
Inventories

REST API endpoints for Inventories

Create a Group for an Inventory
Method: post
Path: /api/v2/inventories/{id}/groups/
Create a Host for an Inventory
Method: post
Path: /api/v2/inventories/{id}/hosts/
Create an Ad Hoc Command for an Inventory
Method: post
Path: /api/v2/inventories/{id}/ad_hoc_commands/
Create an Instance Group for an Inventory
Method: post
Path: /api/v2/inventories/{id}/instance_groups/
Create an Inventory
Method: post
Path: /api/v2/inventories/
Create an Inventory Source for an Inventory
Method: post
Path: /api/v2/inventories/{id}/inventory_sources/
Delete an Inventory
Method: delete
Path: /api/v2/inventories/{id}/
Group Tree for an Inventory
Method: get
Path: /api/v2/inventories/{id}/tree/
List Activity Streams for an Inventory
Method: get
Path: /api/v2/inventories/{id}/activity_stream/
List Ad Hoc Commands for an Inventory
Method: get
Path: /api/v2/inventories/{id}/ad_hoc_commands/
List Groups for an Inventory
Method: get
Path: /api/v2/inventories/{id}/groups/
List Hosts for an Inventory
Method: get
Path: /api/v2/inventories/{id}/hosts/
List Instance Groups for an Inventory
Method: get
Path: /api/v2/inventories/{id}/instance_groups/
List Inventories
Method: get
Path: /api/v2/inventories/
List Inventory Sources for an Inventory
Method: get
Path: /api/v2/inventories/{id}/inventory_sources/
List Job Templates for an Inventory
Method: get
Path: /api/v2/inventories/{id}/job_templates/
List Roles for an Inventory
Method: get
Path: /api/v2/inventories/{id}/object_roles/
List Root Groups for an Inventory
Method: get
Path: /api/v2/inventories/{id}/root_groups/
List Users
Method: get
Path: /api/v2/inventories/{id}/access_list/
Retrieve an Inventory
Method: get
Path: /api/v2/inventories/{id}/
Retrieve Inventory Variable Data
Method: get
Path: /api/v2/inventories/{id}/variable_data/
Update an Inventory
Method: patch
Path: /api/v2/inventories/{id}/
Update an Inventory
Method: put
Path: /api/v2/inventories/{id}/
Update Inventory Sources
Method: get
Path: /api/v2/inventories/{id}/update_inventory_sources/
Update Inventory Sources
Method: post
Path: /api/v2/inventories/{id}/update_inventory_sources/
Update Inventory Variable Data
Method: patch
Path: /api/v2/inventories/{id}/variable_data/
Update Inventory Variable Data
Method: put
Path: /api/v2/inventories/{id}/variable_data/
Generate Inventory Group and Host Data as Needed for an Inventory Script.
Method: get
Path: /api/v2/inventories/{id}/script/
Inventories Copy Create
Method: post
Path: /api/v2/inventories/{id}/copy/
Inventories Copy List
Method: get
Path: /api/v2/inventories/{id}/copy/
Inventories Root Groups Create
Method: post
Path: /api/v2/inventories/{id}/root_groups/
Inventory Sources

REST API endpoints for Inventory Sources

Create a Credential for an Inventory Source
Method: post
Path: /api/v2/inventory_sources/{id}/credentials/
Create a Group for an Inventory Source
Method: delete
Path: /api/v2/inventory_sources/{id}/groups/
Create a Host for an Inventory Source
Method: delete
Path: /api/v2/inventory_sources/{id}/hosts/
Create a Notification Template for an Inventory Source
Method: post
Path: /api/v2/inventory_sources/{id}/notification_templates_error/
Create a Notification Template for an Inventory Source
Method: post
Path: /api/v2/inventory_sources/{id}/notification_templates_started/
Create a Notification Template for an Inventory Source
Method: post
Path: /api/v2/inventory_sources/{id}/notification_templates_success/
Create a Schedule for an Inventory Source
Method: post
Path: /api/v2/inventory_sources/{id}/schedules/
Create an Inventory Source
Method: post
Path: /api/v2/inventory_sources/
Delete an Inventory Source
Method: delete
Path: /api/v2/inventory_sources/{id}/
List Activity Streams for an Inventory Source
Method: get
Path: /api/v2/inventory_sources/{id}/activity_stream/
List Credentials for an Inventory Source
Method: get
Path: /api/v2/inventory_sources/{id}/credentials/
List Groups for an Inventory Source
Method: get
Path: /api/v2/inventory_sources/{id}/groups/
List Hosts for an Inventory Source
Method: get
Path: /api/v2/inventory_sources/{id}/hosts/
List Inventory Sources
Method: get
Path: /api/v2/inventory_sources/
List Inventory Updates for an Inventory Source
Method: get
Path: /api/v2/inventory_sources/{id}/inventory_updates/
List Notification Templates for an Inventory Source
Method: get
Path: /api/v2/inventory_sources/{id}/notification_templates_error/
List Notification Templates for an Inventory Source
Method: get
Path: /api/v2/inventory_sources/{id}/notification_templates_started/
List Notification Templates for an Inventory Source
Method: get
Path: /api/v2/inventory_sources/{id}/notification_templates_success/
List Schedules for an Inventory Source
Method: get
Path: /api/v2/inventory_sources/{id}/schedules/
Retrieve an Inventory Source
Method: get
Path: /api/v2/inventory_sources/{id}/
Update an Inventory Source
Method: patch
Path: /api/v2/inventory_sources/{id}/
Update an Inventory Source
Method: put
Path: /api/v2/inventory_sources/{id}/
Update Inventory Source
Method: get
Path: /api/v2/inventory_sources/{id}/update/
Update Inventory Source
Method: post
Path: /api/v2/inventory_sources/{id}/update/
Inventory Updates

REST API endpoints for Inventory Updates

Delete an Inventory Update
Method: delete
Path: /api/v2/inventory_updates/{id}/
List Credentials for an Inventory Update
Method: get
Path: /api/v2/inventory_updates/{id}/credentials/
List Inventory Update Events for an Inventory Update
Method: get
Path: /api/v2/inventory_updates/{id}/events/
List Inventory Updates
Method: get
Path: /api/v2/inventory_updates/
List Notifications for an Inventory Update
Method: get
Path: /api/v2/inventory_updates/{id}/notifications/
Retrieve an Inventory Update
Method: get
Path: /api/v2/inventory_updates/{id}/
Retrieve an Inventory Update
Method: get
Path: /api/v2/inventory_updates/{id}/cancel/
Retrieve an Inventory Update
Method: post
Path: /api/v2/inventory_updates/{id}/cancel/
Retrieve Inventory Update Stdout
Method: get
Path: /api/v2/inventory_updates/{id}/stdout/
Job Events

REST API endpoints for Job Events

List Hosts for a Job Event
Method: get
Path: /api/v2/job_events/{id}/hosts/
List Job Events
Method: get
Path: /api/v2/job_events/
List Job Events for a Job Event
Method: get
Path: /api/v2/job_events/{id}/children/
Retrieve a Job Event
Method: get
Path: /api/v2/job_events/{id}/
Job Host Summaries

REST API endpoints for Job Host Summaries

Retrieve a Job Host Summary
Method: get
Path: /api/v2/job_host_summaries/{id}/
Job Templates

REST API endpoints for Job Templates

Create a Credential for a Job Template
Method: post
Path: /api/v2/job_templates/{id}/credentials/
Create a Job Template
Method: post
Path: /api/v2/job_templates/
Create a Label for a Job Template
Method: post
Path: /api/v2/job_templates/{id}/labels/
Create a Notification Template for a Job Template
Method: post
Path: /api/v2/job_templates/{id}/notification_templates_error/
Create a Notification Template for a Job Template
Method: post
Path: /api/v2/job_templates/{id}/notification_templates_started/
Create a Notification Template for a Job Template
Method: post
Path: /api/v2/job_templates/{id}/notification_templates_success/
Create a Schedule for a Job Template
Method: post
Path: /api/v2/job_templates/{id}/schedules/
Create a Workflow Job for a Job Template
Method: post
Path: /api/v2/job_templates/{id}/slice_workflow_jobs/
Create an Instance Group for a Job Template
Method: post
Path: /api/v2/job_templates/{id}/instance_groups/
Delete a Job Template
Method: delete
Path: /api/v2/job_templates/{id}/
List Activity Streams for a Job Template
Method: get
Path: /api/v2/job_templates/{id}/activity_stream/
List Credentials for a Job Template
Method: get
Path: /api/v2/job_templates/{id}/credentials/
List Instance Groups for a Job Template
Method: get
Path: /api/v2/job_templates/{id}/instance_groups/
List Job Templates
Method: get
Path: /api/v2/job_templates/
List Jobs for a Job Template
Method: get
Path: /api/v2/job_templates/{id}/jobs/
List Labels for a Job Template
Method: get
Path: /api/v2/job_templates/{id}/labels/
List Notification Templates for a Job Template
Method: get
Path: /api/v2/job_templates/{id}/notification_templates_error/
List Notification Templates for a Job Template
Method: get
Path: /api/v2/job_templates/{id}/notification_templates_started/
List Notification Templates for a Job Template
Method: get
Path: /api/v2/job_templates/{id}/notification_templates_success/
List Roles for a Job Template
Method: get
Path: /api/v2/job_templates/{id}/object_roles/
List Schedules for a Job Template
Method: get
Path: /api/v2/job_templates/{id}/schedules/
List Users
Method: get
Path: /api/v2/job_templates/{id}/access_list/
List Workflow Jobs for a Job Template
Method: get
Path: /api/v2/job_templates/{id}/slice_workflow_jobs/
Retrieve a Job Template
Method: get
Path: /api/v2/job_templates/{id}/
Update a Job Template
Method: patch
Path: /api/v2/job_templates/{id}/
Update a Job Template
Method: put
Path: /api/v2/job_templates/{id}/
Job Templates Copy Create
Method: post
Path: /api/v2/job_templates/{id}/copy/
Job Templates Copy List
Method: get
Path: /api/v2/job_templates/{id}/copy/
Job Templates Github Create
Method: post
Path: /api/v2/job_templates/{id}/github/
Job Templates Gitlab Create
Method: post
Path: /api/v2/job_templates/{id}/gitlab/
Job Templates Webhook Key Create
Method: post
Path: /api/v2/job_templates/{id}/webhook_key/
Job Templates Webhook Key List
Method: get
Path: /api/v2/job_templates/{id}/webhook_key/
Launch a Job Template
Method: get
Path: /api/v2/job_templates/{id}/launch/
Launch a Job Template
Method: post
Path: /api/v2/job_templates/{id}/launch/
POST Requests to This Resource Should Include the Full Specification for a Job Template's Survey
Method: delete
Path: /api/v2/job_templates/{id}/survey_spec/
POST Requests to This Resource Should Include the Full Specification for a Job Template's Survey
Method: get
Path: /api/v2/job_templates/{id}/survey_spec/
POST Requests to This Resource Should Include the Full Specification for a Job Template's Survey
Method: post
Path: /api/v2/job_templates/{id}/survey_spec/
The Job Template Callback Allows for Ephemeral Hosts to Launch a New Job.
Method: get
Path: /api/v2/job_templates/{id}/callback/
The Job Template Callback Allows for Ephemeral Hosts to Launch a New Job.
Method: post
Path: /api/v2/job_templates/{id}/callback/
Jobs

REST API endpoints for Jobs

Cancel a Job
Method: post
Path: /api/v2/jobs/{id}/cancel/
Delete a Job
Method: delete
Path: /api/v2/jobs/{id}/
Determine if a Job Can Be Canceled
Method: get
Path: /api/v2/jobs/{id}/cancel/
List Activity Streams for a Job
Method: get
Path: /api/v2/jobs/{id}/activity_stream/
List Credentials for a Job
Method: get
Path: /api/v2/jobs/{id}/credentials/
List Job Events for a Job
Method: get
Path: /api/v2/jobs/{id}/job_events/
List Job Host Summaries for a Job
Method: get
Path: /api/v2/jobs/{id}/job_host_summaries/
List Jobs
Method: get
Path: /api/v2/jobs/
List Labels for a Job
Method: get
Path: /api/v2/jobs/{id}/labels/
List Notifications for a Job
Method: get
Path: /api/v2/jobs/{id}/notifications/
Retrieve a Job Host Summary
Method: get
Path: /api/v2/jobs/{id}/
Retrieve Job Stdout
Method: get
Path: /api/v2/jobs/{id}/stdout/
Create a Schedule Based on a Job
Method: get
Path: /api/v2/jobs/{id}/create_schedule/
Create a Schedule Based on a Job
Method: post
Path: /api/v2/jobs/{id}/create_schedule/
Relaunch a Job
Method: get
Path: /api/v2/jobs/{id}/relaunch/
Relaunch a Job
Method: post
Path: /api/v2/jobs/{id}/relaunch/
Labels

REST API endpoints for Labels

Create a Label
Method: post
Path: /api/v2/labels/
List Labels
Method: get
Path: /api/v2/labels/
Retrieve a Label
Method: get
Path: /api/v2/labels/{id}/
Update a Label
Method: patch
Path: /api/v2/labels/{id}/
Update a Label
Method: put
Path: /api/v2/labels/{id}/
Metrics

REST API endpoints for Metrics

Show Metrics Details
Method: get
Path: /api/v2/metrics/
Notification Templates

REST API endpoints for Notification Templates

Create a Notification Template
Method: post
Path: /api/v2/notification_templates/
Delete a Notification Template
Method: delete
Path: /api/v2/notification_templates/{id}/
List Notification Templates
Method: get
Path: /api/v2/notification_templates/
List Notifications for a Notification Template
Method: get
Path: /api/v2/notification_templates/{id}/notifications/
Retrieve a Notification Template
Method: get
Path: /api/v2/notification_templates/{id}/
Update a Notification Template
Method: patch
Path: /api/v2/notification_templates/{id}/
Update a Notification Template
Method: put
Path: /api/v2/notification_templates/{id}/
Notification Templates Copy Create
Method: post
Path: /api/v2/notification_templates/{id}/copy/
Notification Templates Copy List
Method: get
Path: /api/v2/notification_templates/{id}/copy/
Test a Notification Template
Method: post
Path: /api/v2/notification_templates/{id}/test/
Notifications

REST API endpoints for Notifications

List Notifications
Method: get
Path: /api/v2/notifications/
Retrieve a Notification
Method: get
Path: /api/v2/notifications/{id}/
Organizations

REST API endpoints for Organizations

Create a Credential for an Organization
Method: post
Path: /api/v2/organizations/{id}/credentials/
Create a Credential for an Organization
Method: post
Path: /api/v2/organizations/{id}/galaxy_credentials/
Create a Job Template for an Organization
Method: post
Path: /api/v2/organizations/{id}/job_templates/
Create a Notification Template for an Organization
Method: post
Path: /api/v2/organizations/{id}/notification_templates/
Create a Notification Template for an Organization
Method: post
Path: /api/v2/organizations/{id}/notification_templates_approvals/
Create a Notification Template for an Organization
Method: post
Path: /api/v2/organizations/{id}/notification_templates_error/
Create a Notification Template for an Organization
Method: post
Path: /api/v2/organizations/{id}/notification_templates_started/
Create a Notification Template for an Organization
Method: post
Path: /api/v2/organizations/{id}/notification_templates_success/
Create a Project for an Organization
Method: post
Path: /api/v2/organizations/{id}/projects/
Create a Team for an Organization
Method: post
Path: /api/v2/organizations/{id}/teams/
Create a User for an Organization
Method: post
Path: /api/v2/organizations/{id}/users/
Create a Workflow Job Template for an Organization
Method: post
Path: /api/v2/organizations/{id}/workflow_job_templates/
Create an Admin User for an Organization
Method: post
Path: /api/v2/organizations/{id}/admins/
Create an Application for an Organization
Method: post
Path: /api/v2/organizations/{id}/applications/
Create an Instance Group for an Organization
Method: post
Path: /api/v2/organizations/{id}/instance_groups/
Create an Organization
Method: post
Path: /api/v2/organizations/
Delete an Organization
Method: delete
Path: /api/v2/organizations/{id}/
List Activity Streams for an Organization
Method: get
Path: /api/v2/organizations/{id}/activity_stream/
List Admin Users for an Organization
Method: get
Path: /api/v2/organizations/{id}/admins/
List Applications for an Organization
Method: get
Path: /api/v2/organizations/{id}/applications/
List Credentials for an Organization
Method: get
Path: /api/v2/organizations/{id}/credentials/
List Credentials for an Organization
Method: get
Path: /api/v2/organizations/{id}/galaxy_credentials/
List Instance Groups for an Organization
Method: get
Path: /api/v2/organizations/{id}/instance_groups/
List Inventories for an Organization
Method: get
Path: /api/v2/organizations/{id}/inventories/
List Job Templates for an Organization
Method: get
Path: /api/v2/organizations/{id}/job_templates/
List Notification Templates for an Organization
Method: get
Path: /api/v2/organizations/{id}/notification_templates/
List Notification Templates for an Organization
Method: get
Path: /api/v2/organizations/{id}/notification_templates_approvals/
List Notification Templates for an Organization
Method: get
Path: /api/v2/organizations/{id}/notification_templates_error/
List Notification Templates for an Organization
Method: get
Path: /api/v2/organizations/{id}/notification_templates_started/
List Notification Templates for an Organization
Method: get
Path: /api/v2/organizations/{id}/notification_templates_success/
List Organizations
Method: get
Path: /api/v2/organizations/
List Projects for an Organization
Method: get
Path: /api/v2/organizations/{id}/projects/
List Roles for an Organization
Method: get
Path: /api/v2/organizations/{id}/object_roles/
List Teams for an Organization
Method: get
Path: /api/v2/organizations/{id}/teams/
List Users
Method: get
Path: /api/v2/organizations/{id}/access_list/
List Users for an Organization
Method: get
Path: /api/v2/organizations/{id}/users/
List Workflow Job Templates for an Organization
Method: get
Path: /api/v2/organizations/{id}/workflow_job_templates/
Retrieve an Organization
Method: get
Path: /api/v2/organizations/{id}/
Update an Organization
Method: patch
Path: /api/v2/organizations/{id}/
Update an Organization
Method: put
Path: /api/v2/organizations/{id}/
Project Updates

REST API endpoints for Project Updates

Cancel Project Update
Method: get
Path: /api/v2/project_updates/{id}/cancel/
Cancel Project Update
Method: post
Path: /api/v2/project_updates/{id}/cancel/
Delete a Project Update
Method: delete
Path: /api/v2/project_updates/{id}/
List Inventory Updates for a Project Update
Method: get
Path: /api/v2/project_updates/{id}/scm_inventory_updates/
List Notifications for a Project Update
Method: get
Path: /api/v2/project_updates/{id}/notifications/
List Project Update Events for a Project Update
Method: get
Path: /api/v2/project_updates/{id}/events/
List Project Updates
Method: get
Path: /api/v2/project_updates/
Retrieve a Project Update
Method: get
Path: /api/v2/project_updates/{id}/
Retrieve Project Update Stdout
Method: get
Path: /api/v2/project_updates/{id}/stdout/
Projects

REST API endpoints for Projects

Create a Notification Template for a Project
Method: post
Path: /api/v2/projects/{id}/notification_templates_error/
Create a Notification Template for a Project
Method: post
Path: /api/v2/projects/{id}/notification_templates_started/
Create a Notification Template for a Project
Method: post
Path: /api/v2/projects/{id}/notification_templates_success/
Create a Project
Method: post
Path: /api/v2/projects/
Create a Schedule for a Project
Method: post
Path: /api/v2/projects/{id}/schedules/
Delete a Project
Method: delete
Path: /api/v2/projects/{id}/
List Activity Streams for a Project
Method: get
Path: /api/v2/projects/{id}/activity_stream/
List Inventory Sources for a Project
Method: get
Path: /api/v2/projects/{id}/scm_inventory_sources/
List Notification Templates for a Project
Method: get
Path: /api/v2/projects/{id}/notification_templates_error/
List Notification Templates for a Project
Method: get
Path: /api/v2/projects/{id}/notification_templates_started/
List Notification Templates for a Project
Method: get
Path: /api/v2/projects/{id}/notification_templates_success/
List Project Updates for a Project
Method: get
Path: /api/v2/projects/{id}/project_updates/
List Projects
Method: get
Path: /api/v2/projects/
List Roles for a Project
Method: get
Path: /api/v2/projects/{id}/object_roles/
List Schedules for a Project
Method: get
Path: /api/v2/projects/{id}/schedules/
List Teams
Method: get
Path: /api/v2/projects/{id}/teams/
List Users
Method: get
Path: /api/v2/projects/{id}/access_list/
Retrieve a Project
Method: get
Path: /api/v2/projects/{id}/
Retrieve a Project
Method: get
Path: /api/v2/projects/{id}/inventories/
Retrieve Project Playbooks
Method: get
Path: /api/v2/projects/{id}/playbooks/
Update a Project
Method: patch
Path: /api/v2/projects/{id}/
Update a Project
Method: put
Path: /api/v2/projects/{id}/
Update Project
Method: get
Path: /api/v2/projects/{id}/update/
Update Project
Method: post
Path: /api/v2/projects/{id}/update/
Projects Copy Create
Method: post
Path: /api/v2/projects/{id}/copy/
Projects Copy List
Method: get
Path: /api/v2/projects/{id}/copy/
Roles

REST API endpoints for Roles

Create a Team for a Role
Method: post
Path: /api/v2/roles/{id}/teams/
Create a User for a Role
Method: post
Path: /api/v2/roles/{id}/users/
List Roles
Method: get
Path: /api/v2/roles/
List Roles for a Role
Method: get
Path: /api/v2/roles/{id}/children/
List Roles for a Role
Method: get
Path: /api/v2/roles/{id}/parents/
List Teams for a Role
Method: get
Path: /api/v2/roles/{id}/teams/
List Users for a Role
Method: get
Path: /api/v2/roles/{id}/users/
Retrieve a Role
Method: get
Path: /api/v2/roles/{id}/
Schedules

REST API endpoints for Schedules

Create a Credential for a Schedule
Method: post
Path: /api/v2/schedules/{id}/credentials/
Delete a Schedule
Method: delete
Path: /api/v2/schedules/{id}/
List Credentials for a Schedule
Method: get
Path: /api/v2/schedules/{id}/credentials/
List Schedules
Method: get
Path: /api/v2/schedules/
List Unified Jobs for a Schedule
Method: get
Path: /api/v2/schedules/{id}/jobs/
Retrieve a Schedule
Method: get
Path: /api/v2/schedules/{id}/
Update a Schedule
Method: patch
Path: /api/v2/schedules/{id}/
Update a Schedule
Method: put
Path: /api/v2/schedules/{id}/
Schedule Details
Method: post
Path: /api/v2/schedules/
Schedules Preview Create
Method: post
Path: /api/v2/schedules/preview/
Schedules Zoneinfo List
Method: get
Path: /api/v2/schedules/zoneinfo/
Settings

REST API endpoints for Settings

Delete a Setting
Method: delete
Path: /api/v2/settings/{category_slug}/
List Settings
Method: get
Path: /api/v2/settings/
Retrieve a Setting
Method: get
Path: /api/v2/settings/{category_slug}/
Test Logging Configuration
Method: post
Path: /api/v2/settings/logging/test/
Update a Setting
Method: patch
Path: /api/v2/settings/{category_slug}/
Update a Setting
Method: put
Path: /api/v2/settings/{category_slug}/
System Configuration

REST API endpoints for System Configuration

Config Create
Method: post
Path: /api/v2/config/
Config Delete
Method: delete
Path: /api/v2/config/
Config Subscriptions Create
Method: post
Path: /api/v2/config/subscriptions/
List Enabled Single-Sign-on Endpoints
Method: get
Path: /api/v2/auth/
Return Some Basic Information About This Instance
Method: get
Path: /api/v2/ping/
Return Various Sitewide Configuration Settings
Method: get
Path: /api/v2/config/
System Job Templates

REST API endpoints for System Job Templates

Create a Notification Template for a System Job Template
Method: post
Path: /api/v2/system_job_templates/{id}/notification_templates_error/
Create a Notification Template for a System Job Template
Method: post
Path: /api/v2/system_job_templates/{id}/notification_templates_started/
Create a Notification Template for a System Job Template
Method: post
Path: /api/v2/system_job_templates/{id}/notification_templates_success/
Create a Schedule for a System Job Template
Method: post
Path: /api/v2/system_job_templates/{id}/schedules/
List Notification Templates for a System Job Template
Method: get
Path: /api/v2/system_job_templates/{id}/notification_templates_error/
List Notification Templates for a System Job Template
Method: get
Path: /api/v2/system_job_templates/{id}/notification_templates_started/
List Notification Templates for a System Job Template
Method: get
Path: /api/v2/system_job_templates/{id}/notification_templates_success/
List Schedules for a System Job Template
Method: get
Path: /api/v2/system_job_templates/{id}/schedules/
List System Job Templates
Method: get
Path: /api/v2/system_job_templates/
List System Jobs for a System Job Template
Method: get
Path: /api/v2/system_job_templates/{id}/jobs/
Retrieve a System Job Template
Method: get
Path: /api/v2/system_job_templates/{id}/
Launch a Job Template
Method: get
Path: /api/v2/system_job_templates/{id}/launch/
Launch a Job Template
Method: post
Path: /api/v2/system_job_templates/{id}/launch/
System Jobs

REST API endpoints for System Jobs

Delete a System Job
Method: delete
Path: /api/v2/system_jobs/{id}/
List Notifications for a System Job
Method: get
Path: /api/v2/system_jobs/{id}/notifications/
List System Job Events for a System Job
Method: get
Path: /api/v2/system_jobs/{id}/events/
List System Jobs
Method: get
Path: /api/v2/system_jobs/
Retrieve a System Job
Method: get
Path: /api/v2/system_jobs/{id}/
Retrieve a System Job
Method: get
Path: /api/v2/system_jobs/{id}/cancel/
Retrieve a System Job
Method: post
Path: /api/v2/system_jobs/{id}/cancel/
Teams

REST API endpoints for Teams

Associate Roles With This Team
Method: post
Path: /api/v2/teams/{id}/roles/
Create a Credential for a Team
Method: post
Path: /api/v2/teams/{id}/credentials/
Create a Team
Method: post
Path: /api/v2/teams/
Create a User for a Team
Method: post
Path: /api/v2/teams/{id}/users/
Delete a Team
Method: delete
Path: /api/v2/teams/{id}/
List Activity Streams for a Team
Method: get
Path: /api/v2/teams/{id}/activity_stream/
List Credentials for a Team
Method: get
Path: /api/v2/teams/{id}/credentials/
List Projects for a Team
Method: get
Path: /api/v2/teams/{id}/projects/
List Roles for a Team
Method: get
Path: /api/v2/teams/{id}/object_roles/
List Roles for a Team
Method: get
Path: /api/v2/teams/{id}/roles/
List Teams
Method: get
Path: /api/v2/teams/
List Users
Method: get
Path: /api/v2/teams/{id}/access_list/
List Users for a Team
Method: get
Path: /api/v2/teams/{id}/users/
Retrieve a Team
Method: get
Path: /api/v2/teams/{id}/
Update a Team
Method: patch
Path: /api/v2/teams/{id}/
Update a Team
Method: put
Path: /api/v2/teams/{id}/
Unified Job Templates

REST API endpoints for Unified Job Templates

List Unified Job Templates
Method: get
Path: /api/v2/unified_job_templates/
Unified Jobs

REST API endpoints for Unified Jobs

List Unified Jobs
Method: get
Path: /api/v2/unified_jobs/
Users

REST API endpoints for Users

Associate Roles With This User
Method: post
Path: /api/v2/users/{id}/roles/
Create a Credential for a User
Method: post
Path: /api/v2/users/{id}/credentials/
Create a User
Method: post
Path: /api/v2/users/
Create an Access Token for a User
Method: post
Path: /api/v2/users/{id}/authorized_tokens/
Create an Access Token for a User
Method: post
Path: /api/v2/users/{id}/personal_tokens/
Create an Access Token for a User
Method: post
Path: /api/v2/users/{id}/tokens/
Create an Application
Method: post
Path: /api/v2/users/{id}/applications/
Delete a User
Method: delete
Path: /api/v2/users/{id}/
List Access Tokens for a User
Method: get
Path: /api/v2/users/{id}/authorized_tokens/
List Access Tokens for a User
Method: get
Path: /api/v2/users/{id}/personal_tokens/
List Access Tokens for a User
Method: get
Path: /api/v2/users/{id}/tokens/
List Activity Streams for a User
Method: get
Path: /api/v2/users/{id}/activity_stream/
List Applications
Method: get
Path: /api/v2/users/{id}/applications/
List Credentials for a User
Method: get
Path: /api/v2/users/{id}/credentials/
List Organizations Administered by This User
Method: get
Path: /api/v2/users/{id}/admin_of_organizations/
List Organizations for a User
Method: get
Path: /api/v2/users/{id}/organizations/
List Projects for a User
Method: get
Path: /api/v2/users/{id}/projects/
List Roles for a User
Method: get
Path: /api/v2/users/{id}/roles/
List Teams for a User
Method: get
Path: /api/v2/users/{id}/teams/
List Users
Method: get
Path: /api/v2/users/
List Users
Method: get
Path: /api/v2/users/{id}/access_list/
Retrieve a User
Method: get
Path: /api/v2/users/{id}/
Retrieve Information About the Current User
Method: get
Path: /api/v2/me/
Update a User
Method: patch
Path: /api/v2/users/{id}/
Update a User
Method: put
Path: /api/v2/users/{id}/
Versioning

REST API endpoints for Versioning

List Supported API Versions
Method: get
Path: /api/
List Top Level Resources
Method: get
Path: /api/v2/
Workflow Approval Templates

REST API endpoints for Workflow Approval Templates

Delete a Workflow Approval Template
Method: delete
Path: /api/v2/workflow_approval_templates/{id}/
List Workflow Approvals for a Workflow Approval Template
Method: get
Path: /api/v2/workflow_approval_templates/{id}/approvals/
Retrieve a Workflow Approval Template
Method: get
Path: /api/v2/workflow_approval_templates/{id}/
Update a Workflow Approval Template
Method: patch
Path: /api/v2/workflow_approval_templates/{id}/
Update a Workflow Approval Template
Method: put
Path: /api/v2/workflow_approval_templates/{id}/
Workflow Approvals

REST API endpoints for Workflow Approvals

Create a Workflow Approval
Method: post
Path: /api/v2/workflow_approvals/
Delete a Workflow Approval
Method: delete
Path: /api/v2/workflow_approvals/{id}/
List Workflow Approvals
Method: get
Path: /api/v2/workflow_approvals/
Retrieve a Workflow Approval
Method: get
Path: /api/v2/workflow_approvals/{id}/
Retrieve a Workflow Approval
Method: get
Path: /api/v2/workflow_approvals/{id}/approve/
Retrieve a Workflow Approval
Method: post
Path: /api/v2/workflow_approvals/{id}/approve/
Retrieve a Workflow Approval
Method: get
Path: /api/v2/workflow_approvals/{id}/deny/
Retrieve a Workflow Approval
Method: post
Path: /api/v2/workflow_approvals/{id}/deny/
Workflow Job Nodes

REST API endpoints for Workflow Job Nodes

List Credentials for a Workflow Job Node
Method: get
Path: /api/v2/workflow_job_nodes/{id}/credentials/
List Workflow Job Nodes
Method: get
Path: /api/v2/workflow_job_nodes/
List Workflow Job Nodes for a Workflow Job Node
Method: get
Path: /api/v2/workflow_job_nodes/{id}/always_nodes/
List Workflow Job Nodes for a Workflow Job Node
Method: get
Path: /api/v2/workflow_job_nodes/{id}/failure_nodes/
List Workflow Job Nodes for a Workflow Job Node
Method: get
Path: /api/v2/workflow_job_nodes/{id}/success_nodes/
Retrieve a Workflow Job Node
Method: get
Path: /api/v2/workflow_job_nodes/{id}/
Workflow Job Template Nodes

REST API endpoints for Workflow Job Template Nodes

Create a Credential for a Workflow Job Template Node
Method: post
Path: /api/v2/workflow_job_template_nodes/{id}/credentials/
Create a Workflow Job Template Node
Method: post
Path: /api/v2/workflow_job_template_nodes/
Create a Workflow Job Template Node for a Workflow Job Template Node
Method: post
Path: /api/v2/workflow_job_template_nodes/{id}/always_nodes/
Create a Workflow Job Template Node for a Workflow Job Template Node
Method: post
Path: /api/v2/workflow_job_template_nodes/{id}/failure_nodes/
Create a Workflow Job Template Node for a Workflow Job Template Node
Method: post
Path: /api/v2/workflow_job_template_nodes/{id}/success_nodes/
Delete a Workflow Job Template Node
Method: delete
Path: /api/v2/workflow_job_template_nodes/{id}/
List Credentials for a Workflow Job Template Node
Method: get
Path: /api/v2/workflow_job_template_nodes/{id}/credentials/
List Workflow Job Template Nodes
Method: get
Path: /api/v2/workflow_job_template_nodes/
List Workflow Job Template Nodes for a Workflow Job Template Node
Method: get
Path: /api/v2/workflow_job_template_nodes/{id}/always_nodes/
List Workflow Job Template Nodes for a Workflow Job Template Node
Method: get
Path: /api/v2/workflow_job_template_nodes/{id}/failure_nodes/
List Workflow Job Template Nodes for a Workflow Job Template Node
Method: get
Path: /api/v2/workflow_job_template_nodes/{id}/success_nodes/
Retrieve a Workflow Job Template Node
Method: get
Path: /api/v2/workflow_job_template_nodes/{id}/
Retrieve a Workflow Job Template Node
Method: get
Path: /api/v2/workflow_job_template_nodes/{id}/create_approval_template/
Retrieve a Workflow Job Template Node
Method: post
Path: /api/v2/workflow_job_template_nodes/{id}/create_approval_template/
Update a Workflow Job Template Node
Method: patch
Path: /api/v2/workflow_job_template_nodes/{id}/
Update a Workflow Job Template Node
Method: put
Path: /api/v2/workflow_job_template_nodes/{id}/
Workflow Job Templates

REST API endpoints for Workflow Job Templates

Create a Label for a Workflow Job Template
Method: post
Path: /api/v2/workflow_job_templates/{id}/labels/
Create a Notification Template for a Workflow Job Template
Method: post
Path: /api/v2/workflow_job_templates/{id}/notification_templates_approvals/
Create a Notification Template for a Workflow Job Template
Method: post
Path: /api/v2/workflow_job_templates/{id}/notification_templates_error/
Create a Notification Template for a Workflow Job Template
Method: post
Path: /api/v2/workflow_job_templates/{id}/notification_templates_started/
Create a Notification Template for a Workflow Job Template
Method: post
Path: /api/v2/workflow_job_templates/{id}/notification_templates_success/
Create a Schedule for a Workflow Job Template
Method: post
Path: /api/v2/workflow_job_templates/{id}/schedules/
Create a Workflow Job Template
Method: post
Path: /api/v2/workflow_job_templates/
Delete a Workflow Job Template
Method: delete
Path: /api/v2/workflow_job_templates/{id}/
List Activity Streams for a Workflow Job Template
Method: get
Path: /api/v2/workflow_job_templates/{id}/activity_stream/
List Labels for a Workflow Job Template
Method: get
Path: /api/v2/workflow_job_templates/{id}/labels/
List Notification Templates for a Workflow Job Template
Method: get
Path: /api/v2/workflow_job_templates/{id}/notification_templates_approvals/
List Notification Templates for a Workflow Job Template
Method: get
Path: /api/v2/workflow_job_templates/{id}/notification_templates_error/
List Notification Templates for a Workflow Job Template
Method: get
Path: /api/v2/workflow_job_templates/{id}/notification_templates_started/
List Notification Templates for a Workflow Job Template
Method: get
Path: /api/v2/workflow_job_templates/{id}/notification_templates_success/
List Roles for a Workflow Job Template
Method: get
Path: /api/v2/workflow_job_templates/{id}/object_roles/
List Schedules for a Workflow Job Template
Method: get
Path: /api/v2/workflow_job_templates/{id}/schedules/
List Users
Method: get
Path: /api/v2/workflow_job_templates/{id}/access_list/
List Workflow Job Templates
Method: get
Path: /api/v2/workflow_job_templates/
List Workflow Jobs for a Workflow Job Template
Method: get
Path: /api/v2/workflow_job_templates/{id}/workflow_jobs/
Retrieve a Workflow Job Template
Method: get
Path: /api/v2/workflow_job_templates/{id}/
Update a Workflow Job Template
Method: patch
Path: /api/v2/workflow_job_templates/{id}/
Update a Workflow Job Template
Method: put
Path: /api/v2/workflow_job_templates/{id}/
Workflow Job Template Workflow Node List
Method: get
Path: /api/v2/workflow_job_templates/{id}/workflow_nodes/
Workflow Job Template Workflow Node List
Method: post
Path: /api/v2/workflow_job_templates/{id}/workflow_nodes/
Copy a Workflow Job Template
Method: get
Path: /api/v2/workflow_job_templates/{id}/copy/
Copy a Workflow Job Template
Method: post
Path: /api/v2/workflow_job_templates/{id}/copy/
Launch a Workflow Job Template
Method: get
Path: /api/v2/workflow_job_templates/{id}/launch/
Launch a Workflow Job Template
Method: post
Path: /api/v2/workflow_job_templates/{id}/launch/
POST Requests to This Resource Should Include the Full Specification for a Workflow Job Template's Survey
Method: delete
Path: /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
Method: get
Path: /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
Method: post
Path: /api/v2/workflow_job_templates/{id}/survey_spec/
Workflow Job Templates Github Create
Method: post
Path: /api/v2/workflow_job_templates/{id}/github/
Workflow Job Templates Gitlab Create
Method: post
Path: /api/v2/workflow_job_templates/{id}/gitlab/
Workflow Job Templates Webhook Key Create
Method: post
Path: /api/v2/workflow_job_templates/{id}/webhook_key/
Workflow Job Templates Webhook Key List
Method: get
Path: /api/v2/workflow_job_templates/{id}/webhook_key/
Workflow Jobs

REST API endpoints for Workflow Jobs

Cancel Workflow Job
Method: get
Path: /api/v2/workflow_jobs/{id}/cancel/
Cancel Workflow Job
Method: post
Path: /api/v2/workflow_jobs/{id}/cancel/
Delete a Workflow Job
Method: delete
Path: /api/v2/workflow_jobs/{id}/
List Activity Streams for a Workflow Job
Method: get
Path: /api/v2/workflow_jobs/{id}/activity_stream/
List Labels for a Workflow Job
Method: get
Path: /api/v2/workflow_jobs/{id}/labels/
List Notifications for a Workflow Job
Method: get
Path: /api/v2/workflow_jobs/{id}/notifications/
List Workflow Job Nodes for a Workflow Job
Method: get
Path: /api/v2/workflow_jobs/{id}/workflow_nodes/
List Workflow Jobs
Method: get
Path: /api/v2/workflow_jobs/
Retrieve a Workflow Job
Method: get
Path: /api/v2/workflow_jobs/{id}/
Relaunch a Workflow Job
Method: get
Path: /api/v2/workflow_jobs/{id}/relaunch/
Relaunch a Workflow Job
Method: post
Path: /api/v2/workflow_jobs/{id}/relaunch/