How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Harness Ansible API

Ansible Service handles the API for ansible entities.

Harness Ansible API is one of 488 APIs that Harness publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Ansible. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and rate-limit docs.

This API exposes 44 operations across 29 paths, and defines 69 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://app.harness.io, https://{vanity}.

44 operations 29 paths 69 schemas 5 DELETE21 GET10 POST8 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://app.harness.io
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Harness Ansible API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-key (x-api-key). By default, every request must be authenticated.

  • x-api-key — API key is a token provided while making the API calls. This is used to authenticate the client at the exposed endpoint.

Paths & Operations 44

Across 29 paths, the API surfaces 44 operations — 5 DELETE, 21 GET, 10 POST, 8 PUT. Each is listed below with its method, path, parameters, and response codes.

ansible 44

Ansible Service handles the API for ansible entities.

GET
/iacm/api/orgs/{org}/projects/{project}/ansible/activities
List Ansible Activities
ansible#list-ansible-activities 10 params → 200400401403404408409423
GET
/iacm/api/orgs/{org}/projects/{project}/ansible/activities/{id}
Show ansible activity
ansible#show-ansible-activity 4 params → 200400401403404408409423
GET
/iacm/api/orgs/{org}/projects/{project}/ansible/data
List data
ansible#list-data 10 params → 200400401403404408409423
POST
/iacm/api/orgs/{org}/projects/{project}/ansible/data
Create data
ansible#create-data 11 params → 200400401403404408409423
GET
/iacm/api/orgs/{org}/projects/{project}/ansible/data/{id}
Show data
ansible#show-data 4 params → 200400401403404408409423
POST
/iacm/api/orgs/{org}/projects/{project}/ansible/events
Send event
ansible#send-ansible-event 3 params body → 200400401403404408409423
GET
/iacm/api/orgs/{org}/projects/{project}/ansible/file
Get Ansible file
ansible#get-file 5 params → 200400401403404408409423
GET
/iacm/api/orgs/{org}/projects/{project}/ansible/hosts
List Ansible Hosts
ansible#list-hosts 11 params → 200400401403404408409423
GET
/iacm/api/orgs/{org}/projects/{project}/ansible/hosts/{id}
Show Ansible Host
ansible#show-host 4 params → 200400401403404408409423
GET
/iacm/api/orgs/{org}/projects/{project}/ansible/hosts/{id}/activities
List Ansible Host Activities
ansible#list-host-activities 7 params → 200400401403404408409423
GET
/iacm/api/orgs/{org}/projects/{project}/ansible/hosts/{id}/inventories
List Inventories For Host
ansible#list-host-inventories 6 params → 200400401403404408409423
GET
/iacm/api/orgs/{org}/projects/{project}/ansible/hosts/{id}/stats
Get Ansible Host Stats
ansible#get-host-stats 4 params → 200400401403404408409423
GET
/iacm/api/orgs/{org}/projects/{project}/ansible/hosts/export
Export Ansible Hosts to CSV
ansible#export-hosts-csv 8 params → 200400401403404408409423
GET
/iacm/api/orgs/{org}/projects/{project}/ansible/hosts/summary
Get Ansible Hosts Summary
ansible#get-hosts-summary 7 params → 200400401403404408409423
GET
/iacm/api/orgs/{org}/projects/{project}/ansible/inventory
List Ansible inventory
ansible#list-inventory 9 params → 200400401403404408409423
POST
/iacm/api/orgs/{org}/projects/{project}/ansible/inventory
Create Ansible inventory
ansible#create-inventory 3 params body → 201400401403404408409423
DELETE
/iacm/api/orgs/{org}/projects/{project}/ansible/inventory/{identifier}
Delete Ansible inventory
ansible#delete-inventory 4 params → 200400401403404408409423
GET
/iacm/api/orgs/{org}/projects/{project}/ansible/inventory/{identifier}
Show Ansible inventory
ansible#show-inventory 5 params → 200400401403404408409423
PUT
/iacm/api/orgs/{org}/projects/{project}/ansible/inventory/{identifier}
Update Ansible inventory
ansible#update-inventory 4 params body → 200400401403404408409423
GET
/iacm/api/orgs/{org}/projects/{project}/ansible/inventory/{identifier}/ansible
Show Ansible inventory as ansible compatible YAML
ansible#show-inventory-as-ansible 4 params → 200400401403404408409423
GET
/iacm/api/orgs/{org}/projects/{project}/ansible/inventory/{identifier}/groups
Show Ansible inventory groups
ansible#show-inventory-groups 6 params → 200400401403404408409423
GET
/iacm/api/orgs/{org}/projects/{project}/ansible/inventory/{identifier}/hosts
Show Ansible inventory hosts
ansible#show-inventory-hosts 7 params → 200400401403404408409423
POST
/iacm/api/orgs/{org}/projects/{project}/ansible/inventory/{identifier}/hosts
Create Ansible inventory host
ansible#create-inventory-host 4 params body → 201400401403404408409423
PUT
/iacm/api/orgs/{org}/projects/{project}/ansible/inventory/{identifier}/import
Replace Ansible static inventory data from YAML/INI
ansible#replace-inventory-from-import 4 params body → 200400401403404408409423
PUT
/iacm/api/orgs/{org}/projects/{project}/ansible/inventory/{identifier}/plugin
Update Ansible plugin inventory
ansible#update-inventory-plugin 4 params body → 200400401403404408409423
GET
/iacm/api/orgs/{org}/projects/{project}/ansible/inventory/{identifier}/vars
Show Ansible inventory vars
ansible#show-inventory-vars 6 params → 200400401403404408409423
POST
/iacm/api/orgs/{org}/projects/{project}/ansible/inventory/{identifier}/vars
Create Ansible inventory variables
ansible#create-inventory-vars 4 params body → 201400401403404408409423
PUT
/iacm/api/orgs/{org}/projects/{project}/ansible/inventory/{identifier}/vars
Update Ansible inventory variables
ansible#update-inventory-vars 4 params body → 200400401403404408409423
POST
/iacm/api/orgs/{org}/projects/{project}/ansible/inventory/{inventory_identifier}/groups
Create Ansible inventory group
ansible#create-inventory-group 4 params body → 201400401403404408409423
DELETE
/iacm/api/orgs/{org}/projects/{project}/ansible/inventory/{inventory_identifier}/groups/{identifier}
Delete Ansible inventory group
ansible#delete-inventory-group 5 params → 200400401403404408409423
PUT
/iacm/api/orgs/{org}/projects/{project}/ansible/inventory/{inventory_identifier}/groups/{identifier}
Update Ansible inventory group
ansible#update-inventory-group 5 params body → 200400401403404408409423
DELETE
/iacm/api/orgs/{org}/projects/{project}/ansible/inventory/{inventory_identifier}/hosts/{host_address}
Delete Ansible inventory host
ansible#delete-inventory-host 5 params → 200400401403404408409423
PUT
/iacm/api/orgs/{org}/projects/{project}/ansible/inventory/{inventory_identifier}/hosts/{host_address}
Update Ansible inventory host
ansible#update-inventory-host 5 params body → 200400401403404408409423
POST
/iacm/api/orgs/{org}/projects/{project}/ansible/inventory/import
Import Ansible static inventory from YAML/INI
ansible#import-inventory 3 params body → 201400401403404408409423
GET
/iacm/api/orgs/{org}/projects/{project}/ansible/playbook
List Ansible playbooks
ansible#list-playbooks 8 params → 200400401403404408409423
POST
/iacm/api/orgs/{org}/projects/{project}/ansible/playbook
Create Ansible playbook
ansible#create-playbook 3 params body → 201400401403404408409423
DELETE
/iacm/api/orgs/{org}/projects/{project}/ansible/playbook/{identifier}
Delete Ansible playbook
ansible#delete-playbook 4 params → 200400401403404408409423
GET
/iacm/api/orgs/{org}/projects/{project}/ansible/playbook/{identifier}
Show Ansible playbook
ansible#show-playbook 4 params → 200400401403404408409423
PUT
/iacm/api/orgs/{org}/projects/{project}/ansible/playbook/{identifier}
Update Ansible playbook
ansible#update-playbook 4 params body → 200400401403404408409423
DELETE
/iacm/api/orgs/{org}/projects/{project}/ansible/playbook/{identifier}/vars
Delete dynamic Ansible playbook variable
ansible#delete-playbook-vars 4 params body → 200400401403404408409423
GET
/iacm/api/orgs/{org}/projects/{project}/ansible/playbook/{identifier}/vars
Show Ansible playbook vars
ansible#show-playbook-vars 6 params → 200400401403404408409423
POST
/iacm/api/orgs/{org}/projects/{project}/ansible/playbook/{identifier}/vars
Create dynamic Ansible playbook variable
ansible#create-playbook-vars 4 params body → 201400401403404408409423
PUT
/iacm/api/orgs/{org}/projects/{project}/ansible/playbook/{identifier}/vars
Update dynamic Ansible playbook variable
ansible#update-playbook-vars 4 params body → 200400401403404408409423
POST
/iacm/api/orgs/{org}/projects/{project}/ansible/results
Publish results
ansible#publish-results 13 params → 200400401403404408409423

