Table of Contents

• About the REST APIs
• All REST Endpoints

Get Started

• Introduction
• REST API Quick Start
  • Installing and Using cURL
  • Authenticating
  • Accessing the REST API
  • Sending Requests
  • Ordering and Sorting
  • Searching Text Fields
  • Filtering Results Using Operators
  • Limiting Response Results Using Pagination
  • Accessing Resources Using Named URLs
• Command-Line Interface Quick Start
  • Setting Up the Command-Line Interface
  • Authenticating
  • Using the Command-Line Interface
• Reference
  • Exporting Data
  • Importing Data

Tasks

• Activity Streams
  • List Activity Streams
  • Retrieve an Activity Stream
• Ad Hoc Command Events
  • Retrieve an Ad Hoc Command Event
• Ad Hoc Commands
  • Create an Ad Hoc Command
  • Delete an Ad Hoc Command
  • List Activity Streams for an Ad Hoc Command
  • List Ad Hoc Command Events for an Ad Hoc Command
  • List Ad Hoc Commands
  • List Notifications for an Ad Hoc Command
  • Retrieve Ad Hoc Command Stdout
  • Retrieve an Ad Hoc Command
  • Retrieve an Ad Hoc Command
  • Retrieve an Ad Hoc Command
  • Relaunch an Ad Hoc Command
  • Relaunch an Ad Hoc Command
• Authentication
  • Create an Access Token
  • Create an Access Token for an Application
  • Create an Application
  • Delete an Access Token
  • Delete an Application
  • List Access Tokens
  • List Access Tokens for an Application
  • List Activity Streams for an Access Token
  • List Activity Streams for an Application
  • List Applications
  • Retrieve an Access Token
  • Retrieve an Application
  • Token Handling Using OAuth2
  • Update an Access Token
  • Update an Access Token
  • Update an Application
  • Update an Application
• Credential Input Sources
  • Create a Credential Input Source
  • Delete a Credential Input Source
  • List Credential Input Sources
  • Retrieve a Credential Input Source
  • Update a Credential Input Source
  • Update a Credential Input Source
• Credential Types
  • Create a Credential for a Credential Type
  • Create a Credential Type
  • Delete a Credential Type
  • List Activity Streams for a Credential Type
  • List Credential Types
  • List Credentials for a Credential Type
  • Retrieve a Credential Type
  • Retrieve a Credential Type
  • Retrieve a Credential Type
  • Update a Credential Type
  • Update a Credential Type
• Credentials
  • Create a Credential
  • Create a Credential Input Source for a Credential
  • Delete a Credential
  • List Activity Streams for a Credential
  • List Credential Input Sources for a Credential
  • List Credentials
  • List Roles for a Credential
  • List Teams for a Credential
  • List Users
  • List Users for a Credential
  • Retrieve a Credential
  • Retrieve a Credential
  • Retrieve a Credential
  • Update a Credential
  • Update a Credential
  • Credentials Copy Create
  • Credentials Copy List
• Dashboard
  • View Statistics for Job Runs
  • Show Dashboard Details
• Execution Environments
  • Create an Execution Environment
  • Delete an Execution Environment
  • List Activity Streams for an Execution Environment
  • List Execution Environments
  • List Unified Job Templates for an Execution Environment
  • Retrieve an Execution Environment
  • Update an Execution Environment
  • Update an Execution Environment
  • Execution Environments Copy Create
  • Execution Environments Copy List
• Groups
  • Create a Group
  • Create a Group for a Group
  • Create a Host for a Group
  • Create an Ad Hoc Command for a Group
  • Delete a Group
  • List Activity Streams for a Group
  • List Ad Hoc Commands for a Group
  • List All Hosts for a Group
  • List Groups
  • List Groups for a Group
  • List Hosts for a Group
  • List Inventory Sources for a Group
  • List Job Events for a Group
  • List Job Host Summaries for a Group
  • List Potential Child Groups for a Group
  • Retrieve a Group
  • Retrieve Group Variable Data
  • Update a Group
  • Update a Group
  • Update Group Variable Data
  • Update Group Variable Data
