Red Hat Ansible Automation Controller API is one of 7 APIs that Red Hat Ansible Automation Platform publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Automation, Controller, Enterprise, and REST. The published artifact set on APIs.io includes API documentation, an API reference, authentication docs, and an OpenAPI specification.
This API exposes
632 operations
across 379 paths,
organized into 62 resource areas,
and defines 247 schemas.
It is described by OpenAPI 3.0.3, at version v2.
Requests are made against the base URL https://controller-host/api/v2/.
The identity and technical contract details declared by the specification.
ActivityStream
object
13 properties
3 required
AdHocCommandCancel
object
1 property
AdHocCommandDetail
object
38 properties
AdHocCommandEvent
object
21 properties
1 required
AdHocCommandList
object
32 properties
AdHocCommandListRequest
object
12 properties
AnsibleFacts
object
9 properties
1 required
BulkHost
object
5 properties
1 required
BulkHostCreateRequest
object
2 properties
2 required
BulkHostDeleteRequest
object
1 property
1 required
BulkHostRequest
object
5 properties
1 required
BulkJobLaunchRequest
object
10 properties
1 required
BulkJobNode
object
32 properties
1 required
BulkJobNodeRequest
object
22 properties
1 required
ConstructedInventory
object
26 properties
2 required
ConstructedInventoryRequest
object
10 properties
2 required
Copy
object
1 property
1 required
CopyRequest
object
1 property
1 required
Credential
object
16 properties
2 required
CredentialInputSource
object
12 properties
3 required
CredentialInputSourceRequest
object
5 properties
3 required
CredentialRequest
object
5 properties
2 required
CredentialSerializerCreate
object
16 properties
2 required
CredentialSerializerCreateRequest
object
7 properties
2 required
CredentialType
object
14 properties
2 required
CredentialTypeRequest
object
5 properties
2 required
DABContentType
object
6 properties
2 required
DABPermission
object
4 properties
2 required
ExecutionEnvironment
object
14 properties
2 required
ExecutionEnvironmentRequest
object
6 properties
2 required
FeatureFlagStates
object
Serialize list of feature flags
2 properties
1 required
Group
object
11 properties
2 required
GroupRequest
object
4 properties
2 required
GroupTree
object
12 properties
2 required
GroupVariableData
object
1 property
GroupVariableDataRequest
object
1 property
Host
object
18 properties
2 required
HostMetric
object
10 properties
2 required
HostMetricSummaryMonthly
object
7 properties
HostRequest
object
6 properties
2 required
HostVariableData
object
1 property
HostVariableDataRequest
object
1 property
Instance
object
36 properties
1 required
InstanceGroup
object
22 properties
1 required
InstanceGroupRequest
object
9 properties
1 required
InstanceHealthCheck
object
11 properties
InstanceRequest
object
9 properties
1 required
Inventory
object
23 properties
2 required
InventoryRequest
object
8 properties
2 required
InventorySource
object
34 properties
3 required
InventorySourceRequest
object
20 properties
3 required
InventorySourceUpdate
object
1 property
InventoryUpdateCancel
object
1 property
InventoryUpdateDetail
object
50 properties
2 required
InventoryUpdateEvent
object
19 properties
InventoryUpdateList
object
44 properties
2 required
InventoryVariableData
object
1 property
InventoryVariableDataRequest
object
1 property
JobCancel
object
1 property
JobCreateSchedule
object
2 properties
JobDetail
object
59 properties
1 required
JobEvent
object
27 properties
1 required
JobHostSummary
object
20 properties
JobLaunch
object
24 properties
JobLaunchRequest
object
17 properties
JobList
object
51 properties
1 required
JobRelaunch
object
2 properties
JobRelaunchRequest
object
3 properties
JobTemplate
object
Provide recent jobs and survey details in summaryfields
57 properties
1 required
JobTemplateRequest
object
Provide recent jobs and survey details in summaryfields
44 properties
1 required
Label
object
9 properties
2 required
LabelRequest
object
2 properties
2 required
Notification
object
15 properties
1 required
NotificationTemplate
object
13 properties
3 required
NotificationTemplateRequest
object
6 properties
3 required
Organization
object
13 properties
1 required
OrganizationCredentialSerializerCreate
object
16 properties
2 required
OrganizationCredentialSerializerCreateRequest
object
5 properties
2 required
OrganizationRequest
object
5 properties
1 required
PaginatedActivityStreamList
object
4 properties
2 required
PaginatedAdHocCommandEventList
object
4 properties
2 required
PaginatedAdHocCommandListList
object
4 properties
2 required
PaginatedConstructedInventoryList
object
4 properties
2 required
PaginatedCredentialInputSourceList
object
4 properties
2 required
PaginatedCredentialList
object
4 properties
2 required
PaginatedCredentialSerializerCreateList
object
4 properties
2 required
PaginatedCredentialTypeList
object
4 properties
2 required
PaginatedDABContentTypeList
object
4 properties
2 required
PaginatedDABPermissionList
object
4 properties
2 required
PaginatedExecutionEnvironmentList
object
4 properties
2 required
PaginatedFeatureFlagStatesList
object
4 properties
2 required
PaginatedGroupList
object
4 properties
2 required
PaginatedHostList
object
4 properties
2 required
PaginatedHostMetricList
object
4 properties
2 required
PaginatedHostMetricSummaryMonthlyList
object
4 properties
2 required
PaginatedInstanceGroupList
object
4 properties
2 required
PaginatedInstanceList
object
4 properties
2 required
PaginatedInventoryList
object
4 properties
2 required
PaginatedInventorySourceList
object
4 properties
2 required
PaginatedInventoryUpdateEventList
object
4 properties
2 required
PaginatedInventoryUpdateListList
object
4 properties
2 required
PaginatedJobEventList
object
4 properties
2 required
PaginatedJobHostSummaryList
object
4 properties
2 required
PaginatedJobListList
object
4 properties
2 required
PaginatedJobTemplateList
object
4 properties
2 required
PaginatedLabelList
object
4 properties
2 required
PaginatedNotificationList
object
4 properties
2 required
PaginatedNotificationTemplateList
object
4 properties
2 required
PaginatedOrganizationCredentialSerializerCreateList
object
4 properties
2 required
PaginatedProjectList
object
4 properties
2 required
PaginatedProjectUpdateEventList
object
4 properties
2 required
PaginatedProjectUpdateListList
object
4 properties
2 required
PaginatedReceptorAddressList
object
4 properties
2 required
PaginatedResourceAccessListElementList
object
4 properties
2 required
PaginatedResourceListList
object
4 properties
2 required
PaginatedResourceTypeList
object
4 properties
2 required
PaginatedRoleDefinitionList
object
4 properties
2 required
PaginatedRoleList
object
4 properties
2 required
PaginatedRoleSerializerWithParentAccessList
object
4 properties
2 required
PaginatedRoleTeamAssignmentList
object
4 properties
2 required
PaginatedRoleUserAssignmentList
object
4 properties
2 required
PaginatedScheduleList
object
4 properties
2 required
PaginatedServiceRoleTeamAssignmentList
object
4 properties
2 required
PaginatedServiceRoleUserAssignmentList
object
4 properties
2 required
PaginatedSettingCategoryList
object
4 properties
2 required
PaginatedSystemJobEventList
object
4 properties
2 required
PaginatedSystemJobListList
object
4 properties
2 required
PaginatedSystemJobTemplateList
object
4 properties
2 required
PaginatedTeamAccessAssignmentList
object
4 properties
2 required
PaginatedTeamAccessViewSet_Team_List
object
4 properties
2 required
PaginatedTeamCredentialSerializerCreateList
object
4 properties
2 required
PaginatedTeamList
object
4 properties
2 required
PaginatedUnifiedJobListList
object
4 properties
2 required
PaginatedUnifiedJobTemplateList
object
4 properties
2 required
PaginatedUserAccessAssignmentList
object
4 properties
2 required
PaginatedUserAccessViewSet_User_List
object
4 properties
2 required
PaginatedUserCredentialSerializerCreateList
object
4 properties
2 required
PaginatedUserList
object
4 properties
2 required
PaginatedWorkflowApprovalListList
object
4 properties
2 required
PaginatedWorkflowJobListList
object
4 properties
2 required
PaginatedWorkflowJobNodeListList
object
4 properties
2 required
PaginatedWorkflowJobTemplateList
object
4 properties
2 required
PaginatedWorkflowJobTemplateNodeList
object
4 properties
2 required
PatchedConstructedInventoryRequest
object
10 properties
PatchedCredentialInputSourceRequest
object
5 properties
PatchedCredentialRequest
object
5 properties
PatchedCredentialTypeRequest
object
5 properties
PatchedExecutionEnvironmentRequest
object
6 properties
PatchedGroupRequest
object
4 properties
PatchedGroupVariableDataRequest
object
1 property
PatchedHostRequest
object
6 properties
PatchedHostVariableDataRequest
object
1 property
PatchedInstanceGroupRequest
object
9 properties
PatchedInstanceRequest
object
9 properties
PatchedInventoryRequest
object
8 properties
PatchedInventorySourceRequest
object
20 properties
PatchedInventoryVariableDataRequest
object
1 property
PatchedJobTemplateRequest
object
Provide recent jobs and survey details in summaryfields
44 properties
PatchedLabelRequest
object
2 properties
PatchedNotificationTemplateRequest
object
6 properties
PatchedOrganizationRequest
object
5 properties
PatchedProjectRequest
object
18 properties
PatchedResourceRequest
object
5 properties
PatchedRoleDefinitionRequest
object
4 properties
PatchedScheduleRequest
object
18 properties
PatchedSettingSingletonRequest
object
Present a group of settings (by category) as a single object.
103 properties
PatchedTeamRequest
object
3 properties
PatchedUserRequest
object
7 properties
PatchedWorkflowApprovalTemplateRequest
object
4 properties
PatchedWorkflowJobTemplateNodeDetailRequest
object
Influence the api browser sample data to not include workflowjobtemplate when editing a WorkflowNode. Note: I was not able to accomplish this through the use o…
17 properties
PatchedWorkflowJobTemplateRequest
object
Provide recent jobs and survey details in summaryfields
20 properties
Project
object
33 properties
1 required
ProjectInventories
object
1 property
ProjectPlaybooks
object
1 property
ProjectRequest
object
18 properties
1 required
ProjectUpdateCancel
object
1 property
ProjectUpdateDetail
object
43 properties
1 required
ProjectUpdateEvent
object
25 properties
1 required
ProjectUpdateList
object
36 properties
1 required
ProjectUpdateView
object
1 property
ReceptorAddress
object
11 properties
2 required
Resource
object
10 properties
1 required
ResourceAccessListElement
object
15 properties
1 required
ResourceList
object
8 properties
ResourceRequest
object
5 properties
1 required
ResourceType
object
5 properties
1 required
RoleDefinition
object
13 properties
2 required
RoleDefinitionDetail
object
13 properties
2 required
RoleDefinitionDetailRequest
object
3 properties
2 required
RoleDefinitionRequest
object
4 properties
2 required
RoleMetadata
object
1 property
1 required
RoleSerializerWithParentAccess
object
7 properties
RoleTeamAssignment
object
12 properties
1 required
RoleTeamAssignmentRequest
object
5 properties
1 required
RoleUserAssignment
object
12 properties
1 required
Schedule
object
30 properties
3 required
SchedulePreview
object
1 property
1 required
SchedulePreviewRequest
object
1 property
1 required
ScheduleRequest
object
18 properties
3 required
ServiceRoleTeamAssignment
object
8 properties
2 required
ServiceRoleTeamAssignmentRequest
object
5 properties
2 required
ServiceRoleUserAssignment
object
8 properties
2 required
ServiceRoleUserAssignmentRequest
object
5 properties
2 required
SettingCategory
object
Serialize setting category
3 properties
SettingSingleton
object
Present a group of settings (by category) as a single object.
111 properties
SettingSingletonRequest
object
Present a group of settings (by category) as a single object.
103 properties
SystemJob
object
31 properties
1 required
SystemJobCancel
object
1 property
SystemJobEvent
object
19 properties
SystemJobList
object
26 properties
1 required
SystemJobTemplate
object
15 properties
1 required
Team
object
10 properties
2 required
TeamAccessAssignment
object
12 properties
1 required
TeamAccessViewSet_Team_
object
6 properties
2 required
TeamCredentialSerializerCreate
object
15 properties
2 required
TeamCredentialSerializerCreateRequest
object
5 properties
2 required
TeamRequest
object
3 properties
2 required
UnifiedJobList
object
23 properties
1 required
UnifiedJobStdout
object
1 property
UnifiedJobTemplate
object
14 properties
1 required
User
object
15 properties
1 required
UserAccessAssignment
object
13 properties
1 required
UserAccessViewSet_User_
object
controller uses auth.User model so this needs to be as compatible as possible, thus ModelSerializer
8 properties
1 required
UserCredentialSerializerCreate
object
15 properties
2 required
UserCredentialSerializerCreateRequest
object
5 properties
2 required
UserRequest
object
7 properties
1 required
WorkflowApproval
object
29 properties
1 required
WorkflowApprovalList
object
24 properties
1 required
WorkflowApprovalTemplate
object
15 properties
1 required
WorkflowApprovalTemplateRequest
object
4 properties
1 required
WorkflowJob
object
37 properties
1 required
WorkflowJobCancel
object
1 property
WorkflowJobLaunch
object
14 properties
WorkflowJobLaunchRequest
object
7 properties
WorkflowJobList
object
33 properties
1 required
WorkflowJobListRequest
object
15 properties
1 required
WorkflowJobNodeDetail
object
29 properties
WorkflowJobNodeList
object
29 properties
WorkflowJobTemplate
object
Provide recent jobs and survey details in summaryfields
31 properties
1 required
WorkflowJobTemplateNode
object
27 properties
1 required
WorkflowJobTemplateNodeCreateApproval
object
3 properties
1 required
WorkflowJobTemplateNodeCreateApprovalRequest
object
3 properties
1 required
WorkflowJobTemplateNodeDetail
object
Influence the api browser sample data to not include workflowjobtemplate when editing a WorkflowNode. Note: I was not able to accomplish this through the use o…
27 properties
1 required
WorkflowJobTemplateNodeDetailRequest
object
Influence the api browser sample data to not include workflowjobtemplate when editing a WorkflowNode. Note: I was not able to accomplish this through the use o…
17 properties
1 required
WorkflowJobTemplateNodeRequest
object
17 properties
1 required
WorkflowJobTemplateRequest
object
Provide recent jobs and survey details in summaryfields
20 properties
1 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Red Hat Ansible Automation Platform publishes across the network.