Schemas 69

The contract defines 69 schemas that model the data the API accepts and returns. The most detailed are CreatePlaybookResponse (19 properties), ShowPlaybookResponse (18 properties), HarnessIacmPlaybook (18 properties), AnsibleActivityMetadata (14 properties). Each schema is shown below with its type and property counts.

ReplaceInventoryFromImportRequest2
object
2 properties 2 required
PublishResultsResponse
object
1 property 1 required
AnsibleError
object
6 properties 6 required
InventoryVarResourceCollection
array
InventoryHostResourceCollection
array
IaCMPolicy
object
8 properties 8 required
CreateInventoryRequest
object
9 properties 4 required
GetHostStatsResponse
object
6 properties 4 required
UpdateInventoryPluginRequest
object
1 property 1 required
CreatePlaybookVarRequest
object
2 properties 1 required
UpdateInventoryGroupRequest
object
7 properties 1 required
ImportInventoryRequest2
object
5 properties 4 required
CreateInventoryResponse
object
11 properties 9 required
HostResourceCollection
array
ShowHostResponse
object
6 properties 4 required
HarnessIacmInventory
object
10 properties 9 required
ImportInventoryResponse
object
2 properties 2 required
GetHostsSummaryResponse
object
9 properties 9 required
AnsibleMetrics
object
Observability metrics for ansible playbook runs
11 properties
HarnessIacmHostactivity
object
11 properties 9 required
DeletePlaybookVarsRequest
object
1 property 1 required
CreatePlaybookResponse
object
19 properties 8 required
ShowInventoryHostsResponse
object
1 property
AnsibleEvaluationDetail
object
13 properties 13 required
HarnessIacmPlaybook
object
18 properties 8 required
AnsibleDataResourceCollection
array
CreateInventoryHostRequest
object
3 properties 1 required
CreateManualGroup
object
4 properties 2 required
UpdateInventoryHostRequest
object
2 properties
AnsiblePolicyViolationError
object
7 properties 6 required
InventoryResourceCollection
array
ShowInventoryVarsResponse
object
2 properties
UpdatePlaybookVarsRequest
object
2 properties 1 required
HarnessIacmHost
object
6 properties 4 required
HarnessIacmInventoryDetail
object
11 properties 9 required
UpdatePlaybookResponse
object
1 property
HostActivityResourceCollection
array
PluginOptions
object
pluginoptions defines how plugin inventory content is sourced (inline or git) plus provider connector info.
9 properties
ShowInventoryGroupsResponse
object
1 property
AnsibleVariable
object
AnsibleVariable is the representation for a single variable associated with ansible.
5 properties 3 required
HarnessIacmAnsibleactivity
object
9 properties 9 required
CreateAnsibleDataResponse
object
1 property 1 required
ShowPlaybookResponse
object
18 properties 8 required
CreateDynamicGroup
object
7 properties 4 required
AnsibleEvaluatedPolicy
object
5 properties 5 required
ShowAnsibleActivityResponse
object
9 properties 9 required
ResourcesSelectorConditions
object
3 properties 3 required
UpdateInventoryVarsRequest
object
2 properties 1 required
AnsibleActivityResourceCollection
array
ReplaceInventoryFromImportResponse
object
1 property 1 required
AnsibleActivityMetadata
object
14 properties
UpdateInventoryRequest
object
4 properties 3 required
HarnessIacmInventoryHost
object
5 properties 1 required
HarnessIacmAnsibledata
object
AnsibleDataResource is the representation for a single item of data associated with an ansible run.
12 properties 8 required
UpdatePlaybookRequest
object
12 properties 2 required
ShowInventoryResponse
object
11 properties 9 required
CreatePlaybookRequest
object
13 properties 3 required
AnsibleEvaluation
object
The result of a single evaluation
12 properties 12 required
InventoryDetailResourceCollection
array
HostLastActivity
object
HostLastActivity contains information about the most recent activity run on a host
3 properties 3 required
ShowPlaybookVarsResponse
object
2 properties
DynamicConfig
object
3 properties
HarnessIacmInventoryVar
object
8 properties 3 required
CreateInventoryGroupRequest
object
8 properties 2 required
SendAnsibleEventRequest
object
4 properties 3 required
PlaybookResourceCollection
array
UpdateInventoryResponse
object
1 property
HarnessIacmInventoryVarCreate
object
6 properties 3 required
CreateInventoryVarsRequest
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

harness-ansible-api-openapi.yml Raw ↑

Other APIs Harness publishes across the network.

Harness Continuous Integration API
Harness Continuous Delivery and GitOps API
Harness Feature Management and Experimentation API
Harness Cloud Cost Management API
Harness Chaos Engineering API
Harness Security Testing Orchestration API
Harness Internal Developer Portal API
Harness Code Repository API
Harness Service Reliability Management API
Harness Infrastructure as Code Management API
Harness Supply Chain Security API
Harness Software Engineering Insights API
Where this information came from

This is an independent, third-party profile of Harness Ansible API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.