• Hosts
  • Create a Group for a Host
  • Create an Ad Hoc Command for a Host
  • Delete a Host
  • List Activity Streams for a Host
  • List Ad Hoc Command Events for a Host
  • List Ad Hoc Commands for a Host
  • List All Groups for a Host
  • List Groups for a Host
  • List Hosts
  • List Inventories for a Host
  • List Inventory Sources for a Host
  • List Job Events for a Host
  • List Job Host Summaries for a Host
  • Retrieve a Host
  • Retrieve a Host
  • Retrieve Host Variable Data
  • Update a Host
  • Update a Host
  • Update Host Variable Data
  • Update Host Variable Data
  • `Host_filter` Is Available on This Endpoint. The Filter Supports: Relational Queries, `And` `Or` Boolean Logic, as Well as Expression Grouping via `()`.
• Instance Groups
  • Create an Instance for an Instance Group
  • Create an Instance Group
  • Delete an Instance Group
  • List Instance Groups
  • List Instances for an Instance Group
  • List Unified Jobs for an Instance Group
  • Retrieve an Instance Group
  • Update an Instance Group
  • Update an Instance Group
• Instances
  • Create an Instance Group for an Instance
  • List Instance Groups for an Instance
  • List Instances
  • List Unified Jobs for an Instance
  • Instances Health Check Create
  • Instances Health Check List
  • Instances Partial Update
  • Instances Read
  • Instances Update
• Inventories
  • Create a Group for an Inventory
  • Create a Host for an Inventory
  • Create an Ad Hoc Command for an Inventory
  • Create an Instance Group for an Inventory
  • Create an Inventory
  • Create an Inventory Source for an Inventory
  • Delete an Inventory
  • Group Tree for an Inventory
  • List Activity Streams for an Inventory
  • List Ad Hoc Commands for an Inventory
  • List Groups for an Inventory
  • List Hosts for an Inventory
  • List Instance Groups for an Inventory
  • List Inventories
  • List Inventory Sources for an Inventory
  • List Job Templates for an Inventory
  • List Roles for an Inventory
  • List Root Groups for an Inventory
  • List Users
  • Retrieve an Inventory
  • Retrieve Inventory Variable Data
  • Update an Inventory
  • Update an Inventory
  • Update Inventory Sources
  • Update Inventory Sources
  • Update Inventory Variable Data
  • Update Inventory Variable Data
  • Generate Inventory Group and Host Data as Needed for an Inventory Script.
  • Inventories Copy Create
  • Inventories Copy List
  • Inventories Root Groups Create
• Inventory Sources
  • Create a Credential for an Inventory Source
  • Create a Group for an Inventory Source
  • Create a Host for an Inventory Source
  • Create a Notification Template for an Inventory Source
  • Create a Notification Template for an Inventory Source
  • Create a Notification Template for an Inventory Source
  • Create a Schedule for an Inventory Source
  • Create an Inventory Source
  • Delete an Inventory Source
  • List Activity Streams for an Inventory Source
  • List Credentials for an Inventory Source
  • List Groups for an Inventory Source
  • List Hosts for an Inventory Source
  • List Inventory Sources
  • List Inventory Updates for an Inventory Source
  • List Notification Templates for an Inventory Source
  • List Notification Templates for an Inventory Source
  • List Notification Templates for an Inventory Source
  • List Schedules for an Inventory Source
  • Retrieve an Inventory Source
  • Update an Inventory Source
  • Update an Inventory Source
  • Update Inventory Source
  • Update Inventory Source
• Inventory Updates
  • Delete an Inventory Update
  • List Credentials for an Inventory Update
  • List Inventory Update Events for an Inventory Update
  • List Inventory Updates
  • List Notifications for an Inventory Update
  • Retrieve an Inventory Update
  • Retrieve an Inventory Update
  • Retrieve an Inventory Update
  • Retrieve Inventory Update Stdout
• Job Events
  • List Job Events for a Job Event
  • Retrieve a Job Event
• Job Host Summaries
  • Retrieve a Job Host Summary
• Job Templates
  • Create a Credential for a Job Template
  • Create a Job Template
  • Create a Label for a Job Template
  • Create a Notification Template for a Job Template
  • Create a Notification Template for a Job Template
  • Create a Notification Template for a Job Template
  • Create a Schedule for a Job Template
  • Create a Workflow Job for a Job Template
  • Create an Instance Group for a Job Template
  • Delete a Job Template
  • List Activity Streams for a Job Template
  • List Credentials for a Job Template
  • List Instance Groups for a Job Template
  • List Job Templates
  • List Jobs for a Job Template
  • List Labels for a Job Template
  • List Notification Templates for a Job Template
  • List Notification Templates for a Job Template
  • List Notification Templates for a Job Template
  • List Roles for a Job Template
  • List Schedules for a Job Template
  • List Users
  • List Workflow Jobs for a Job Template
  • Retrieve a Job Template
  • Update a Job Template
  • Update a Job Template
  • Job Templates Copy Create
  • Job Templates Copy List
  • Job Templates Github Create
  • Job Templates Gitlab Create
  • Job Templates Webhook Key Create
  • Job Templates Webhook Key List
  • Launch a Job Template
  • Launch a Job Template
  • POST Requests to This Resource Should Include the Full Specification for a Job Template's Survey
  • POST Requests to This Resource Should Include the Full Specification for a Job Template's Survey
  • POST Requests to This Resource Should Include the Full Specification for a Job Template's Survey
  • The Job Template Callback Allows for Ephemeral Hosts to Launch a New Job.
  • The Job Template Callback Allows for Ephemeral Hosts to Launch a New Job.
• Jobs
  • Cancel a Job
  • Delete a Job
  • Determine if a Job Can Be Canceled
  • List Activity Streams for a Job
  • List Credentials for a Job
  • List Job Events for a Job
  • List Job Host Summaries for a Job
  • List Jobs
  • List Labels for a Job
  • List Notifications for a Job
  • Retrieve a Job Host Summary
  • Retrieve Job Stdout
  • Create a Schedule Based on a Job
  • Create a Schedule Based on a Job
  • Relaunch a Job
  • Relaunch a Job
• Labels
  • Create a Label
  • List Labels
  • Retrieve a Label
  • Update a Label
  • Update a Label
• Metrics
  • Show Metrics Details
• Notification Templates
  • Create a Notification Template
  • Delete a Notification Template
  • List Notification Templates
  • List Notifications for a Notification Template
  • Retrieve a Notification Template
  • Update a Notification Template
  • Update a Notification Template
  • Notification Templates Copy Create
  • Notification Templates Copy List
  • Test a Notification Template
• Notifications
  • List Notifications
  • Retrieve a Notification
• Organizations
  • Create a Credential for an Organization
  • Create a Credential for an Organization
  • Create a Job Template for an Organization
  • Create a Notification Template for an Organization
  • Create a Notification Template for an Organization
  • Create a Notification Template for an Organization
  • Create a Notification Template for an Organization
  • Create a Notification Template for an Organization
  • Create a Project for an Organization
  • Create a Team for an Organization
  • Create a User for an Organization
  • Create a Workflow Job Template for an Organization
  • Create an Admin User for an Organization
  • Create an Application for an Organization
  • Create an Execution Environment for an Organization
  • Create an Instance Group for an Organization
  • Create an Organization
  • Delete an Organization
  • List Activity Streams for an Organization
  • List Admin Users for an Organization
  • List Applications for an Organization
  • List Credentials for an Organization
  • List Credentials for an Organization
  • List Execution Environments for an Organization
  • List Instance Groups for an Organization
  • List Inventories for an Organization
  • List Job Templates for an Organization
  • List Notification Templates for an Organization
  • List Notification Templates for an Organization
  • List Notification Templates for an Organization
  • List Notification Templates for an Organization
  • List Notification Templates for an Organization
  • List Organizations
  • List Projects for an Organization
  • List Roles for an Organization
  • List Teams for an Organization
  • List Users
  • List Users for an Organization
  • List Workflow Job Templates for an Organization
  • Retrieve an Organization
  • Update an Organization
  • Update an Organization
• Project Updates
  • Cancel Project Update
  • Cancel Project Update
  • Delete a Project Update
  • List Inventory Updates for a Project Update
  • List Notifications for a Project Update
  • List Project Update Events for a Project Update
  • List Project Updates
  • Retrieve a Project Update
  • Retrieve Project Update Stdout
• Projects
  • Create a Notification Template for a Project
  • Create a Notification Template for a Project
  • Create a Notification Template for a Project
  • Create a Project
  • Create a Schedule for a Project
  • Delete a Project
  • List Activity Streams for a Project
  • List Inventory Sources for a Project
  • List Notification Templates for a Project
  • List Notification Templates for a Project
  • List Notification Templates for a Project
  • List Project Updates for a Project
  • List Projects
  • List Roles for a Project
  • List Schedules for a Project
  • List Teams
  • List Users
  • Retrieve a Project
  • Retrieve a Project
  • Retrieve Project Playbooks
  • Update a Project
  • Update a Project
  • Update Project
  • Update Project
  • Projects Copy Create
  • Projects Copy List
• Roles
  • Create a Team for a Role
  • Create a User for a Role
  • List Roles
  • List Roles for a Role
  • List Roles for a Role
  • List Teams for a Role
  • List Users for a Role
  • Retrieve a Role
• Schedules
  • Create a Credential for a Schedule
  • Delete a Schedule
  • List Credentials for a Schedule
  • List Schedules
  • List Unified Jobs for a Schedule
  • Retrieve a Schedule
  • Update a Schedule
  • Update a Schedule
  • Schedule Details
  • Schedules Preview Create
  • Schedules Zoneinfo List
• Settings
  • Delete a Setting
  • List Settings
  • Retrieve a Setting
  • Test Logging Configuration
  • Update a Setting
  • Update a Setting
• System Configuration
  • Config Attach Create
  • Config Create
  • Config Delete
  • Config Subscriptions Create
  • List Enabled Single-Sign-on Endpoints
  • Make a GET Request to This Resource to Obtain a List All Receptor Nodes and Their Links.
  • Return Some Basic Information About This Instance
  • Return Various Sitewide Configuration Settings
• System Job Templates
  • Create a Notification Template for a System Job Template
  • Create a Notification Template for a System Job Template
  • Create a Notification Template for a System Job Template
  • Create a Schedule for a System Job Template
  • List Notification Templates for a System Job Template
  • List Notification Templates for a System Job Template
  • List Notification Templates for a System Job Template
  • List Schedules for a System Job Template
  • List System Job Templates
  • List System Jobs for a System Job Template
  • Retrieve a System Job Template
  • Launch a Job Template
  • Launch a Job Template
• System Jobs
  • Delete a System Job
  • List Notifications for a System Job
  • List System Job Events for a System Job
  • List System Jobs
  • Retrieve a System Job
  • Retrieve a System Job
  • Retrieve a System Job
• Teams
  • Associate Roles With This Team
  • Create a Credential for a Team
  • Create a Team
  • Create a User for a Team
  • Delete a Team
  • List Activity Streams for a Team
  • List Credentials for a Team
  • List Projects for a Team
  • List Roles for a Team
  • List Roles for a Team
  • List Teams
  • List Users
  • List Users for a Team
  • Retrieve a Team
  • Update a Team
  • Update a Team
• Unified Job Templates
  • List Unified Job Templates
• Unified Jobs
  • List Unified Jobs
• Users
  • Associate Roles With This User
  • Create a Credential for a User
  • Create a User
  • Create an Access Token for a User
  • Create an Access Token for a User
  • Create an Access Token for a User
  • Create an Application
  • Delete a User
  • List Access Tokens for a User
  • List Access Tokens for a User
  • List Access Tokens for a User
  • List Activity Streams for a User
  • List Applications
  • List Credentials for a User
  • List Organizations Administered by This User
  • List Organizations for a User
  • List Projects for a User
  • List Roles for a User
  • List Teams for a User
  • List Users
  • List Users
  • Retrieve a User
  • Retrieve Information About the Current User
  • Update a User
  • Update a User
• Versioning
  • List Supported API Versions
  • List Top Level Resources
• Workflow Approval Templates
  • Delete a Workflow Approval Template
  • List Workflow Approvals for a Workflow Approval Template
  • Retrieve a Workflow Approval Template
  • Update a Workflow Approval Template
  • Update a Workflow Approval Template
• Workflow Approvals
  • Create a Workflow Approval
  • Delete a Workflow Approval
  • List Workflow Approvals
  • Retrieve a Workflow Approval
  • Retrieve a Workflow Approval
  • Retrieve a Workflow Approval
  • Retrieve a Workflow Approval
  • Retrieve a Workflow Approval
• Workflow Job Nodes
  • List Credentials for a Workflow Job Node
  • List Workflow Job Nodes
  • List Workflow Job Nodes for a Workflow Job Node
  • List Workflow Job Nodes for a Workflow Job Node
  • List Workflow Job Nodes for a Workflow Job Node
  • Retrieve a Workflow Job Node
• Workflow Job Template Nodes
  • Create a Credential for a Workflow Job Template Node
  • Create a Workflow Job Template Node
  • Create a Workflow Job Template Node for a Workflow Job Template Node
  • Create a Workflow Job Template Node for a Workflow Job Template Node
  • Create a Workflow Job Template Node for a Workflow Job Template Node
  • Delete a Workflow Job Template Node
  • List Credentials for a Workflow Job Template Node
  • List Workflow Job Template Nodes
  • List Workflow Job Template Nodes for a Workflow Job Template Node
  • List Workflow Job Template Nodes for a Workflow Job Template Node
  • List Workflow Job Template Nodes for a Workflow Job Template Node
  • Retrieve a Workflow Job Template Node
  • Retrieve a Workflow Job Template Node
  • Retrieve a Workflow Job Template Node
  • Update a Workflow Job Template Node
  • Update a Workflow Job Template Node
• Workflow Job Templates
  • Create a Label for a Workflow Job Template
  • Create a Notification Template for a Workflow Job Template
  • Create a Notification Template for a Workflow Job Template
  • Create a Notification Template for a Workflow Job Template
  • Create a Notification Template for a Workflow Job Template
  • Create a Schedule for a Workflow Job Template
  • Create a Workflow Job Template
  • Delete a Workflow Job Template
  • List Activity Streams for a Workflow Job Template
  • List Labels for a Workflow Job Template
  • List Notification Templates for a Workflow Job Template
  • List Notification Templates for a Workflow Job Template
  • List Notification Templates for a Workflow Job Template
  • List Notification Templates for a Workflow Job Template
  • List Roles for a Workflow Job Template
  • List Schedules for a Workflow Job Template
  • List Users
  • List Workflow Job Templates
  • List Workflow Jobs for a Workflow Job Template
  • Retrieve a Workflow Job Template
  • Update a Workflow Job Template
  • Update a Workflow Job Template
  • Workflow Job Template Workflow Node List
  • Workflow Job Template Workflow Node List
  • Copy a Workflow Job Template
  • Copy a Workflow Job Template
  • Launch a Workflow Job Template
  • Launch a Workflow Job Template
  • POST Requests to This Resource Should Include the Full Specification for a Workflow Job Template's Survey
  • POST Requests to This Resource Should Include the Full Specification for a Workflow Job Template's Survey
  • POST Requests to This Resource Should Include the Full Specification for a Workflow Job Template's Survey
  • Workflow Job Templates Github Create
  • Workflow Job Templates Gitlab Create
  • Workflow Job Templates Webhook Key Create
  • Workflow Job Templates Webhook Key List
• Workflow Jobs
  • Cancel Workflow Job
  • Cancel Workflow Job
  • Delete a Workflow Job
  • List Activity Streams for a Workflow Job
  • List Labels for a Workflow Job
  • List Notifications for a Workflow Job
  • List Workflow Job Nodes for a Workflow Job
  • List Workflow Jobs
  • Retrieve a Workflow Job
  • Relaunch a Workflow Job
  • Relaunch a Workflow Job