Ansible
Ansible Service handles the API for ansible entities.
List all activities at account scope. Org and project scoped activities are not included.
Limit is the number of records to return for a page.
30Example: 30Page is the page number to return relative to the page 'limit'.
1Example: 1Sort order for results
created,DESCExample: created,ASCPossible values: Search term to filter by inventory identifier
inventory_1Search term to filter by playbook identifier
playbook_1Activity type filter
Et eos.Activity status filter
Esse nihil magnam dolorum dolores a.Account is the internal customer account ID.
s8OK response.
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/ansible/activities HTTP/1.1
Host: localhost:80
Harness-Account: s8
Accept: */*
[
{
"account": "mld",
"created": 1627590400,
"event_type": "activity-execution",
"id": "dc538c61-de48-4220-958c-5f3c4f983daa",
"inventories": "Sapiente dolorem.",
"metadata": {
"activity_status": "Dolorem amet quae.",
"filters": "tags=deploy skip-tags=slow limit=web",
"git_branch": "Quia aut eum dignissimos itaque.",
"git_commit_message": "Aspernatur assumenda eius sit vitae quos dolorem.",
"git_commit_sha": "Facilis et harum.",
"git_repo": "Iure reprehenderit.",
"metrics": {
"circuit_breaker_triggered": false,
"duration_ms": 3729912682196842500,
"host_changed": 7326503586878806000,
"host_failed": 510844048246640640,
"host_ok": 7033055310389248000,
"host_skipped": 8298202262197766000,
"host_unreachable": 3136096962125600300,
"output_size_bytes": 5580013020588243000,
"payload_size_bytes": 5024210113655448000,
"total_hosts": 3289931238796667000,
"total_tasks": 8463213749394180000
},
"pipeline": "Sint consequuntur libero commodi veritatis atque.",
"pipeline_execution_id": "Omnis autem ullam quas et.",
"pipeline_execution_number": "Rem cumque molestias assumenda.",
"pipeline_name": "Et accusamus veniam libero.",
"pipeline_stage_id": "Repellat soluta.",
"plugin_version": "Amet totam laboriosam voluptas.",
"results_uuid": "Officia necessitatibus quis provident consequatur.",
"trigger": {
"Alias quis.": "Quaerat quasi.",
"Autem aut.": "Quis ipsa est.",
"Qui et.": "Molestiae autem nisi."
}
},
"org": "12",
"playbooks": "Qui est.",
"project": "0"
},
{
"account": "mld",
"created": 1627590400,
"event_type": "activity-execution",
"id": "dc538c61-de48-4220-958c-5f3c4f983daa",
"inventories": "Sapiente dolorem.",
"metadata": {
"activity_status": "Dolorem amet quae.",
"filters": "tags=deploy skip-tags=slow limit=web",
"git_branch": "Quia aut eum dignissimos itaque.",
"git_commit_message": "Aspernatur assumenda eius sit vitae quos dolorem.",
"git_commit_sha": "Facilis et harum.",
"git_repo": "Iure reprehenderit.",
"metrics": {
"circuit_breaker_triggered": false,
"duration_ms": 3729912682196842500,
"host_changed": 7326503586878806000,
"host_failed": 510844048246640640,
"host_ok": 7033055310389248000,
"host_skipped": 8298202262197766000,
"host_unreachable": 3136096962125600300,
"output_size_bytes": 5580013020588243000,
"payload_size_bytes": 5024210113655448000,
"total_hosts": 3289931238796667000,
"total_tasks": 8463213749394180000
},
"pipeline": "Sint consequuntur libero commodi veritatis atque.",
"pipeline_execution_id": "Omnis autem ullam quas et.",
"pipeline_execution_number": "Rem cumque molestias assumenda.",
"pipeline_name": "Et accusamus veniam libero.",
"pipeline_stage_id": "Repellat soluta.",
"plugin_version": "Amet totam laboriosam voluptas.",
"results_uuid": "Officia necessitatibus quis provident consequatur.",
"trigger": {
"Alias quis.": "Quaerat quasi.",
"Autem aut.": "Quis ipsa est.",
"Qui et.": "Molestiae autem nisi."
}
},
"org": "12",
"playbooks": "Qui est.",
"project": "0"
},
{
"account": "mld",
"created": 1627590400,
"event_type": "activity-execution",
"id": "dc538c61-de48-4220-958c-5f3c4f983daa",
"inventories": "Sapiente dolorem.",
"metadata": {
"activity_status": "Dolorem amet quae.",
"filters": "tags=deploy skip-tags=slow limit=web",
"git_branch": "Quia aut eum dignissimos itaque.",
"git_commit_message": "Aspernatur assumenda eius sit vitae quos dolorem.",
"git_commit_sha": "Facilis et harum.",
"git_repo": "Iure reprehenderit.",
"metrics": {
"circuit_breaker_triggered": false,
"duration_ms": 3729912682196842500,
"host_changed": 7326503586878806000,
"host_failed": 510844048246640640,
"host_ok": 7033055310389248000,
"host_skipped": 8298202262197766000,
"host_unreachable": 3136096962125600300,
"output_size_bytes": 5580013020588243000,
"payload_size_bytes": 5024210113655448000,
"total_hosts": 3289931238796667000,
"total_tasks": 8463213749394180000
},
"pipeline": "Sint consequuntur libero commodi veritatis atque.",
"pipeline_execution_id": "Omnis autem ullam quas et.",
"pipeline_execution_number": "Rem cumque molestias assumenda.",
"pipeline_name": "Et accusamus veniam libero.",
"pipeline_stage_id": "Repellat soluta.",
"plugin_version": "Amet totam laboriosam voluptas.",
"results_uuid": "Officia necessitatibus quis provident consequatur.",
"trigger": {
"Alias quis.": "Quaerat quasi.",
"Autem aut.": "Quis ipsa est.",
"Qui et.": "Molestiae autem nisi."
}
},
"org": "12",
"playbooks": "Qui est.",
"project": "0"
}
]Show an individual account scoped ansible activity.
The unique ID for this activity
Id iure.Account is the internal customer account ID.
f8OK response.
Account is the internal customer account ID.
2rjTimestamp when the resource was created.
1627590400The type of event that occurred
activity-executionPossible values: The unique identifier for this activity
dc538c61-de48-4220-958c-5f3c4f983daaInventories associated with this event
Porro nihil non non ut omnis eaque.Org is the organisation identifier.
js5Playbooks associated with this event
Nihil hic consequuntur culpa in assumenda molestiae.Project is the project identifier.
xiBadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/ansible/activities/{id} HTTP/1.1
Host: localhost:80
Harness-Account: f8
Accept: */*
{
"account": "tmn",
"created": 1627590400,
"event_type": "activity-execution",
"id": "dc538c61-de48-4220-958c-5f3c4f983daa",
"inventories": "Quia qui aliquam dolores nemo.",
"metadata": {
"activity_status": "Asperiores quod molestiae consequatur vitae.",
"filters": "tags=deploy skip-tags=slow limit=web",
"git_branch": "Voluptas animi dolor dolorem laborum.",
"git_commit_message": "Dolor facere.",
"git_commit_sha": "Voluptatem quia earum voluptatem quas in.",
"git_repo": "Dolores nobis.",
"metrics": {
"circuit_breaker_triggered": false,
"duration_ms": 4956144492920646000,
"host_changed": 7991066862074085000,
"host_failed": 7286501368895138000,
"host_ok": 8723992317937321000,
"host_skipped": 7515790151550636000,
"host_unreachable": 1865379895225030100,
"output_size_bytes": 7964733890466916000,
"payload_size_bytes": 2592876429800924000,
"total_hosts": 7520422272859706000,
"total_tasks": 5767911488264385000
},
"pipeline": "Ex vel quaerat sunt minima dolor.",
"pipeline_execution_id": "Nulla ratione et omnis.",
"pipeline_execution_number": "Ipsum qui totam cum.",
"pipeline_name": "Et alias quis sint porro delectus est.",
"pipeline_stage_id": "Pariatur porro earum sed.",
"plugin_version": "Est laudantium.",
"results_uuid": "Quam repellat omnis eos aut.",
"trigger": {
"Id molestias.": "Beatae aut asperiores nulla."
}
},
"org": "h",
"playbooks": "Aut voluptas corporis similique nisi.",
"project": "zm"
}Get binary data generated by an account scoped ansible run.
The unique identifier for the data
dc538c61-de48-4220-958c-5f3c4f983daaAccount is the internal customer account ID.
weuOK response.
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/ansible/data/{id} HTTP/1.1
Host: localhost:80
Harness-Account: weu
Accept: */*
binaryRetrieve an account scoped playbook's YAML file from its configured git repository.
Type of ansible resource (playbook or inventory).
playbookPossible values: Identifier of the playbook or inventory.
my-playbookAccount is the internal customer account ID.
kOK response.
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/ansible/file?resource_type=playbook&identifier=my-playbook HTTP/1.1
Host: localhost:80
Harness-Account: k
Accept: */*
binaryList all playbooks at account scope. Org and project scoped playbooks are not included.
Limit is the number of records to return for a page.
30Example: 30Page is the page number to return relative to the page 'limit'.
1Example: 1Filter results by partial name match
""Example: mystaSort order for results
name,ASCExample: updated,DESCPossible values: Filter results by tags (OR logic, exact match)
["Eius vitae.","Molestiae tenetur consequuntur.","Ut et nihil soluta doloribus enim.","Iure asperiores."]Account is the internal customer account ID.
0rxOK response.
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/ansible/playbook HTTP/1.1
Host: localhost:80
Harness-Account: 0rx
Accept: */*
[
{
"account": "r",
"ansible_galaxy": true,
"ansible_galaxy_requirements_file": "requirements.yml",
"created": 1627590400,
"description": "Playbook for deploying web services to production",
"env_vars": "Rem reprehenderit qui dolore quo qui similique.",
"identifier": "Aspernatur repudiandae voluptate.",
"name": "test playbook",
"org": "7af",
"project": "yt",
"repository": "my-repo",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "my-connector",
"repository_path": "playbooks/",
"tags": [
"Sit dolores.",
"Voluptas facilis in est sunt veniam repudiandae.",
"Quas praesentium magni.",
"Rerum cumque sunt."
],
"updated": 1627686800,
"vars": "Et iste maiores consectetur doloribus autem laboriosam."
},
{
"account": "r",
"ansible_galaxy": true,
"ansible_galaxy_requirements_file": "requirements.yml",
"created": 1627590400,
"description": "Playbook for deploying web services to production",
"env_vars": "Rem reprehenderit qui dolore quo qui similique.",
"identifier": "Aspernatur repudiandae voluptate.",
"name": "test playbook",
"org": "7af",
"project": "yt",
"repository": "my-repo",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "my-connector",
"repository_path": "playbooks/",
"tags": [
"Sit dolores.",
"Voluptas facilis in est sunt veniam repudiandae.",
"Quas praesentium magni.",
"Rerum cumque sunt."
],
"updated": 1627686800,
"vars": "Et iste maiores consectetur doloribus autem laboriosam."
}
]Create a new playbook at account scope.
Account is the internal customer account ID.
ncpInstall Ansible Galaxy dependencies
falseExample: truePath to Ansible Galaxy requirements file
requirements.ymlDescription documents the playbook purpose and usage
Playbook for deploying web services to productionThe unique identifier for this playbook
Quia neque nemo dolores harum quam qui.Name is the human readable name
test playbookRepository is the name of the repository to use.
my-repoRepository Branch in which the playbook should be accessed.
mainRepository Commit/Tag in which the playbook should be accessed.
abc10edRepository Connector is the reference to the connector to use for this playbook.
my-connectorRepository Path is the path in which the playbook resides.
""Example: playbooks/Tags associated with the playbook
["Dolorum voluptatum.","Eveniet quo voluptatem.","Consectetur cumque magni."]Created response.
Account is the internal customer account ID.
vsInstall Ansible Galaxy dependencies
falseExample: truePath to Ansible Galaxy requirements file
requirements.ymlTimestamp when the resource was created.
1627590400Description documents the playbook purpose and usage
Playbook for deploying web services to productionThe environment vars in the playbook
Qui est.The unique identifier for this playbook
Neque tenetur repellendus.Name is the human readable name
test playbookOrg is the organisation identifier.
rProject is the project identifier.
cRepository is the name of the repository to use.
my-repoRepository Branch in which the playbook should be accessed.
mainRepository Commit/Tag in which the playbook should be accessed.
abc10edRepository Connector is the reference to the connector to use for this playbook.
my-connectorRepository Path is the path in which the playbook resides.
""Example: playbooks/Tags associated with the playbook
["A deserunt asperiores enim qui.","Rerum reprehenderit voluptas illum voluptas deserunt quisquam.","Quis et et at."]Timestamp when the resource was last updated.
1627686800The vars in the playbook
Aut architecto et qui.BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
POST /api/ansible/playbook HTTP/1.1
Host: localhost:80
Harness-Account: ncp
Content-Type: application/json
Accept: */*
Content-Length: 1469
{
"ansible_galaxy": true,
"ansible_galaxy_requirements_file": "requirements.yml",
"description": "Playbook for deploying web services to production",
"env_vars": {
"Animi numquam assumenda nostrum aut voluptatum nulla.": {
"file_name": "Enim facilis libero rerum.",
"key": "yv",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Optio ut dolorum dignissimos fuga nisi.",
"value_type": "Sit qui quam soluta consequatur."
},
"Quo sed nostrum aliquam occaecati recusandae quaerat.": {
"file_name": "Enim facilis libero rerum.",
"key": "yv",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Optio ut dolorum dignissimos fuga nisi.",
"value_type": "Sit qui quam soluta consequatur."
},
"Vero odio et non nihil a.": {
"file_name": "Enim facilis libero rerum.",
"key": "yv",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Optio ut dolorum dignissimos fuga nisi.",
"value_type": "Sit qui quam soluta consequatur."
}
},
"identifier": "Fuga voluptatem.",
"name": "test playbook",
"repository": "my-repo",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "my-connector",
"repository_path": "playbooks/",
"tags": [
"Vitae nesciunt illo minima enim.",
"Consequuntur mollitia optio.",
"Qui qui autem eius quisquam eum.",
"Quas deserunt tempore."
],
"vars": {
"Dolorum reiciendis voluptatem.": {
"file_name": "Enim facilis libero rerum.",
"key": "yv",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Optio ut dolorum dignissimos fuga nisi.",
"value_type": "Sit qui quam soluta consequatur."
}
}
}{
"account": "q",
"ansible_galaxy": false,
"ansible_galaxy_requirements_file": "requirements.yml",
"created": 1627590400,
"description": "Playbook for deploying web services to production",
"env_vars": "Esse autem natus qui molestiae.",
"identifier": "Inventore at occaecati nihil.",
"name": "test playbook",
"org": "4q",
"policy_evaluation": {
"account_id": "XRQAjvT37acOiXx9PRaQMF",
"action": "onrun",
"created": 1636370209475,
"details": [
{
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"action": "onrun",
"created": 1636669297674,
"description": "Captures critical production policies",
"details": [
{
"deny_messages": [
"deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}",
"policy": {
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
},
{
"deny_messages": [
"deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}",
"policy": {
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
}
],
"enabled": true,
"identifier": "policyset-1",
"name": "Production Policies",
"org_id": "test-org",
"project_id": "test-project",
"status": "error",
"type": "pipeline",
"updated": 1636669297674
},
{
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"action": "onrun",
"created": 1636669297674,
"description": "Captures critical production policies",
"details": [
{
"deny_messages": [
"deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}",
"policy": {
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
},
{
"deny_messages": [
"deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}",
"policy": {
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
}
],
"enabled": true,
"identifier": "policyset-1",
"name": "Production Policies",
"org_id": "test-org",
"project_id": "test-project",
"status": "error",
"type": "pipeline",
"updated": 1636669297674
},
{
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"action": "onrun",
"created": 1636669297674,
"description": "Captures critical production policies",
"details": [
{
"deny_messages": [
"deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}",
"policy": {
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
},
{
"deny_messages": [
"deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}",
"policy": {
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
}
],
"enabled": true,
"identifier": "policyset-1",
"name": "Production Policies",
"org_id": "test-org",
"project_id": "test-project",
"status": "error",
"type": "pipeline",
"updated": 1636669297674
}
],
"entity": "7bbca5d4-e9f2-4955-9b2a-019ec4d3645e",
"entity_metadata": "7bbca5d4-e9f2-4955-9b2a-019ec4d3645e",
"id": 123,
"input": "",
"org_id": "test-org",
"project_id": "test-project",
"status": "error",
"type": "pipeline,service"
},
"project": "z7",
"repository": "my-repo",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "my-connector",
"repository_path": "playbooks/",
"tags": [
"Veniam est qui minus minus.",
"Sed iure veniam vitae quo corporis quaerat.",
"Excepturi voluptatem est nihil."
],
"updated": 1627686800,
"vars": "Eveniet dolor tempora dignissimos saepe eum."
}Show an individual account scoped playbook.
The unique identifier for this playbook
Voluptate et harum voluptatem qui deleniti.Account is the internal customer account ID.
lOK response.
Account is the internal customer account ID.
0aiInstall Ansible Galaxy dependencies
falseExample: falsePath to Ansible Galaxy requirements file
requirements.ymlTimestamp when the resource was created.
1627590400Description documents the playbook purpose and usage
Playbook for deploying web services to productionThe environment vars in the playbook
Ea est tenetur est eos distinctio corporis.The unique identifier for this playbook
Quia quasi ipsa vero rerum possimus numquam.Name is the human readable name
test playbookOrg is the organisation identifier.
0Project is the project identifier.
fRepository is the name of the repository to use.
my-repoRepository Branch in which the playbook should be accessed.
mainRepository Commit/Tag in which the playbook should be accessed.
abc10edRepository Connector is the reference to the connector to use for this playbook.
my-connectorRepository Path is the path in which the playbook resides.
""Example: playbooks/Tags associated with the playbook
["Adipisci dolor.","Pariatur atque est odit quam placeat.","Omnis sint."]Timestamp when the resource was last updated.
1627686800The vars in the playbook
Quidem reprehenderit omnis dolore rerum autem.BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/ansible/playbook/{identifier} HTTP/1.1
Host: localhost:80
Harness-Account: l
Accept: */*
{
"account": "h",
"ansible_galaxy": false,
"ansible_galaxy_requirements_file": "requirements.yml",
"created": 1627590400,
"description": "Playbook for deploying web services to production",
"env_vars": "Corrupti ullam inventore tenetur.",
"identifier": "Corrupti quas.",
"name": "test playbook",
"org": "anm",
"project": "rn",
"repository": "my-repo",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "my-connector",
"repository_path": "playbooks/",
"tags": [
"Quis illo aut ipsa.",
"Quia dolor tempore temporibus at.",
"Ut aliquid perspiciatis exercitationem vero fugit corrupti."
],
"updated": 1627686800,
"vars": "Laboriosam eos assumenda et."
}Update an existing account scoped playbook.
The unique identifier for this playbook
Harum cupiditate deserunt fugit.Account is the internal customer account ID.
qInstall Ansible Galaxy dependencies
falseExample: truePath to Ansible Galaxy requirements file
requirements.ymlDescription documents the playbook purpose and usage
Playbook for deploying web services to productionName is the human readable name
test playbookRepository is the name of the repository to use.
my-repoRepository Branch in which the playbook should be accessed.
mainRepository Commit/Tag in which the playbook should be accessed.
abc10edRepository Connector is the reference to the connector to use for this playbook.
my-connectorRepository Path is the path in which the playbook resides.
""Example: playbooks/Tags associated with the playbook
["Omnis aut praesentium nisi.","Non ut."]OK response.
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
PUT /api/ansible/playbook/{identifier} HTTP/1.1
Host: localhost:80
Harness-Account: q
Content-Type: application/json
Accept: */*
Content-Length: 1213
{
"ansible_galaxy": true,
"ansible_galaxy_requirements_file": "requirements.yml",
"description": "Playbook for deploying web services to production",
"env_vars": {
"Dolor similique dolorum ullam.": {
"file_name": "Enim facilis libero rerum.",
"key": "yv",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Optio ut dolorum dignissimos fuga nisi.",
"value_type": "Sit qui quam soluta consequatur."
}
},
"name": "test playbook",
"repository": "my-repo",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "my-connector",
"repository_path": "playbooks/",
"tags": [
"Soluta beatae commodi.",
"Consequuntur velit libero quia autem architecto molestias.",
"Placeat optio soluta eligendi.",
"Voluptates minima itaque."
],
"vars": {
"Expedita labore aut asperiores ducimus.": {
"file_name": "Enim facilis libero rerum.",
"key": "yv",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Optio ut dolorum dignissimos fuga nisi.",
"value_type": "Sit qui quam soluta consequatur."
},
"Illo dignissimos consequatur iusto expedita eos.": {
"file_name": "Enim facilis libero rerum.",
"key": "yv",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Optio ut dolorum dignissimos fuga nisi.",
"value_type": "Sit qui quam soluta consequatur."
}
}
}{
"policy_evaluation": {
"account_id": "XRQAjvT37acOiXx9PRaQMF",
"action": "onrun",
"created": 1636370209475,
"details": [
{
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"action": "onrun",
"created": 1636669297674,
"description": "Captures critical production policies",
"details": [
{
"deny_messages": [
"deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}",
"policy": {
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
},
{
"deny_messages": [
"deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}",
"policy": {
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
}
],
"enabled": true,
"identifier": "policyset-1",
"name": "Production Policies",
"org_id": "test-org",
"project_id": "test-project",
"status": "error",
"type": "pipeline",
"updated": 1636669297674
},
{
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"action": "onrun",
"created": 1636669297674,
"description": "Captures critical production policies",
"details": [
{
"deny_messages": [
"deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}",
"policy": {
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
},
{
"deny_messages": [
"deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}",
"policy": {
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
}
],
"enabled": true,
"identifier": "policyset-1",
"name": "Production Policies",
"org_id": "test-org",
"project_id": "test-project",
"status": "error",
"type": "pipeline",
"updated": 1636669297674
},
{
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"action": "onrun",
"created": 1636669297674,
"description": "Captures critical production policies",
"details": [
{
"deny_messages": [
"deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}",
"policy": {
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
},
{
"deny_messages": [
"deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}",
"policy": {
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
}
],
"enabled": true,
"identifier": "policyset-1",
"name": "Production Policies",
"org_id": "test-org",
"project_id": "test-project",
"status": "error",
"type": "pipeline",
"updated": 1636669297674
}
],
"entity": "7bbca5d4-e9f2-4955-9b2a-019ec4d3645e",
"entity_metadata": "7bbca5d4-e9f2-4955-9b2a-019ec4d3645e",
"id": 123,
"input": "",
"org_id": "test-org",
"project_id": "test-project",
"status": "error",
"type": "pipeline,service"
}
}Delete an existing account scoped playbook.
The unique identifier for this playbook
Occaecati doloribus velit recusandae.Account is the internal customer account ID.
xOK response.
No content
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
DELETE /api/ansible/playbook/{identifier} HTTP/1.1
Host: localhost:80
Harness-Account: x
Accept: */*
No content
Show an individual account scoped playbook vars.
Playbook identifier
Ratione quasi non.Limit is the number of records to return for a page.
30Example: 30Page is the page number to return relative to the page 'limit'.
1Example: 1Account is the internal customer account ID.
ptoOK response.
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/ansible/playbook/{identifier}/vars HTTP/1.1
Host: localhost:80
Harness-Account: pto
Accept: */*
{
"env_vars": [
{
"created": "Suscipit et earum aut distinctio.",
"file_name": "Vel blanditiis labore consectetur.",
"key": "i",
"updated": "Dignissimos ut nobis sunt natus.",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Magnam a ut quas ea possimus omnis.",
"value_type": "Et enim est totam nihil.",
"var_type": "Rerum ut numquam incidunt facere vero."
},
{
"created": "Suscipit et earum aut distinctio.",
"file_name": "Vel blanditiis labore consectetur.",
"key": "i",
"updated": "Dignissimos ut nobis sunt natus.",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Magnam a ut quas ea possimus omnis.",
"value_type": "Et enim est totam nihil.",
"var_type": "Rerum ut numquam incidunt facere vero."
},
{
"created": "Suscipit et earum aut distinctio.",
"file_name": "Vel blanditiis labore consectetur.",
"key": "i",
"updated": "Dignissimos ut nobis sunt natus.",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Magnam a ut quas ea possimus omnis.",
"value_type": "Et enim est totam nihil.",
"var_type": "Rerum ut numquam incidunt facere vero."
}
],
"vars": [
{
"created": "Suscipit et earum aut distinctio.",
"file_name": "Vel blanditiis labore consectetur.",
"key": "i",
"updated": "Dignissimos ut nobis sunt natus.",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Magnam a ut quas ea possimus omnis.",
"value_type": "Et enim est totam nihil.",
"var_type": "Rerum ut numquam incidunt facere vero."
},
{
"created": "Suscipit et earum aut distinctio.",
"file_name": "Vel blanditiis labore consectetur.",
"key": "i",
"updated": "Dignissimos ut nobis sunt natus.",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Magnam a ut quas ea possimus omnis.",
"value_type": "Et enim est totam nihil.",
"var_type": "Rerum ut numquam incidunt facere vero."
},
{
"created": "Suscipit et earum aut distinctio.",
"file_name": "Vel blanditiis labore consectetur.",
"key": "i",
"updated": "Dignissimos ut nobis sunt natus.",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Magnam a ut quas ea possimus omnis.",
"value_type": "Et enim est totam nihil.",
"var_type": "Rerum ut numquam incidunt facere vero."
}
]
}Create a new dynamic variable on an account scoped playbook.
The unique identifier for this playbook
test_playbookAccount is the internal customer account ID.
3Created response.
No content
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
POST /api/ansible/playbook/{identifier}/vars HTTP/1.1
Host: localhost:80
Harness-Account: 3
Content-Type: application/json
Accept: */*
Content-Length: 1445
{
"env_vars": [
{
"file_name": "Eaque quisquam quo culpa totam eligendi et.",
"key": "hp",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Sed autem autem.",
"value_type": "Vel dolore dolorem minima excepturi.",
"var_type": "Et vero qui quam doloribus."
},
{
"file_name": "Eaque quisquam quo culpa totam eligendi et.",
"key": "hp",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Sed autem autem.",
"value_type": "Vel dolore dolorem minima excepturi.",
"var_type": "Et vero qui quam doloribus."
},
{
"file_name": "Eaque quisquam quo culpa totam eligendi et.",
"key": "hp",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Sed autem autem.",
"value_type": "Vel dolore dolorem minima excepturi.",
"var_type": "Et vero qui quam doloribus."
}
],
"vars": [
{
"file_name": "Eaque quisquam quo culpa totam eligendi et.",
"key": "hp",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Sed autem autem.",
"value_type": "Vel dolore dolorem minima excepturi.",
"var_type": "Et vero qui quam doloribus."
},
{
"file_name": "Eaque quisquam quo culpa totam eligendi et.",
"key": "hp",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Sed autem autem.",
"value_type": "Vel dolore dolorem minima excepturi.",
"var_type": "Et vero qui quam doloribus."
},
{
"file_name": "Eaque quisquam quo culpa totam eligendi et.",
"key": "hp",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Sed autem autem.",
"value_type": "Vel dolore dolorem minima excepturi.",
"var_type": "Et vero qui quam doloribus."
}
]
}No content
Update an existing dynamic variable on an account scoped playbook.
The unique identifier for this playbook
test_playbookAccount is the internal customer account ID.
zkOK response.
No content
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
PUT /api/ansible/playbook/{identifier}/vars HTTP/1.1
Host: localhost:80
Harness-Account: zk
Content-Type: application/json
Accept: */*
Content-Length: 1682
{
"env_vars": [
{
"file_name": "Eaque quisquam quo culpa totam eligendi et.",
"key": "hp",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Sed autem autem.",
"value_type": "Vel dolore dolorem minima excepturi.",
"var_type": "Et vero qui quam doloribus."
},
{
"file_name": "Eaque quisquam quo culpa totam eligendi et.",
"key": "hp",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Sed autem autem.",
"value_type": "Vel dolore dolorem minima excepturi.",
"var_type": "Et vero qui quam doloribus."
},
{
"file_name": "Eaque quisquam quo culpa totam eligendi et.",
"key": "hp",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Sed autem autem.",
"value_type": "Vel dolore dolorem minima excepturi.",
"var_type": "Et vero qui quam doloribus."
},
{
"file_name": "Eaque quisquam quo culpa totam eligendi et.",
"key": "hp",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Sed autem autem.",
"value_type": "Vel dolore dolorem minima excepturi.",
"var_type": "Et vero qui quam doloribus."
}
],
"vars": [
{
"file_name": "Eaque quisquam quo culpa totam eligendi et.",
"key": "hp",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Sed autem autem.",
"value_type": "Vel dolore dolorem minima excepturi.",
"var_type": "Et vero qui quam doloribus."
},
{
"file_name": "Eaque quisquam quo culpa totam eligendi et.",
"key": "hp",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Sed autem autem.",
"value_type": "Vel dolore dolorem minima excepturi.",
"var_type": "Et vero qui quam doloribus."
},
{
"file_name": "Eaque quisquam quo culpa totam eligendi et.",
"key": "hp",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Sed autem autem.",
"value_type": "Vel dolore dolorem minima excepturi.",
"var_type": "Et vero qui quam doloribus."
}
]
}No content
Delete a dynamic variable from an account scoped playbook.
The unique identifier for this playbook
test_playbookAccount is the internal customer account ID.
c8l["Dolorem recusandae impedit voluptates assumenda omnis.","Ut numquam.","Excepturi voluptas deleniti asperiores officiis dolorum.","Qui sit tempore."]OK response.
No content
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
DELETE /api/ansible/playbook/{identifier}/vars HTTP/1.1
Host: localhost:80
Harness-Account: c8l
Content-Type: application/json
Accept: */*
Content-Length: 130
{
"vars": [
"Amet occaecati maxime ut.",
"Voluptatem nihil iusto asperiores.",
"Veritatis ea aperiam qui beatae sapiente voluptatem."
]
}No content
List all activities at org scope. Account and project scoped activities are not included.
Org is the organisation identifier.
yLimit is the number of records to return for a page.
30Example: 30Page is the page number to return relative to the page 'limit'.
1Example: 1Sort order for results
created,DESCExample: created,ASCPossible values: Search term to filter by inventory identifier
inventory_1Search term to filter by playbook identifier
playbook_1Activity type filter
Enim aspernatur vel.Activity status filter
Saepe rem iste.Account is the internal customer account ID.
aOK response.
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/orgs/{org}/ansible/activities HTTP/1.1
Host: localhost:80
Harness-Account: a
Accept: */*
[
{
"account": "mld",
"created": 1627590400,
"event_type": "activity-execution",
"id": "dc538c61-de48-4220-958c-5f3c4f983daa",
"inventories": "Sapiente dolorem.",
"metadata": {
"activity_status": "Dolorem amet quae.",
"filters": "tags=deploy skip-tags=slow limit=web",
"git_branch": "Quia aut eum dignissimos itaque.",
"git_commit_message": "Aspernatur assumenda eius sit vitae quos dolorem.",
"git_commit_sha": "Facilis et harum.",
"git_repo": "Iure reprehenderit.",
"metrics": {
"circuit_breaker_triggered": false,
"duration_ms": 3729912682196842500,
"host_changed": 7326503586878806000,
"host_failed": 510844048246640640,
"host_ok": 7033055310389248000,
"host_skipped": 8298202262197766000,
"host_unreachable": 3136096962125600300,
"output_size_bytes": 5580013020588243000,
"payload_size_bytes": 5024210113655448000,
"total_hosts": 3289931238796667000,
"total_tasks": 8463213749394180000
},
"pipeline": "Sint consequuntur libero commodi veritatis atque.",
"pipeline_execution_id": "Omnis autem ullam quas et.",
"pipeline_execution_number": "Rem cumque molestias assumenda.",
"pipeline_name": "Et accusamus veniam libero.",
"pipeline_stage_id": "Repellat soluta.",
"plugin_version": "Amet totam laboriosam voluptas.",
"results_uuid": "Officia necessitatibus quis provident consequatur.",
"trigger": {
"Alias quis.": "Quaerat quasi.",
"Autem aut.": "Quis ipsa est.",
"Qui et.": "Molestiae autem nisi."
}
},
"org": "12",
"playbooks": "Qui est.",
"project": "0"
},
{
"account": "mld",
"created": 1627590400,
"event_type": "activity-execution",
"id": "dc538c61-de48-4220-958c-5f3c4f983daa",
"inventories": "Sapiente dolorem.",
"metadata": {
"activity_status": "Dolorem amet quae.",
"filters": "tags=deploy skip-tags=slow limit=web",
"git_branch": "Quia aut eum dignissimos itaque.",
"git_commit_message": "Aspernatur assumenda eius sit vitae quos dolorem.",
"git_commit_sha": "Facilis et harum.",
"git_repo": "Iure reprehenderit.",
"metrics": {
"circuit_breaker_triggered": false,
"duration_ms": 3729912682196842500,
"host_changed": 7326503586878806000,
"host_failed": 510844048246640640,
"host_ok": 7033055310389248000,
"host_skipped": 8298202262197766000,
"host_unreachable": 3136096962125600300,
"output_size_bytes": 5580013020588243000,
"payload_size_bytes": 5024210113655448000,
"total_hosts": 3289931238796667000,
"total_tasks": 8463213749394180000
},
"pipeline": "Sint consequuntur libero commodi veritatis atque.",
"pipeline_execution_id": "Omnis autem ullam quas et.",
"pipeline_execution_number": "Rem cumque molestias assumenda.",
"pipeline_name": "Et accusamus veniam libero.",
"pipeline_stage_id": "Repellat soluta.",
"plugin_version": "Amet totam laboriosam voluptas.",
"results_uuid": "Officia necessitatibus quis provident consequatur.",
"trigger": {
"Alias quis.": "Quaerat quasi.",
"Autem aut.": "Quis ipsa est.",
"Qui et.": "Molestiae autem nisi."
}
},
"org": "12",
"playbooks": "Qui est.",
"project": "0"
},
{
"account": "mld",
"created": 1627590400,
"event_type": "activity-execution",
"id": "dc538c61-de48-4220-958c-5f3c4f983daa",
"inventories": "Sapiente dolorem.",
"metadata": {
"activity_status": "Dolorem amet quae.",
"filters": "tags=deploy skip-tags=slow limit=web",
"git_branch": "Quia aut eum dignissimos itaque.",
"git_commit_message": "Aspernatur assumenda eius sit vitae quos dolorem.",
"git_commit_sha": "Facilis et harum.",
"git_repo": "Iure reprehenderit.",
"metrics": {
"circuit_breaker_triggered": false,
"duration_ms": 3729912682196842500,
"host_changed": 7326503586878806000,
"host_failed": 510844048246640640,
"host_ok": 7033055310389248000,
"host_skipped": 8298202262197766000,
"host_unreachable": 3136096962125600300,
"output_size_bytes": 5580013020588243000,
"payload_size_bytes": 5024210113655448000,
"total_hosts": 3289931238796667000,
"total_tasks": 8463213749394180000
},
"pipeline": "Sint consequuntur libero commodi veritatis atque.",
"pipeline_execution_id": "Omnis autem ullam quas et.",
"pipeline_execution_number": "Rem cumque molestias assumenda.",
"pipeline_name": "Et accusamus veniam libero.",
"pipeline_stage_id": "Repellat soluta.",
"plugin_version": "Amet totam laboriosam voluptas.",
"results_uuid": "Officia necessitatibus quis provident consequatur.",
"trigger": {
"Alias quis.": "Quaerat quasi.",
"Autem aut.": "Quis ipsa est.",
"Qui et.": "Molestiae autem nisi."
}
},
"org": "12",
"playbooks": "Qui est.",
"project": "0"
}
]Show an individual org scoped ansible activity.
Org is the organisation identifier.
uThe unique ID for this activity
Aliquid dignissimos quis ullam voluptas qui vero.Account is the internal customer account ID.
r0OK response.
Account is the internal customer account ID.
dTimestamp when the resource was created.
1627590400The type of event that occurred
activity-executionPossible values: The unique identifier for this activity
dc538c61-de48-4220-958c-5f3c4f983daaInventories associated with this event
Qui aut quia accusantium sint quo.Org is the organisation identifier.
rPlaybooks associated with this event
Fugiat earum voluptatem.Project is the project identifier.
lBadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/orgs/{org}/ansible/activities/{id} HTTP/1.1
Host: localhost:80
Harness-Account: r0
Accept: */*
{
"account": "0tt",
"created": 1627590400,
"event_type": "activity-execution",
"id": "dc538c61-de48-4220-958c-5f3c4f983daa",
"inventories": "Aliquid odio expedita porro modi ratione.",
"metadata": {
"activity_status": "Asperiores quod molestiae consequatur vitae.",
"filters": "tags=deploy skip-tags=slow limit=web",
"git_branch": "Voluptas animi dolor dolorem laborum.",
"git_commit_message": "Dolor facere.",
"git_commit_sha": "Voluptatem quia earum voluptatem quas in.",
"git_repo": "Dolores nobis.",
"metrics": {
"circuit_breaker_triggered": false,
"duration_ms": 4956144492920646000,
"host_changed": 7991066862074085000,
"host_failed": 7286501368895138000,
"host_ok": 8723992317937321000,
"host_skipped": 7515790151550636000,
"host_unreachable": 1865379895225030100,
"output_size_bytes": 7964733890466916000,
"payload_size_bytes": 2592876429800924000,
"total_hosts": 7520422272859706000,
"total_tasks": 5767911488264385000
},
"pipeline": "Ex vel quaerat sunt minima dolor.",
"pipeline_execution_id": "Nulla ratione et omnis.",
"pipeline_execution_number": "Ipsum qui totam cum.",
"pipeline_name": "Et alias quis sint porro delectus est.",
"pipeline_stage_id": "Pariatur porro earum sed.",
"plugin_version": "Est laudantium.",
"results_uuid": "Quam repellat omnis eos aut.",
"trigger": {
"Id molestias.": "Beatae aut asperiores nulla."
}
},
"org": "y",
"playbooks": "Ut eum.",
"project": "4n"
}Get binary data generated by an org scoped ansible run.
Org is the organisation identifier.
afThe unique identifier for the data
dc538c61-de48-4220-958c-5f3c4f983daaAccount is the internal customer account ID.
agoOK response.
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/orgs/{org}/ansible/data/{id} HTTP/1.1
Host: localhost:80
Harness-Account: ago
Accept: */*
binaryRetrieve an org scoped playbook's YAML file from its configured git repository.
Org is the organisation identifier.
41Type of ansible resource (playbook or inventory).
playbookPossible values: Identifier of the playbook or inventory.
my-playbookAccount is the internal customer account ID.
pOK response.
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/orgs/{org}/ansible/file?resource_type=playbook&identifier=my-playbook HTTP/1.1
Host: localhost:80
Harness-Account: p
Accept: */*
binaryList all playbooks at org scope. Account and project scoped playbooks are not included.
Org is the organisation identifier.
v07Limit is the number of records to return for a page.
30Example: 30Page is the page number to return relative to the page 'limit'.
1Example: 1Filter results by partial name match
""Example: mystaSort order for results
name,ASCExample: name,DESCPossible values: Filter results by tags (OR logic, exact match)
["Numquam veniam.","Illum ab.","Quo unde.","Nihil nemo sint quia totam et."]Account is the internal customer account ID.
f54OK response.
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/orgs/{org}/ansible/playbook HTTP/1.1
Host: localhost:80
Harness-Account: f54
Accept: */*
[
{
"account": "r",
"ansible_galaxy": true,
"ansible_galaxy_requirements_file": "requirements.yml",
"created": 1627590400,
"description": "Playbook for deploying web services to production",
"env_vars": "Rem reprehenderit qui dolore quo qui similique.",
"identifier": "Aspernatur repudiandae voluptate.",
"name": "test playbook",
"org": "7af",
"project": "yt",
"repository": "my-repo",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "my-connector",
"repository_path": "playbooks/",
"tags": [
"Sit dolores.",
"Voluptas facilis in est sunt veniam repudiandae.",
"Quas praesentium magni.",
"Rerum cumque sunt."
],
"updated": 1627686800,
"vars": "Et iste maiores consectetur doloribus autem laboriosam."
},
{
"account": "r",
"ansible_galaxy": true,
"ansible_galaxy_requirements_file": "requirements.yml",
"created": 1627590400,
"description": "Playbook for deploying web services to production",
"env_vars": "Rem reprehenderit qui dolore quo qui similique.",
"identifier": "Aspernatur repudiandae voluptate.",
"name": "test playbook",
"org": "7af",
"project": "yt",
"repository": "my-repo",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "my-connector",
"repository_path": "playbooks/",
"tags": [
"Sit dolores.",
"Voluptas facilis in est sunt veniam repudiandae.",
"Quas praesentium magni.",
"Rerum cumque sunt."
],
"updated": 1627686800,
"vars": "Et iste maiores consectetur doloribus autem laboriosam."
}
]Create a new playbook at org scope.
Org is the organisation identifier.
uAccount is the internal customer account ID.
lxInstall Ansible Galaxy dependencies
falseExample: truePath to Ansible Galaxy requirements file
requirements.ymlDescription documents the playbook purpose and usage
Playbook for deploying web services to productionThe unique identifier for this playbook
Aliquam expedita eius esse quos distinctio.Name is the human readable name
test playbookRepository is the name of the repository to use.
my-repoRepository Branch in which the playbook should be accessed.
mainRepository Commit/Tag in which the playbook should be accessed.
abc10edRepository Connector is the reference to the connector to use for this playbook.
my-connectorRepository Path is the path in which the playbook resides.
""Example: playbooks/Tags associated with the playbook
["Ad aut expedita est beatae ex dolor.","Quod dolores fugiat ipsa necessitatibus voluptatem sit.","Voluptas et."]Created response.
Account is the internal customer account ID.
7Install Ansible Galaxy dependencies
falseExample: truePath to Ansible Galaxy requirements file
requirements.ymlTimestamp when the resource was created.
1627590400Description documents the playbook purpose and usage
Playbook for deploying web services to productionThe environment vars in the playbook
Occaecati sed pariatur nam.The unique identifier for this playbook
Nam cumque et sunt unde.Name is the human readable name
test playbookOrg is the organisation identifier.
i9Project is the project identifier.
hfjRepository is the name of the repository to use.
my-repoRepository Branch in which the playbook should be accessed.
mainRepository Commit/Tag in which the playbook should be accessed.
abc10edRepository Connector is the reference to the connector to use for this playbook.
my-connectorRepository Path is the path in which the playbook resides.
""Example: playbooks/Tags associated with the playbook
["Culpa ullam voluptas.","Unde placeat deleniti.","Incidunt est voluptas consequatur."]Timestamp when the resource was last updated.
1627686800The vars in the playbook
Sunt occaecati eius doloremque consequatur impedit.BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
POST /api/orgs/{org}/ansible/playbook HTTP/1.1
Host: localhost:80
Harness-Account: lx
Content-Type: application/json
Accept: */*
Content-Length: 1641
{
"ansible_galaxy": true,
"ansible_galaxy_requirements_file": "requirements.yml",
"description": "Playbook for deploying web services to production",
"env_vars": {
"Fugiat modi architecto quia qui suscipit.": {
"file_name": "Enim facilis libero rerum.",
"key": "yv",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Optio ut dolorum dignissimos fuga nisi.",
"value_type": "Sit qui quam soluta consequatur."
},
"Fugit enim iure non est possimus.": {
"file_name": "Enim facilis libero rerum.",
"key": "yv",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Optio ut dolorum dignissimos fuga nisi.",
"value_type": "Sit qui quam soluta consequatur."
}
},
"identifier": "Quod provident distinctio ea quos vero laboriosam.",
"name": "test playbook",
"repository": "my-repo",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "my-connector",
"repository_path": "playbooks/",
"tags": [
"Voluptatem quidem qui libero vero qui.",
"Hic eum vero facilis ab."
],
"vars": {
"Fugiat aliquid.": {
"file_name": "Enim facilis libero rerum.",
"key": "yv",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Optio ut dolorum dignissimos fuga nisi.",
"value_type": "Sit qui quam soluta consequatur."
},
"Ipsam est sunt.": {
"file_name": "Enim facilis libero rerum.",
"key": "yv",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Optio ut dolorum dignissimos fuga nisi.",
"value_type": "Sit qui quam soluta consequatur."
},
"Perspiciatis sit placeat consequatur eum ratione at.": {
"file_name": "Enim facilis libero rerum.",
"key": "yv",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Optio ut dolorum dignissimos fuga nisi.",
"value_type": "Sit qui quam soluta consequatur."
}
}
}{
"account": "b56",
"ansible_galaxy": true,
"ansible_galaxy_requirements_file": "requirements.yml",
"created": 1627590400,
"description": "Playbook for deploying web services to production",
"env_vars": "Nostrum eos nihil et.",
"identifier": "Velit unde aspernatur ex doloribus.",
"name": "test playbook",
"org": "r",
"policy_evaluation": {
"account_id": "XRQAjvT37acOiXx9PRaQMF",
"action": "onrun",
"created": 1636370209475,
"details": [
{
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"action": "onrun",
"created": 1636669297674,
"description": "Captures critical production policies",
"details": [
{
"deny_messages": [
"deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}",
"policy": {
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
},
{
"deny_messages": [
"deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}",
"policy": {
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
}
],
"enabled": true,
"identifier": "policyset-1",
"name": "Production Policies",
"org_id": "test-org",
"project_id": "test-project",
"status": "error",
"type": "pipeline",
"updated": 1636669297674
},
{
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"action": "onrun",
"created": 1636669297674,
"description": "Captures critical production policies",
"details": [
{
"deny_messages": [
"deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}",
"policy": {
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
},
{
"deny_messages": [
"deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}",
"policy": {
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
}
],
"enabled": true,
"identifier": "policyset-1",
"name": "Production Policies",
"org_id": "test-org",
"project_id": "test-project",
"status": "error",
"type": "pipeline",
"updated": 1636669297674
},
{
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"action": "onrun",
"created": 1636669297674,
"description": "Captures critical production policies",
"details": [
{
"deny_messages": [
"deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}",
"policy": {
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
},
{
"deny_messages": [
"deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}",
"policy": {
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
}
],
"enabled": true,
"identifier": "policyset-1",
"name": "Production Policies",
"org_id": "test-org",
"project_id": "test-project",
"status": "error",
"type": "pipeline",
"updated": 1636669297674
}
],
"entity": "7bbca5d4-e9f2-4955-9b2a-019ec4d3645e",
"entity_metadata": "7bbca5d4-e9f2-4955-9b2a-019ec4d3645e",
"id": 123,
"input": "",
"org_id": "test-org",
"project_id": "test-project",
"status": "error",
"type": "pipeline,service"
},
"project": "2",
"repository": "my-repo",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "my-connector",
"repository_path": "playbooks/",
"tags": [
"Veritatis eaque corporis nesciunt distinctio.",
"Dolorum qui quisquam fugit.",
"Ut corrupti."
],
"updated": 1627686800,
"vars": "Quo ad numquam maxime quod."
}Show an individual org scoped playbook.
Org is the organisation identifier.
ta7The unique identifier for this playbook
Non maxime sapiente.Account is the internal customer account ID.
ywvOK response.
Account is the internal customer account ID.
c77Install Ansible Galaxy dependencies
falseExample: falsePath to Ansible Galaxy requirements file
requirements.ymlTimestamp when the resource was created.
1627590400Description documents the playbook purpose and usage
Playbook for deploying web services to productionThe environment vars in the playbook
Corrupti et veniam corporis omnis.The unique identifier for this playbook
Aut est ipsa non consequatur voluptatem.Name is the human readable name
test playbookOrg is the organisation identifier.
gProject is the project identifier.
a5jRepository is the name of the repository to use.
my-repoRepository Branch in which the playbook should be accessed.
mainRepository Commit/Tag in which the playbook should be accessed.
abc10edRepository Connector is the reference to the connector to use for this playbook.
my-connectorRepository Path is the path in which the playbook resides.
""Example: playbooks/Tags associated with the playbook
["Laborum dignissimos totam.","Deserunt illo sunt qui et."]Timestamp when the resource was last updated.
1627686800The vars in the playbook
Omnis impedit dolor reprehenderit ex.BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/orgs/{org}/ansible/playbook/{identifier} HTTP/1.1
Host: localhost:80
Harness-Account: ywv
Accept: */*
{
"account": "d1d",
"ansible_galaxy": true,
"ansible_galaxy_requirements_file": "requirements.yml",
"created": 1627590400,
"description": "Playbook for deploying web services to production",
"env_vars": "Blanditiis iusto non aperiam modi ex quidem.",
"identifier": "Nostrum omnis.",
"name": "test playbook",
"org": "h6x",
"project": "7up",
"repository": "my-repo",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "my-connector",
"repository_path": "playbooks/",
"tags": [
"Cupiditate eum voluptatem quo unde aut.",
"Consequuntur illo et voluptate deleniti.",
"Incidunt consequatur harum debitis.",
"Id vero inventore atque non maiores labore."
],
"updated": 1627686800,
"vars": "Occaecati vel ad repudiandae enim a dicta."
}Update an existing org scoped playbook.
Org is the organisation identifier.
7bThe unique identifier for this playbook
Itaque sed.Account is the internal customer account ID.
t0Install Ansible Galaxy dependencies
falseExample: truePath to Ansible Galaxy requirements file
requirements.ymlDescription documents the playbook purpose and usage
Playbook for deploying web services to productionName is the human readable name
test playbookRepository is the name of the repository to use.
my-repoRepository Branch in which the playbook should be accessed.
mainRepository Commit/Tag in which the playbook should be accessed.
abc10edRepository Connector is the reference to the connector to use for this playbook.
my-connectorRepository Path is the path in which the playbook resides.
""Example: playbooks/Tags associated with the playbook
["Blanditiis quod quisquam enim.","Quas est labore.","Doloribus vel eos velit.","Explicabo ad aut."]OK response.
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
PUT /api/orgs/{org}/ansible/playbook/{identifier} HTTP/1.1
Host: localhost:80
Harness-Account: t0
Content-Type: application/json
Accept: */*
Content-Length: 1153
{
"ansible_galaxy": false,
"ansible_galaxy_requirements_file": "requirements.yml",
"description": "Playbook for deploying web services to production",
"env_vars": {
"Et sit neque laborum.": {
"file_name": "Enim facilis libero rerum.",
"key": "yv",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Optio ut dolorum dignissimos fuga nisi.",
"value_type": "Sit qui quam soluta consequatur."
}
},
"name": "test playbook",
"repository": "my-repo",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "my-connector",
"repository_path": "playbooks/",
"tags": [
"Pariatur at aut ratione odio.",
"Recusandae occaecati.",
"Voluptate voluptatum.",
"Minus autem sunt culpa."
],
"vars": {
"Laborum vel quaerat rerum delectus.": {
"file_name": "Enim facilis libero rerum.",
"key": "yv",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Optio ut dolorum dignissimos fuga nisi.",
"value_type": "Sit qui quam soluta consequatur."
},
"Molestiae temporibus cupiditate vel sint.": {
"file_name": "Enim facilis libero rerum.",
"key": "yv",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Optio ut dolorum dignissimos fuga nisi.",
"value_type": "Sit qui quam soluta consequatur."
}
}
}{
"policy_evaluation": {
"account_id": "XRQAjvT37acOiXx9PRaQMF",
"action": "onrun",
"created": 1636370209475,
"details": [
{
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"action": "onrun",
"created": 1636669297674,
"description": "Captures critical production policies",
"details": [
{
"deny_messages": [
"deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}",
"policy": {
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
},
{
"deny_messages": [
"deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}",
"policy": {
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
}
],
"enabled": true,
"identifier": "policyset-1",
"name": "Production Policies",
"org_id": "test-org",
"project_id": "test-project",
"status": "error",
"type": "pipeline",
"updated": 1636669297674
},
{
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"action": "onrun",
"created": 1636669297674,
"description": "Captures critical production policies",
"details": [
{
"deny_messages": [
"deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}",
"policy": {
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
},
{
"deny_messages": [
"deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}",
"policy": {
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
}
],
"enabled": true,
"identifier": "policyset-1",
"name": "Production Policies",
"org_id": "test-org",
"project_id": "test-project",
"status": "error",
"type": "pipeline",
"updated": 1636669297674
},
{
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"action": "onrun",
"created": 1636669297674,
"description": "Captures critical production policies",
"details": [
{
"deny_messages": [
"deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}",
"policy": {
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
},
{
"deny_messages": [
"deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}",
"policy": {
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
}
],
"enabled": true,
"identifier": "policyset-1",
"name": "Production Policies",
"org_id": "test-org",
"project_id": "test-project",
"status": "error",
"type": "pipeline",
"updated": 1636669297674
}
],
"entity": "7bbca5d4-e9f2-4955-9b2a-019ec4d3645e",
"entity_metadata": "7bbca5d4-e9f2-4955-9b2a-019ec4d3645e",
"id": 123,
"input": "",
"org_id": "test-org",
"project_id": "test-project",
"status": "error",
"type": "pipeline,service"
}
}Delete an existing org scoped playbook.
Org is the organisation identifier.
bejThe unique identifier for this playbook
Corporis esse cum.Account is the internal customer account ID.
tq0OK response.
No content
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
DELETE /api/orgs/{org}/ansible/playbook/{identifier} HTTP/1.1
Host: localhost:80
Harness-Account: tq0
Accept: */*
No content
Show an individual org scoped playbook vars.
Org is the organisation identifier.
s11Playbook identifier
Et et sed aspernatur recusandae.Limit is the number of records to return for a page.
30Example: 30Page is the page number to return relative to the page 'limit'.
1Example: 1Account is the internal customer account ID.
61eOK response.
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/orgs/{org}/ansible/playbook/{identifier}/vars HTTP/1.1
Host: localhost:80
Harness-Account: 61e
Accept: */*
{
"env_vars": [
{
"created": "Suscipit et earum aut distinctio.",
"file_name": "Vel blanditiis labore consectetur.",
"key": "i",
"updated": "Dignissimos ut nobis sunt natus.",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Magnam a ut quas ea possimus omnis.",
"value_type": "Et enim est totam nihil.",
"var_type": "Rerum ut numquam incidunt facere vero."
},
{
"created": "Suscipit et earum aut distinctio.",
"file_name": "Vel blanditiis labore consectetur.",
"key": "i",
"updated": "Dignissimos ut nobis sunt natus.",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Magnam a ut quas ea possimus omnis.",
"value_type": "Et enim est totam nihil.",
"var_type": "Rerum ut numquam incidunt facere vero."
},
{
"created": "Suscipit et earum aut distinctio.",
"file_name": "Vel blanditiis labore consectetur.",
"key": "i",
"updated": "Dignissimos ut nobis sunt natus.",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Magnam a ut quas ea possimus omnis.",
"value_type": "Et enim est totam nihil.",
"var_type": "Rerum ut numquam incidunt facere vero."
}
],
"vars": [
{
"created": "Suscipit et earum aut distinctio.",
"file_name": "Vel blanditiis labore consectetur.",
"key": "i",
"updated": "Dignissimos ut nobis sunt natus.",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Magnam a ut quas ea possimus omnis.",
"value_type": "Et enim est totam nihil.",
"var_type": "Rerum ut numquam incidunt facere vero."
},
{
"created": "Suscipit et earum aut distinctio.",
"file_name": "Vel blanditiis labore consectetur.",
"key": "i",
"updated": "Dignissimos ut nobis sunt natus.",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Magnam a ut quas ea possimus omnis.",
"value_type": "Et enim est totam nihil.",
"var_type": "Rerum ut numquam incidunt facere vero."
},
{
"created": "Suscipit et earum aut distinctio.",
"file_name": "Vel blanditiis labore consectetur.",
"key": "i",
"updated": "Dignissimos ut nobis sunt natus.",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Magnam a ut quas ea possimus omnis.",
"value_type": "Et enim est totam nihil.",
"var_type": "Rerum ut numquam incidunt facere vero."
}
]
}Create a new dynamic variable on an org scoped playbook.
Org is the organisation identifier.
0The unique identifier for this playbook
test_playbookAccount is the internal customer account ID.
nrgCreated response.
No content
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
POST /api/orgs/{org}/ansible/playbook/{identifier}/vars HTTP/1.1
Host: localhost:80
Harness-Account: nrg
Content-Type: application/json
Accept: */*
Content-Length: 1919
{
"env_vars": [
{
"file_name": "Eaque quisquam quo culpa totam eligendi et.",
"key": "hp",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Sed autem autem.",
"value_type": "Vel dolore dolorem minima excepturi.",
"var_type": "Et vero qui quam doloribus."
},
{
"file_name": "Eaque quisquam quo culpa totam eligendi et.",
"key": "hp",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Sed autem autem.",
"value_type": "Vel dolore dolorem minima excepturi.",
"var_type": "Et vero qui quam doloribus."
},
{
"file_name": "Eaque quisquam quo culpa totam eligendi et.",
"key": "hp",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Sed autem autem.",
"value_type": "Vel dolore dolorem minima excepturi.",
"var_type": "Et vero qui quam doloribus."
},
{
"file_name": "Eaque quisquam quo culpa totam eligendi et.",
"key": "hp",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Sed autem autem.",
"value_type": "Vel dolore dolorem minima excepturi.",
"var_type": "Et vero qui quam doloribus."
}
],
"vars": [
{
"file_name": "Eaque quisquam quo culpa totam eligendi et.",
"key": "hp",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Sed autem autem.",
"value_type": "Vel dolore dolorem minima excepturi.",
"var_type": "Et vero qui quam doloribus."
},
{
"file_name": "Eaque quisquam quo culpa totam eligendi et.",
"key": "hp",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Sed autem autem.",
"value_type": "Vel dolore dolorem minima excepturi.",
"var_type": "Et vero qui quam doloribus."
},
{
"file_name": "Eaque quisquam quo culpa totam eligendi et.",
"key": "hp",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Sed autem autem.",
"value_type": "Vel dolore dolorem minima excepturi.",
"var_type": "Et vero qui quam doloribus."
},
{
"file_name": "Eaque quisquam quo culpa totam eligendi et.",
"key": "hp",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Sed autem autem.",
"value_type": "Vel dolore dolorem minima excepturi.",
"var_type": "Et vero qui quam doloribus."
}
]
}No content
Update an existing dynamic variable on an org scoped playbook.
Org is the organisation identifier.
bThe unique identifier for this playbook
test_playbookAccount is the internal customer account ID.
2yOK response.
No content
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
PUT /api/orgs/{org}/ansible/playbook/{identifier}/vars HTTP/1.1
Host: localhost:80
Harness-Account: 2y
Content-Type: application/json
Accept: */*
Content-Length: 1445
{
"env_vars": [
{
"file_name": "Eaque quisquam quo culpa totam eligendi et.",
"key": "hp",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Sed autem autem.",
"value_type": "Vel dolore dolorem minima excepturi.",
"var_type": "Et vero qui quam doloribus."
},
{
"file_name": "Eaque quisquam quo culpa totam eligendi et.",
"key": "hp",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Sed autem autem.",
"value_type": "Vel dolore dolorem minima excepturi.",
"var_type": "Et vero qui quam doloribus."
}
],
"vars": [
{
"file_name": "Eaque quisquam quo culpa totam eligendi et.",
"key": "hp",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Sed autem autem.",
"value_type": "Vel dolore dolorem minima excepturi.",
"var_type": "Et vero qui quam doloribus."
},
{
"file_name": "Eaque quisquam quo culpa totam eligendi et.",
"key": "hp",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Sed autem autem.",
"value_type": "Vel dolore dolorem minima excepturi.",
"var_type": "Et vero qui quam doloribus."
},
{
"file_name": "Eaque quisquam quo culpa totam eligendi et.",
"key": "hp",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Sed autem autem.",
"value_type": "Vel dolore dolorem minima excepturi.",
"var_type": "Et vero qui quam doloribus."
},
{
"file_name": "Eaque quisquam quo culpa totam eligendi et.",
"key": "hp",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Sed autem autem.",
"value_type": "Vel dolore dolorem minima excepturi.",
"var_type": "Et vero qui quam doloribus."
}
]
}No content
Delete a dynamic variable from an org scoped playbook.
Org is the organisation identifier.
fThe unique identifier for this playbook
test_playbookAccount is the internal customer account ID.
et["Veniam dolore officiis aut.","Rerum rem explicabo vitae minus praesentium.","Dolorum voluptas rerum ad est eos et."]OK response.
No content
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
DELETE /api/orgs/{org}/ansible/playbook/{identifier}/vars HTTP/1.1
Host: localhost:80
Harness-Account: et
Content-Type: application/json
Accept: */*
Content-Length: 92
{
"vars": [
"Architecto non voluptas.",
"Modi facilis doloribus aspernatur consequatur velit."
]
}No content
List all activities.
Org is the organisation identifier.
rqProject is the project identifier.
fj8Limit is the number of records to return for a page.
30Example: 30Page is the page number to return relative to the page 'limit'.
1Example: 1Sort order for results
created,DESCExample: created,ASCPossible values: Search term to filter by inventory identifier
inventory_1Search term to filter by playbook identifier
playbook_1Activity type filter
Voluptas quos.Activity status filter
Ut voluptas.Account is the internal customer account ID.
30OK response.
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/orgs/{org}/projects/{project}/ansible/activities HTTP/1.1
Host: localhost:80
Harness-Account: 30
Accept: */*
[
{
"account": "mld",
"created": 1627590400,
"event_type": "activity-execution",
"id": "dc538c61-de48-4220-958c-5f3c4f983daa",
"inventories": "Sapiente dolorem.",
"metadata": {
"activity_status": "Dolorem amet quae.",
"filters": "tags=deploy skip-tags=slow limit=web",
"git_branch": "Quia aut eum dignissimos itaque.",
"git_commit_message": "Aspernatur assumenda eius sit vitae quos dolorem.",
"git_commit_sha": "Facilis et harum.",
"git_repo": "Iure reprehenderit.",
"metrics": {
"circuit_breaker_triggered": false,
"duration_ms": 3729912682196842500,
"host_changed": 7326503586878806000,
"host_failed": 510844048246640640,
"host_ok": 7033055310389248000,
"host_skipped": 8298202262197766000,
"host_unreachable": 3136096962125600300,
"output_size_bytes": 5580013020588243000,
"payload_size_bytes": 5024210113655448000,
"total_hosts": 3289931238796667000,
"total_tasks": 8463213749394180000
},
"pipeline": "Sint consequuntur libero commodi veritatis atque.",
"pipeline_execution_id": "Omnis autem ullam quas et.",
"pipeline_execution_number": "Rem cumque molestias assumenda.",
"pipeline_name": "Et accusamus veniam libero.",
"pipeline_stage_id": "Repellat soluta.",
"plugin_version": "Amet totam laboriosam voluptas.",
"results_uuid": "Officia necessitatibus quis provident consequatur.",
"trigger": {
"Alias quis.": "Quaerat quasi.",
"Autem aut.": "Quis ipsa est.",
"Qui et.": "Molestiae autem nisi."
}
},
"org": "12",
"playbooks": "Qui est.",
"project": "0"
},
{
"account": "mld",
"created": 1627590400,
"event_type": "activity-execution",
"id": "dc538c61-de48-4220-958c-5f3c4f983daa",
"inventories": "Sapiente dolorem.",
"metadata": {
"activity_status": "Dolorem amet quae.",
"filters": "tags=deploy skip-tags=slow limit=web",
"git_branch": "Quia aut eum dignissimos itaque.",
"git_commit_message": "Aspernatur assumenda eius sit vitae quos dolorem.",
"git_commit_sha": "Facilis et harum.",
"git_repo": "Iure reprehenderit.",
"metrics": {
"circuit_breaker_triggered": false,
"duration_ms": 3729912682196842500,
"host_changed": 7326503586878806000,
"host_failed": 510844048246640640,
"host_ok": 7033055310389248000,
"host_skipped": 8298202262197766000,
"host_unreachable": 3136096962125600300,
"output_size_bytes": 5580013020588243000,
"payload_size_bytes": 5024210113655448000,
"total_hosts": 3289931238796667000,
"total_tasks": 8463213749394180000
},
"pipeline": "Sint consequuntur libero commodi veritatis atque.",
"pipeline_execution_id": "Omnis autem ullam quas et.",
"pipeline_execution_number": "Rem cumque molestias assumenda.",
"pipeline_name": "Et accusamus veniam libero.",
"pipeline_stage_id": "Repellat soluta.",
"plugin_version": "Amet totam laboriosam voluptas.",
"results_uuid": "Officia necessitatibus quis provident consequatur.",
"trigger": {
"Alias quis.": "Quaerat quasi.",
"Autem aut.": "Quis ipsa est.",
"Qui et.": "Molestiae autem nisi."
}
},
"org": "12",
"playbooks": "Qui est.",
"project": "0"
},
{
"account": "mld",
"created": 1627590400,
"event_type": "activity-execution",
"id": "dc538c61-de48-4220-958c-5f3c4f983daa",
"inventories": "Sapiente dolorem.",
"metadata": {
"activity_status": "Dolorem amet quae.",
"filters": "tags=deploy skip-tags=slow limit=web",
"git_branch": "Quia aut eum dignissimos itaque.",
"git_commit_message": "Aspernatur assumenda eius sit vitae quos dolorem.",
"git_commit_sha": "Facilis et harum.",
"git_repo": "Iure reprehenderit.",
"metrics": {
"circuit_breaker_triggered": false,
"duration_ms": 3729912682196842500,
"host_changed": 7326503586878806000,
"host_failed": 510844048246640640,
"host_ok": 7033055310389248000,
"host_skipped": 8298202262197766000,
"host_unreachable": 3136096962125600300,
"output_size_bytes": 5580013020588243000,
"payload_size_bytes": 5024210113655448000,
"total_hosts": 3289931238796667000,
"total_tasks": 8463213749394180000
},
"pipeline": "Sint consequuntur libero commodi veritatis atque.",
"pipeline_execution_id": "Omnis autem ullam quas et.",
"pipeline_execution_number": "Rem cumque molestias assumenda.",
"pipeline_name": "Et accusamus veniam libero.",
"pipeline_stage_id": "Repellat soluta.",
"plugin_version": "Amet totam laboriosam voluptas.",
"results_uuid": "Officia necessitatibus quis provident consequatur.",
"trigger": {
"Alias quis.": "Quaerat quasi.",
"Autem aut.": "Quis ipsa est.",
"Qui et.": "Molestiae autem nisi."
}
},
"org": "12",
"playbooks": "Qui est.",
"project": "0"
}
]Show an individual ansible activity.
Org is the organisation identifier.
eProject is the project identifier.
3The unique ID for this activity
Asperiores quia ipsum molestiae laborum qui in.Account is the internal customer account ID.
xOK response.
Account is the internal customer account ID.
dTimestamp when the resource was created.
1627590400The type of event that occurred
activity-executionPossible values: The unique identifier for this activity
dc538c61-de48-4220-958c-5f3c4f983daaInventories associated with this event
Et voluptatem tempore corporis et.Org is the organisation identifier.
c1Playbooks associated with this event
Tenetur et rerum eum perferendis aperiam quos.Project is the project identifier.
bcBadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/orgs/{org}/projects/{project}/ansible/activities/{id} HTTP/1.1
Host: localhost:80
Harness-Account: x
Accept: */*
{
"account": "cg",
"created": 1627590400,
"event_type": "activity-execution",
"id": "dc538c61-de48-4220-958c-5f3c4f983daa",
"inventories": "Dicta eligendi sit explicabo.",
"metadata": {
"activity_status": "Asperiores quod molestiae consequatur vitae.",
"filters": "tags=deploy skip-tags=slow limit=web",
"git_branch": "Voluptas animi dolor dolorem laborum.",
"git_commit_message": "Dolor facere.",
"git_commit_sha": "Voluptatem quia earum voluptatem quas in.",
"git_repo": "Dolores nobis.",
"metrics": {
"circuit_breaker_triggered": false,
"duration_ms": 4956144492920646000,
"host_changed": 7991066862074085000,
"host_failed": 7286501368895138000,
"host_ok": 8723992317937321000,
"host_skipped": 7515790151550636000,
"host_unreachable": 1865379895225030100,
"output_size_bytes": 7964733890466916000,
"payload_size_bytes": 2592876429800924000,
"total_hosts": 7520422272859706000,
"total_tasks": 5767911488264385000
},
"pipeline": "Ex vel quaerat sunt minima dolor.",
"pipeline_execution_id": "Nulla ratione et omnis.",
"pipeline_execution_number": "Ipsum qui totam cum.",
"pipeline_name": "Et alias quis sint porro delectus est.",
"pipeline_stage_id": "Pariatur porro earum sed.",
"plugin_version": "Est laudantium.",
"results_uuid": "Quam repellat omnis eos aut.",
"trigger": {
"Id molestias.": "Beatae aut asperiores nulla."
}
},
"org": "20",
"playbooks": "Sit qui quae saepe molestias dolores est.",
"project": "xp"
}List all stored data for a inventory or playbook.
Org is the organisation identifier.
50Project is the project identifier.
4u8Inventory search term
Rem nihil ad.Playbook search term
Accusantium quia dolores harum laborum aut.Filter by pipeline execution ID
Quia nam est.Filter by pipeline execution stage ID
Et molestiae.Filter by data type
Dolorem hic fugit fuga repellat quasi.Limit is the number of records to return for a page.
30Example: 30Page is the page number to return relative to the page 'limit'.
1Example: 1Account is the internal customer account ID.
999OK response.
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/orgs/{org}/projects/{project}/ansible/data HTTP/1.1
Host: localhost:80
Harness-Account: 999
Accept: */*
[
{
"account": "uwb",
"created": 58238389623161304,
"data_type": "task_results",
"id": "dc538c61-de48-4220-958c-5f3c4f983daa",
"inventories": "Voluptatem voluptas.",
"org": "y",
"pipeline_execution_id": "Est cupiditate et quia in nisi.",
"pipeline_id": "Est vero dolore et.",
"pipeline_stage_id": "Molestiae quia.",
"playbooks": "Eos ea eaque consequuntur animi placeat qui.",
"project": "d7v",
"stage_id": "Laboriosam assumenda modi quisquam laboriosam facere."
},
{
"account": "uwb",
"created": 58238389623161304,
"data_type": "task_results",
"id": "dc538c61-de48-4220-958c-5f3c4f983daa",
"inventories": "Voluptatem voluptas.",
"org": "y",
"pipeline_execution_id": "Est cupiditate et quia in nisi.",
"pipeline_id": "Est vero dolore et.",
"pipeline_stage_id": "Molestiae quia.",
"playbooks": "Eos ea eaque consequuntur animi placeat qui.",
"project": "d7v",
"stage_id": "Laboriosam assumenda modi quisquam laboriosam facere."
}
]Store binary data generated by ansible.
Org is the organisation identifier.
unProject is the project identifier.
mgThe unique identifier for the associated pipeline
Est reiciendis consequatur sunt quae.The unique identifier for a stage
Repudiandae rerum vero earum incidunt rerum.The unique identifier for the associated pipeline execution
Pariatur aperiam.The unique identifier for the associated pipeline execution stage
Id excepturi ullam nostrum.Type of data stored
task_resultsPossible values: Inventories associated with this event
Accusantium placeat id totam ratione dolore.Playbooks associated with this event
Et sequi sit sed harum cupiditate.Account is the internal customer account ID.
y0Size in bytes of the data.
2824900171263843000OK response.
The unique identifier for the data
dc538c61-de48-4220-958c-5f3c4f983daaBadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
POST /api/orgs/{org}/projects/{project}/ansible/data?data_type=task_results&inventories=Accusantium+placeat+id+totam+ratione+dolore.&playbooks=Et+sequi+sit+sed+harum+cupiditate. HTTP/1.1
Host: localhost:80
Harness-Account: y0
Accept: */*
{
"id": "dc538c61-de48-4220-958c-5f3c4f983daa"
}Get binary data generated by the provisioner, such as plans and state files.
Org is the organisation identifier.
nProject is the project identifier.
8The unique identifier for the data
dc538c61-de48-4220-958c-5f3c4f983daaAccount is the internal customer account ID.
znOK response.
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/orgs/{org}/projects/{project}/ansible/data/{id} HTTP/1.1
Host: localhost:80
Harness-Account: zn
Accept: */*
binaryOrg is the organisation identifier.
4tProject is the project identifier.
p9Account is the internal customer account ID.
4sThe type of event that occurred
activity-executionPossible values: Inventories associated with this event
Pariatur ullam modi voluptate assumenda quisquam.Playbooks associated with this event
Itaque id praesentium explicabo.OK response.
No content
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
POST /api/orgs/{org}/projects/{project}/ansible/events HTTP/1.1
Host: localhost:80
Harness-Account: 4s
Content-Type: application/json
Accept: */*
Content-Length: 1424
{
"event_type": "activity-execution",
"inventories": "Corrupti excepturi dolorum possimus.",
"metadata": {
"activity_status": "Est omnis voluptas.",
"filters": "tags=deploy skip-tags=slow limit=web",
"git_branch": "Et id.",
"git_commit_message": "Sed est iste ea.",
"git_commit_sha": "Aut aut et facilis delectus recusandae pariatur.",
"git_repo": "Asperiores aut eum quis quia quos quaerat.",
"metrics": {
"circuit_breaker_triggered": false,
"duration_ms": 7390561685357238000,
"host_changed": 8467723547224066000,
"host_failed": 628267883614234200,
"host_ok": 3028832422680946000,
"host_skipped": 7722797242178057000,
"host_unreachable": 6446899952438172000,
"output_size_bytes": 5696886528735868000,
"payload_size_bytes": 7462415569247186000,
"total_hosts": 4895565323984840000,
"total_tasks": 4597798843542031400
},
"pipeline": "Vero ipsam molestiae non mollitia ea.",
"pipeline_execution_id": "Nihil recusandae rerum recusandae ea qui.",
"pipeline_execution_number": "Dolore voluptatibus.",
"pipeline_name": "Voluptatibus tempore aut facere facere et magnam.",
"pipeline_stage_id": "Repellat quisquam dolorem sed magni.",
"plugin_version": "Rerum ut in aliquam eaque.",
"results_uuid": "Dolores minima expedita sed architecto eligendi.",
"trigger": {
"Et aliquid autem adipisci maiores.": "Inventore reprehenderit harum illum cupiditate quis illo.",
"Molestias voluptatem quo numquam eos.": "Sunt et.",
"Omnis ipsa.": "Qui animi eum porro et a non."
}
},
"playbooks": "Dolorem corrupti."
}No content
Retrieve a playbook or plugin inventory YAML file from its configured git repository.
Org is the organisation identifier.
4eProject is the project identifier.
vType of ansible resource (playbook or inventory).
playbookPossible values: Identifier of the playbook or inventory.
my-playbookAccount is the internal customer account ID.
4v4OK response.
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/orgs/{org}/projects/{project}/ansible/file?resource_type=playbook&identifier=my-playbook HTTP/1.1
Host: localhost:80
Harness-Account: 4v4
Accept: */*
binaryList all hosts across all inventories.
Org is the organisation identifier.
fzProject is the project identifier.
buxLimit is the number of records to return for a page.
30Example: 30Page is the page number to return relative to the page 'limit'.
1Example: 1Sort order for results
host_address,ASCExample: updated,DESCPossible values: Filter results by partial host address match
""Example: web-serverFilter results by inventory membership
""Example: production-inventoryFilter results by last activity status
""Example: okFilter results by last activity created time (Unix timestamp in milliseconds) - inclusive start of time range
1627590400000Filter results by last activity created time (Unix timestamp in milliseconds) - inclusive end of time range
1630268800000Account is the internal customer account ID.
plpOK response.
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/orgs/{org}/projects/{project}/ansible/hosts HTTP/1.1
Host: localhost:80
Harness-Account: plp
Accept: */*
[
{
"created": 1627590400,
"host_address": "web-server-1.example.com",
"id": "dc538c61-de48-4220-958c-5f3c4f983daa",
"inventories": [
"inventory-1",
"inventory-2"
],
"last_activity": {
"created": 1627590400,
"playbooks": [
"deploy.yml"
],
"status": "ok"
},
"updated": 1627590400
},
{
"created": 1627590400,
"host_address": "web-server-1.example.com",
"id": "dc538c61-de48-4220-958c-5f3c4f983daa",
"inventories": [
"inventory-1",
"inventory-2"
],
"last_activity": {
"created": 1627590400,
"playbooks": [
"deploy.yml"
],
"status": "ok"
},
"updated": 1627590400
},
{
"created": 1627590400,
"host_address": "web-server-1.example.com",
"id": "dc538c61-de48-4220-958c-5f3c4f983daa",
"inventories": [
"inventory-1",
"inventory-2"
],
"last_activity": {
"created": 1627590400,
"playbooks": [
"deploy.yml"
],
"status": "ok"
},
"updated": 1627590400
},
{
"created": 1627590400,
"host_address": "web-server-1.example.com",
"id": "dc538c61-de48-4220-958c-5f3c4f983daa",
"inventories": [
"inventory-1",
"inventory-2"
],
"last_activity": {
"created": 1627590400,
"playbooks": [
"deploy.yml"
],
"status": "ok"
},
"updated": 1627590400
}
]Get details for a single host.
Org is the organisation identifier.
rhkProject is the project identifier.
lkThe unique identifier for this host
dc538c61-de48-4220-958c-5f3c4f983daaAccount is the internal customer account ID.
rOK response.
Timestamp when the resource was created
1627590400The address of the host (hostname or IP)
web-server-1.example.comThe unique identifier for this host
dc538c61-de48-4220-958c-5f3c4f983daaList of inventory identifiers this host belongs to
["inventory-1","inventory-2"]Timestamp when the resource was last updated
1627590400BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/orgs/{org}/projects/{project}/ansible/hosts/{id} HTTP/1.1
Host: localhost:80
Harness-Account: r
Accept: */*
{
"created": 1627590400,
"host_address": "web-server-1.example.com",
"id": "dc538c61-de48-4220-958c-5f3c4f983daa",
"inventories": [
"inventory-1",
"inventory-2"
],
"last_activity": {
"created": 1627590400,
"playbooks": [
"deploy.yml"
],
"status": "ok"
},
"updated": 1627590400
}List all activities for a specific host.
Org is the organisation identifier.
2Project is the project identifier.
t5kThe unique identifier for this host
dc538c61-de48-4220-958c-5f3c4f983daaLimit is the number of records to return for a page.
30Example: 30Page is the page number to return relative to the page 'limit'.
1Example: 1Sort order for results
created,DESCExample: created,DESCPossible values: Account is the internal customer account ID.
3mOK response.
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/orgs/{org}/projects/{project}/ansible/hosts/{id}/activities HTTP/1.1
Host: localhost:80
Harness-Account: 3m
Accept: */*
[
{
"account": "42p",
"created": 1627590400,
"data": "Dolorum quia incidunt.",
"event_type": "activity-execution",
"id": "dc538c61-de48-4220-958c-5f3c4f983daa",
"inventories": "Delectus deleniti animi libero dolore.",
"metadata": {
"activity_status": "Dolorem amet quae.",
"filters": "tags=deploy skip-tags=slow limit=web",
"git_branch": "Quia aut eum dignissimos itaque.",
"git_commit_message": "Aspernatur assumenda eius sit vitae quos dolorem.",
"git_commit_sha": "Facilis et harum.",
"git_repo": "Iure reprehenderit.",
"metrics": {
"circuit_breaker_triggered": false,
"duration_ms": 3729912682196842500,
"host_changed": 7326503586878806000,
"host_failed": 510844048246640640,
"host_ok": 7033055310389248000,
"host_skipped": 8298202262197766000,
"host_unreachable": 3136096962125600300,
"output_size_bytes": 5580013020588243000,
"payload_size_bytes": 5024210113655448000,
"total_hosts": 3289931238796667000,
"total_tasks": 8463213749394180000
},
"pipeline": "Sint consequuntur libero commodi veritatis atque.",
"pipeline_execution_id": "Omnis autem ullam quas et.",
"pipeline_execution_number": "Rem cumque molestias assumenda.",
"pipeline_name": "Et accusamus veniam libero.",
"pipeline_stage_id": "Repellat soluta.",
"plugin_version": "Amet totam laboriosam voluptas.",
"results_uuid": "Officia necessitatibus quis provident consequatur.",
"trigger": {
"Alias quis.": "Quaerat quasi.",
"Autem aut.": "Quis ipsa est.",
"Qui et.": "Molestiae autem nisi."
}
},
"org": "5z",
"playbooks": "Sint voluptatem sunt aliquam rem.",
"project": "t3",
"status": "ok"
},
{
"account": "42p",
"created": 1627590400,
"data": "Dolorum quia incidunt.",
"event_type": "activity-execution",
"id": "dc538c61-de48-4220-958c-5f3c4f983daa",
"inventories": "Delectus deleniti animi libero dolore.",
"metadata": {
"activity_status": "Dolorem amet quae.",
"filters": "tags=deploy skip-tags=slow limit=web",
"git_branch": "Quia aut eum dignissimos itaque.",
"git_commit_message": "Aspernatur assumenda eius sit vitae quos dolorem.",
"git_commit_sha": "Facilis et harum.",
"git_repo": "Iure reprehenderit.",
"metrics": {
"circuit_breaker_triggered": false,
"duration_ms": 3729912682196842500,
"host_changed": 7326503586878806000,
"host_failed": 510844048246640640,
"host_ok": 7033055310389248000,
"host_skipped": 8298202262197766000,
"host_unreachable": 3136096962125600300,
"output_size_bytes": 5580013020588243000,
"payload_size_bytes": 5024210113655448000,
"total_hosts": 3289931238796667000,
"total_tasks": 8463213749394180000
},
"pipeline": "Sint consequuntur libero commodi veritatis atque.",
"pipeline_execution_id": "Omnis autem ullam quas et.",
"pipeline_execution_number": "Rem cumque molestias assumenda.",
"pipeline_name": "Et accusamus veniam libero.",
"pipeline_stage_id": "Repellat soluta.",
"plugin_version": "Amet totam laboriosam voluptas.",
"results_uuid": "Officia necessitatibus quis provident consequatur.",
"trigger": {
"Alias quis.": "Quaerat quasi.",
"Autem aut.": "Quis ipsa est.",
"Qui et.": "Molestiae autem nisi."
}
},
"org": "5z",
"playbooks": "Sint voluptatem sunt aliquam rem.",
"project": "t3",
"status": "ok"
}
]List all inventories that a specific host belongs to.
Org is the organisation identifier.
xProject is the project identifier.
8The unique identifier for this host
dc538c61-de48-4220-958c-5f3c4f983daaLimit is the number of records to return for a page.
30Example: 30Page is the page number to return relative to the page 'limit'.
1Example: 1Account is the internal customer account ID.
p4yOK response.
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/orgs/{org}/projects/{project}/ansible/hosts/{id}/inventories HTTP/1.1
Host: localhost:80
Harness-Account: p4y
Accept: */*
[
{
"account": "zd",
"created": 1627590400,
"description": "Production infrastructure inventory",
"identifier": "test_inventory",
"name": "test inventory",
"org": "2w0",
"project": "u",
"tags": [
"Molestias autem cum sint.",
"Eum omnis."
],
"type": "remote",
"updated": 1627686800
},
{
"account": "zd",
"created": 1627590400,
"description": "Production infrastructure inventory",
"identifier": "test_inventory",
"name": "test inventory",
"org": "2w0",
"project": "u",
"tags": [
"Molestias autem cum sint.",
"Eum omnis."
],
"type": "remote",
"updated": 1627686800
}
]Get aggregated statistics for a specific host.
Org is the organisation identifier.
9Project is the project identifier.
aThe unique identifier for this host
dc538c61-de48-4220-958c-5f3c4f983daaAccount is the internal customer account ID.
1zOK response.
Average number of tasks executed across the last 5 runs
12.4Number of failed runs (status failures or unreachable) in the last 7 days
2Playbooks from the most recent execution against this host
["deploy.yml"]Timestamp (ms) of the most recent execution against this host
1627590400000Percentage of successful runs in the last 30 days (0-100)
95.5Total number of runs in the last 30 days
42BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/orgs/{org}/projects/{project}/ansible/hosts/{id}/stats HTTP/1.1
Host: localhost:80
Harness-Account: 1z
Accept: */*
{
"avg_tasks_last_5_runs": 12.4,
"failures_7d": 2,
"last_playbook": [
"deploy.yml"
],
"last_playbook_at": 1627590400000,
"success_rate_30d": 95.5,
"total_runs_30d": 42
}Export all filtered hosts to CSV format. Includes all matching hosts (not paginated).
Org is the organisation identifier.
hliProject is the project identifier.
e1Search term to filter hosts by name
Maxime rem odio aspernatur quidem.Filter results by inventory identifier
Voluptatem harum ad similique.Filter results by host status (based on most recent activity)
rescuedPossible values: Filter results by last activity created time (Unix timestamp in milliseconds) - inclusive start of time range
1620268800000Filter results by last activity created time (Unix timestamp in milliseconds) - inclusive end of time range
1630268800000Account is the internal customer account ID.
5w0OK response.
[85,116,32,116,101,109,112,111,114,97,46]BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/orgs/{org}/projects/{project}/ansible/hosts/export HTTP/1.1
Host: localhost:80
Harness-Account: 5w0
Accept: */*
[
79,
109,
110,
105,
115,
32,
109,
111,
108,
108,
105,
116,
105,
97,
46
]Get aggregated host counts grouped by the latest activity status, scoped to an account/org/project.
Org is the organisation identifier.
cProject is the project identifier.
posFilter results by partial host address match
""Example: web-serverFilter results by inventory membership
""Example: production-inventoryFilter results by latest activity created time (Unix timestamp in milliseconds) - inclusive start of time range
1627590400000Filter results by latest activity created time (Unix timestamp in milliseconds) - inclusive end of time range
1630268800000Account is the internal customer account ID.
q8kOK response.
Number of hosts whose latest activity status is 'changed'
4Number of hosts whose latest activity status is 'failures'
0Number of hosts whose latest activity status is 'ignored'
0Number of hosts whose latest activity status is 'ok'
3Number of hosts whose latest activity status is 'rescued'
0Number of hosts whose latest activity status is 'skipped'
0Total number of hosts matching the filters
7Number of hosts with no activity rows (no derivable latest status)
0Number of hosts whose latest activity status is 'unreachable'
0BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/orgs/{org}/projects/{project}/ansible/hosts/summary HTTP/1.1
Host: localhost:80
Harness-Account: q8k
Accept: */*
{
"changed": 4,
"failures": 0,
"ignored": 0,
"ok": 3,
"rescued": 0,
"skipped": 0,
"total": 7,
"unknown": 0,
"unreachable": 0
}List all inventories.
Org is the organisation identifier.
xshProject is the project identifier.
a7bLimit is the number of records to return for a page.
30Example: 30Page is the page number to return relative to the page 'limit'.
1Example: 1Filter results by partial name match
""Example: mystaSort order for results
name,ASCExample: updated,ASCPossible values: Include inventory details
falseExample: falseFilter results by tags (OR logic, exact match)
["Aut quod expedita.","Consequatur officia sequi temporibus.","Rerum harum explicabo voluptatibus ut.","Fugit tempora."]Account is the internal customer account ID.
tmOK response.
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/orgs/{org}/projects/{project}/ansible/inventory HTTP/1.1
Host: localhost:80
Harness-Account: tm
Accept: */*
[
{
"account": "vja",
"created": 1627590400,
"data": "{ \"hosts\": { \"host1.example.com\": null, \"host2.example.com\": null }}",
"description": "Production infrastructure inventory",
"identifier": "test_inventory",
"name": "test inventory",
"org": "ff",
"project": "6n",
"tags": [
"Voluptatem a porro cum.",
"Aliquam adipisci et aut molestias omnis iste.",
"Modi vel dicta velit."
],
"type": "remote",
"updated": 1627686800
},
{
"account": "vja",
"created": 1627590400,
"data": "{ \"hosts\": { \"host1.example.com\": null, \"host2.example.com\": null }}",
"description": "Production infrastructure inventory",
"identifier": "test_inventory",
"name": "test inventory",
"org": "ff",
"project": "6n",
"tags": [
"Voluptatem a porro cum.",
"Aliquam adipisci et aut molestias omnis iste.",
"Modi vel dicta velit."
],
"type": "remote",
"updated": 1627686800
},
{
"account": "vja",
"created": 1627590400,
"data": "{ \"hosts\": { \"host1.example.com\": null, \"host2.example.com\": null }}",
"description": "Production infrastructure inventory",
"identifier": "test_inventory",
"name": "test inventory",
"org": "ff",
"project": "6n",
"tags": [
"Voluptatem a porro cum.",
"Aliquam adipisci et aut molestias omnis iste.",
"Modi vel dicta velit."
],
"type": "remote",
"updated": 1627686800
}
]Create a new inventory.
Org is the organisation identifier.
13Project is the project identifier.
z2Account is the internal customer account ID.
gbDescription documents the inventory purpose and usage
Production infrastructure inventoryThe unique identifier for this inventory
test_inventoryName is the human readable name
test inventoryTags associated with the inventory
["Repellat corporis sed perspiciatis saepe voluptatem mollitia.","Sit voluptatem ducimus dolor voluptatem fuga.","Consectetur fugiat ut.","Vel nihil fugiat unde pariatur hic."]Type indicates what kind of inventory this is
manualPossible values: Created response.
Account is the internal customer account ID.
luTimestamp when the resource was created.
1627590400Description documents the inventory purpose and usage
Production infrastructure inventoryThe unique identifier for this inventory
test_inventoryName is the human readable name
test inventoryOrg is the organisation identifier.
2kProject is the project identifier.
mq3Tags associated with the inventory
["Perspiciatis dolores perspiciatis quibusdam reprehenderit ut.","Saepe est voluptatem.","Voluptatibus et alias."]Type indicates what kind of inventory this is
dynamicPossible values: Timestamp when the resource was last updated.
1627686800BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
POST /api/orgs/{org}/projects/{project}/ansible/inventory HTTP/1.1
Host: localhost:80
Harness-Account: gb
Content-Type: application/json
Accept: */*
Content-Length: 1204
{
"description": "Production infrastructure inventory",
"dynamic_groups": [
{
"configuration": {
"host_address_attribute": "<+attributes.public_dns>",
"include_conditions": [
{
"attribute": "tag.environment",
"operator": "equals",
"value": "prod"
}
],
"resource_type": "aws_instance"
},
"connector_identifier": "my-workspace",
"connector_type": "workspace"
}
],
"groups": [
{
"hosts": [
{
"host1.example.com": null
}
],
"name": "my-group"
}
],
"identifier": "test_inventory",
"name": "test inventory",
"plugin_options": {
"inline_yaml": "all:\\n hosts:\\n localhost:\\n",
"provider_connector_identifier": "my_aws_connector",
"provider_connector_type": "aws",
"repository": "my-repo",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "account.my_git_connector",
"repository_path": "inventories/plugin-inventory.yml",
"source_type": "git"
},
"remote_source": {
"repository": "my-repo",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "account.my_git_connector",
"repository_path": "inventories/production/hosts.yml"
},
"tags": [
"Minima et laborum in et.",
"Aspernatur aut facere labore est eius similique.",
"Qui doloribus magni unde qui odit ipsa."
],
"type": "dynamic",
"vars": [
{
"name": "my-var",
"value": "my-value"
}
]
}{
"account": "2y",
"created": 1627590400,
"description": "Production infrastructure inventory",
"identifier": "test_inventory",
"name": "test inventory",
"org": "e",
"policy_evaluation": {
"account_id": "XRQAjvT37acOiXx9PRaQMF",
"action": "onrun",
"created": 1636370209475,
"details": [
{
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"action": "onrun",
"created": 1636669297674,
"description": "Captures critical production policies",
"details": [
{
"deny_messages": [
"deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}",
"policy": {
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
},
{
"deny_messages": [
"deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}",
"policy": {
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
}
],
"enabled": true,
"identifier": "policyset-1",
"name": "Production Policies",
"org_id": "test-org",
"project_id": "test-project",
"status": "error",
"type": "pipeline",
"updated": 1636669297674
},
{
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"action": "onrun",
"created": 1636669297674,
"description": "Captures critical production policies",
"details": [
{
"deny_messages": [
"deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}",
"policy": {
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
},
{
"deny_messages": [
"deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}",
"policy": {
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
}
],
"enabled": true,
"identifier": "policyset-1",
"name": "Production Policies",
"org_id": "test-org",
"project_id": "test-project",
"status": "error",
"type": "pipeline",
"updated": 1636669297674
},
{
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"action": "onrun",
"created": 1636669297674,
"description": "Captures critical production policies",
"details": [
{
"deny_messages": [
"deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}",
"policy": {
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
},
{
"deny_messages": [
"deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}",
"policy": {
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
}
],
"enabled": true,
"identifier": "policyset-1",
"name": "Production Policies",
"org_id": "test-org",
"project_id": "test-project",
"status": "error",
"type": "pipeline",
"updated": 1636669297674
}
],
"entity": "7bbca5d4-e9f2-4955-9b2a-019ec4d3645e",
"entity_metadata": "7bbca5d4-e9f2-4955-9b2a-019ec4d3645e",
"id": 123,
"input": "",
"org_id": "test-org",
"project_id": "test-project",
"status": "error",
"type": "pipeline,service"
},
"project": "n",
"tags": [
"Saepe ratione amet.",
"Tempore ipsam doloribus.",
"Harum optio quo voluptatem.",
"Non ab ad deserunt velit adipisci."
],
"type": "plugin",
"updated": 1627686800
}Show an individual inventory.
Org is the organisation identifier.
dProject is the project identifier.
cInventory identifier
Rem ut veritatis ut.Use arrays when displaying inventory data
falseExample: falseAccount is the internal customer account ID.
5vOK response.
Account is the internal customer account ID.
hTimestamp when the resource was created.
1627590400The data representing the inventory
{ "hosts": { "host1.example.com": null, "host2.example.com": null }}Description documents the inventory purpose and usage
Production infrastructure inventoryThe unique identifier for this inventory
test_inventoryName is the human readable name
test inventoryOrg is the organisation identifier.
muProject is the project identifier.
6Tags associated with the inventory
["Iusto veritatis non.","Excepturi eaque consequatur quasi numquam numquam necessitatibus.","Non perferendis natus voluptas sit dolores sint."]Type indicates what kind of inventory this is
remotePossible values: Timestamp when the resource was last updated.
1627686800BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/orgs/{org}/projects/{project}/ansible/inventory/{identifier} HTTP/1.1
Host: localhost:80
Harness-Account: 5v
Accept: */*
{
"account": "ff",
"created": 1627590400,
"data": "{ \"hosts\": { \"host1.example.com\": null, \"host2.example.com\": null }}",
"description": "Production infrastructure inventory",
"identifier": "test_inventory",
"name": "test inventory",
"org": "2k",
"project": "uuw",
"tags": [
"Aut quis ad quae quia itaque voluptatem.",
"Est consequatur deleniti et.",
"Consequuntur molestiae soluta sapiente ducimus.",
"Illum ullam et ullam voluptatem."
],
"type": "remote",
"updated": 1627686800
}Update an existing inventory.
Org is the organisation identifier.
553Project is the project identifier.
g6oThe unique identifier for this inventory
test_inventoryAccount is the internal customer account ID.
qyqThe data representing the inventory
{ "hosts": { "host1.example.com": null, "host2.example.com": null }}Description documents the inventory purpose and usage
Production infrastructure inventoryName is the human readable name
test inventoryTags associated with the inventory
["Nobis et ratione nesciunt.","Sint voluptates facere nobis sit libero error.","Consequuntur et eveniet id."]OK response.
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
PUT /api/orgs/{org}/projects/{project}/ansible/inventory/{identifier} HTTP/1.1
Host: localhost:80
Harness-Account: qyq
Content-Type: application/json
Accept: */*
Content-Length: 237
{
"data": "{ \"hosts\": { \"host1.example.com\": null, \"host2.example.com\": null }}",
"description": "Production infrastructure inventory",
"name": "test inventory",
"tags": [
"Assumenda veniam qui amet nostrum nisi officia.",
"Placeat minus."
]
}{
"policy_evaluation": {
"account_id": "XRQAjvT37acOiXx9PRaQMF",
"action": "onrun",
"created": 1636370209475,
"details": [
{
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"action": "onrun",
"created": 1636669297674,
"description": "Captures critical production policies",
"details": [
{
"deny_messages": [
"deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}",
"policy": {
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
},
{
"deny_messages": [
"deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}",
"policy": {
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
}
],
"enabled": true,
"identifier": "policyset-1",
"name": "Production Policies",
"org_id": "test-org",
"project_id": "test-project",
"status": "error",
"type": "pipeline",
"updated": 1636669297674
},
{
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"action": "onrun",
"created": 1636669297674,
"description": "Captures critical production policies",
"details": [
{
"deny_messages": [
"deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}",
"policy": {
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
},
{
"deny_messages": [
"deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}",
"policy": {
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
}
],
"enabled": true,
"identifier": "policyset-1",
"name": "Production Policies",
"org_id": "test-org",
"project_id": "test-project",
"status": "error",
"type": "pipeline",
"updated": 1636669297674
},
{
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"action": "onrun",
"created": 1636669297674,
"description": "Captures critical production policies",
"details": [
{
"deny_messages": [
"deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}",
"policy": {
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
},
{
"deny_messages": [
"deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}",
"policy": {
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
}
],
"enabled": true,
"identifier": "policyset-1",
"name": "Production Policies",
"org_id": "test-org",
"project_id": "test-project",
"status": "error",
"type": "pipeline",
"updated": 1636669297674
}
],
"entity": "7bbca5d4-e9f2-4955-9b2a-019ec4d3645e",
"entity_metadata": "7bbca5d4-e9f2-4955-9b2a-019ec4d3645e",
"id": 123,
"input": "",
"org_id": "test-org",
"project_id": "test-project",
"status": "error",
"type": "pipeline,service"
}
}Delete an existing inventory.
Org is the organisation identifier.
cProject is the project identifier.
6qThe unique identifier for this inventory
Quo asperiores eum.Account is the internal customer account ID.
pOK response.
No content
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
DELETE /api/orgs/{org}/projects/{project}/ansible/inventory/{identifier} HTTP/1.1
Host: localhost:80
Harness-Account: p
Accept: */*
No content
Show an individual inventory as YAML.
Org is the organisation identifier.
dvcProject is the project identifier.
v3gThe unique identifier for this inventory
Officia molestiae aut mollitia dolores.Account is the internal customer account ID.
rOK response.
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/orgs/{org}/projects/{project}/ansible/inventory/{identifier}/ansible HTTP/1.1
Host: localhost:80
Harness-Account: r
Accept: */*
Aut est fugiat reprehenderit id.: Quod magnam laborum optio et neque.
Show an individual inventory's groups.
Org is the organisation identifier.
ikProject is the project identifier.
c5Inventory identifier
Et est fugiat.Limit is the number of records to return for a page.
30Example: 30Page is the page number to return relative to the page 'limit'.
1Example: 1Account is the internal customer account ID.
rOK response.
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/orgs/{org}/projects/{project}/ansible/inventory/{identifier}/groups HTTP/1.1
Host: localhost:80
Harness-Account: r
Accept: */*
{
"groups": [
"Placeat incidunt error.",
"Enim molestiae molestiae et quidem deleniti ut."
]
}Show an individual inventory hosts.
Org is the organisation identifier.
toProject is the project identifier.
6Inventory identifier
Pariatur est qui voluptatem fugit autem ea.Limit is the number of records to return for a page.
30Example: 30Page is the page number to return relative to the page 'limit'.
1Example: 1Filter results by group
""Example: Est pariatur qui omnis qui nemo.Account is the internal customer account ID.
aOK response.
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/orgs/{org}/projects/{project}/ansible/inventory/{identifier}/hosts HTTP/1.1
Host: localhost:80
Harness-Account: a
Accept: */*
{
"hosts": [
{
"created": 3168776483555413500,
"groups": [
"Suscipit qui animi est magnam qui.",
"Qui ut repudiandae a modi deleniti laudantium.",
"Et fuga rerum aut.",
"Autem sit fugiat facere sit voluptatem."
],
"host_address": "host1.example.com",
"updated": 7149443571064899000,
"vars": [
{
"file_name": "Ea iste sunt ab accusantium.",
"key": "vq",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Provident veritatis dolor.",
"value_type": "Tenetur enim."
},
{
"file_name": "Ea iste sunt ab accusantium.",
"key": "vq",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Provident veritatis dolor.",
"value_type": "Tenetur enim."
}
]
},
{
"created": 3168776483555413500,
"groups": [
"Suscipit qui animi est magnam qui.",
"Qui ut repudiandae a modi deleniti laudantium.",
"Et fuga rerum aut.",
"Autem sit fugiat facere sit voluptatem."
],
"host_address": "host1.example.com",
"updated": 7149443571064899000,
"vars": [
{
"file_name": "Ea iste sunt ab accusantium.",
"key": "vq",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Provident veritatis dolor.",
"value_type": "Tenetur enim."
},
{
"file_name": "Ea iste sunt ab accusantium.",
"key": "vq",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Provident veritatis dolor.",
"value_type": "Tenetur enim."
}
]
},
{
"created": 3168776483555413500,
"groups": [
"Suscipit qui animi est magnam qui.",
"Qui ut repudiandae a modi deleniti laudantium.",
"Et fuga rerum aut.",
"Autem sit fugiat facere sit voluptatem."
],
"host_address": "host1.example.com",
"updated": 7149443571064899000,
"vars": [
{
"file_name": "Ea iste sunt ab accusantium.",
"key": "vq",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Provident veritatis dolor.",
"value_type": "Tenetur enim."
},
{
"file_name": "Ea iste sunt ab accusantium.",
"key": "vq",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Provident veritatis dolor.",
"value_type": "Tenetur enim."
}
]
}
]
}Create a new inventory host.
Org is the organisation identifier.
uProject is the project identifier.
v9tThe unique identifier for this inventory
test_inventoryAccount is the internal customer account ID.
42Groups is the list of groups the host belongs to.
["Non exercitationem aut voluptatem nobis.","Error numquam beatae.","Odio dolor quia necessitatibus aut aut.","Quaerat eius ut."]Host address is the address of the host.
host1.example.comCreated response.
No content
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
POST /api/orgs/{org}/projects/{project}/ansible/inventory/{identifier}/hosts HTTP/1.1
Host: localhost:80
Harness-Account: 42
Content-Type: application/json
Accept: */*
Content-Length: 935
{
"groups": [
"Dolor dolorem ab.",
"Sed et incidunt ipsum.",
"Aut quasi aut ratione est perspiciatis."
],
"host_address": "host1.example.com",
"vars": [
{
"file_name": "Enim facilis libero rerum.",
"key": "yv",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Optio ut dolorum dignissimos fuga nisi.",
"value_type": "Sit qui quam soluta consequatur."
},
{
"file_name": "Enim facilis libero rerum.",
"key": "yv",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Optio ut dolorum dignissimos fuga nisi.",
"value_type": "Sit qui quam soluta consequatur."
},
{
"file_name": "Enim facilis libero rerum.",
"key": "yv",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Optio ut dolorum dignissimos fuga nisi.",
"value_type": "Sit qui quam soluta consequatur."
},
{
"file_name": "Enim facilis libero rerum.",
"key": "yv",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Optio ut dolorum dignissimos fuga nisi.",
"value_type": "Sit qui quam soluta consequatur."
}
]
}No content
Replace the data of an existing static (manual) Ansible inventory by parsing YAML or INI content. Preserves secret UUIDs for keys carried over.
Org is the organisation identifier.
l86Project is the project identifier.
vnThe identifier of the inventory to replace.
t39Account is the internal customer account ID.
gRaw inventory content.
6mSource format of the content.
iniPossible values: OK response.
Warnings surfaced during replace.
["Laudantium delectus.","Repudiandae eos.","Non autem quia.","Eveniet et aliquam tenetur fugit."]BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
PUT /api/orgs/{org}/projects/{project}/ansible/inventory/{identifier}/import HTTP/1.1
Host: localhost:80
Harness-Account: g
Content-Type: application/json
Accept: */*
Content-Length: 32
{
"content": "nbl",
"format": "ini"
}{
"warnings": [
"Dignissimos amet.",
"Quod aut sint."
]
}Update an existing plugin inventory configuration.
Org is the organisation identifier.
heProject is the project identifier.
kwInventory identifier
Magnam voluptate tempora aspernatur qui deleniti molestiae.Account is the internal customer account ID.
rlOK response.
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
PUT /api/orgs/{org}/projects/{project}/ansible/inventory/{identifier}/plugin HTTP/1.1
Host: localhost:80
Harness-Account: rl
Content-Type: application/json
Accept: */*
Content-Length: 358
{
"plugin_options": {
"inline_yaml": "all:\\n hosts:\\n localhost:\\n",
"provider_connector_identifier": "my_aws_connector",
"provider_connector_type": "aws",
"repository": "my-repo",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "account.my_git_connector",
"repository_path": "inventories/plugin-inventory.yml",
"source_type": "git"
}
}{
"policy_evaluation": {
"account_id": "XRQAjvT37acOiXx9PRaQMF",
"action": "onrun",
"created": 1636370209475,
"details": [
{
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"action": "onrun",
"created": 1636669297674,
"description": "Captures critical production policies",
"details": [
{
"deny_messages": [
"deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}",
"policy": {
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
},
{
"deny_messages": [
"deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}",
"policy": {
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
}
],
"enabled": true,
"identifier": "policyset-1",
"name": "Production Policies",
"org_id": "test-org",
"project_id": "test-project",
"status": "error",
"type": "pipeline",
"updated": 1636669297674
},
{
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"action": "onrun",
"created": 1636669297674,
"description": "Captures critical production policies",
"details": [
{
"deny_messages": [
"deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}",
"policy": {
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
},
{
"deny_messages": [
"deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}",
"policy": {
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
}
],
"enabled": true,
"identifier": "policyset-1",
"name": "Production Policies",
"org_id": "test-org",
"project_id": "test-project",
"status": "error",
"type": "pipeline",
"updated": 1636669297674
},
{
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"action": "onrun",
"created": 1636669297674,
"description": "Captures critical production policies",
"details": [
{
"deny_messages": [
"deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}",
"policy": {
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
},
{
"deny_messages": [
"deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}",
"policy": {
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
}
],
"enabled": true,
"identifier": "policyset-1",
"name": "Production Policies",
"org_id": "test-org",
"project_id": "test-project",
"status": "error",
"type": "pipeline",
"updated": 1636669297674
}
],
"entity": "7bbca5d4-e9f2-4955-9b2a-019ec4d3645e",
"entity_metadata": "7bbca5d4-e9f2-4955-9b2a-019ec4d3645e",
"id": 123,
"input": "",
"org_id": "test-org",
"project_id": "test-project",
"status": "error",
"type": "pipeline,service"
}
}Update the git source of an existing remote inventory.
Org is the organisation identifier.
krProject is the project identifier.
5zInventory identifier
Officia quae qui aut aut eum delectus.Account is the internal customer account ID.
syOK response.
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
PUT /api/orgs/{org}/projects/{project}/ansible/inventory/{identifier}/remote HTTP/1.1
Host: localhost:80
Harness-Account: sy
Content-Type: application/json
Accept: */*
Content-Length: 202
{
"remote_source": {
"repository": "my-repo",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "account.my_git_connector",
"repository_path": "inventories/production/hosts.yml"
}
}{
"policy_evaluation": {
"account_id": "XRQAjvT37acOiXx9PRaQMF",
"action": "onrun",
"created": 1636370209475,
"details": [
{
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"action": "onrun",
"created": 1636669297674,
"description": "Captures critical production policies",
"details": [
{
"deny_messages": [
"deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}",
"policy": {
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
},
{
"deny_messages": [
"deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}",
"policy": {
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
}
],
"enabled": true,
"identifier": "policyset-1",
"name": "Production Policies",
"org_id": "test-org",
"project_id": "test-project",
"status": "error",
"type": "pipeline",
"updated": 1636669297674
},
{
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"action": "onrun",
"created": 1636669297674,
"description": "Captures critical production policies",
"details": [
{
"deny_messages": [
"deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}",
"policy": {
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
},
{
"deny_messages": [
"deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}",
"policy": {
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
}
],
"enabled": true,
"identifier": "policyset-1",
"name": "Production Policies",
"org_id": "test-org",
"project_id": "test-project",
"status": "error",
"type": "pipeline",
"updated": 1636669297674
},
{
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"action": "onrun",
"created": 1636669297674,
"description": "Captures critical production policies",
"details": [
{
"deny_messages": [
"deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}",
"policy": {
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
},
{
"deny_messages": [
"deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}",
"policy": {
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
}
],
"enabled": true,
"identifier": "policyset-1",
"name": "Production Policies",
"org_id": "test-org",
"project_id": "test-project",
"status": "error",
"type": "pipeline",
"updated": 1636669297674
}
],
"entity": "7bbca5d4-e9f2-4955-9b2a-019ec4d3645e",
"entity_metadata": "7bbca5d4-e9f2-4955-9b2a-019ec4d3645e",
"id": 123,
"input": "",
"org_id": "test-org",
"project_id": "test-project",
"status": "error",
"type": "pipeline,service"
}
}Show an individual inventory vars.
Org is the organisation identifier.
8ceProject is the project identifier.
eo7Inventory identifier
Nemo quaerat ullam velit sunt id.Limit is the number of records to return for a page.
30Example: 30Page is the page number to return relative to the page 'limit'.
1Example: 1Account is the internal customer account ID.
jtOK response.
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/orgs/{org}/projects/{project}/ansible/inventory/{identifier}/vars HTTP/1.1
Host: localhost:80
Harness-Account: jt
Accept: */*
{
"env_vars": [
{
"created": "Suscipit et earum aut distinctio.",
"file_name": "Vel blanditiis labore consectetur.",
"key": "i",
"updated": "Dignissimos ut nobis sunt natus.",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Magnam a ut quas ea possimus omnis.",
"value_type": "Et enim est totam nihil.",
"var_type": "Rerum ut numquam incidunt facere vero."
},
{
"created": "Suscipit et earum aut distinctio.",
"file_name": "Vel blanditiis labore consectetur.",
"key": "i",
"updated": "Dignissimos ut nobis sunt natus.",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Magnam a ut quas ea possimus omnis.",
"value_type": "Et enim est totam nihil.",
"var_type": "Rerum ut numquam incidunt facere vero."
},
{
"created": "Suscipit et earum aut distinctio.",
"file_name": "Vel blanditiis labore consectetur.",
"key": "i",
"updated": "Dignissimos ut nobis sunt natus.",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Magnam a ut quas ea possimus omnis.",
"value_type": "Et enim est totam nihil.",
"var_type": "Rerum ut numquam incidunt facere vero."
}
],
"vars": [
{
"created": "Suscipit et earum aut distinctio.",
"file_name": "Vel blanditiis labore consectetur.",
"key": "i",
"updated": "Dignissimos ut nobis sunt natus.",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Magnam a ut quas ea possimus omnis.",
"value_type": "Et enim est totam nihil.",
"var_type": "Rerum ut numquam incidunt facere vero."
},
{
"created": "Suscipit et earum aut distinctio.",
"file_name": "Vel blanditiis labore consectetur.",
"key": "i",
"updated": "Dignissimos ut nobis sunt natus.",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Magnam a ut quas ea possimus omnis.",
"value_type": "Et enim est totam nihil.",
"var_type": "Rerum ut numquam incidunt facere vero."
},
{
"created": "Suscipit et earum aut distinctio.",
"file_name": "Vel blanditiis labore consectetur.",
"key": "i",
"updated": "Dignissimos ut nobis sunt natus.",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Magnam a ut quas ea possimus omnis.",
"value_type": "Et enim est totam nihil.",
"var_type": "Rerum ut numquam incidunt facere vero."
}
]
}Create new inventory variables.
Org is the organisation identifier.
ikqProject is the project identifier.
r3The unique identifier for this inventory
test_inventoryAccount is the internal customer account ID.
ejyCreated response.
No content
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
POST /api/orgs/{org}/projects/{project}/ansible/inventory/{identifier}/vars HTTP/1.1
Host: localhost:80
Harness-Account: ejy
Content-Type: application/json
Accept: */*
Content-Length: 971
{
"env_vars": [
{
"file_name": "Eaque quisquam quo culpa totam eligendi et.",
"key": "hp",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Sed autem autem.",
"value_type": "Vel dolore dolorem minima excepturi.",
"var_type": "Et vero qui quam doloribus."
},
{
"file_name": "Eaque quisquam quo culpa totam eligendi et.",
"key": "hp",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Sed autem autem.",
"value_type": "Vel dolore dolorem minima excepturi.",
"var_type": "Et vero qui quam doloribus."
}
],
"vars": [
{
"file_name": "Eaque quisquam quo culpa totam eligendi et.",
"key": "hp",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Sed autem autem.",
"value_type": "Vel dolore dolorem minima excepturi.",
"var_type": "Et vero qui quam doloribus."
},
{
"file_name": "Eaque quisquam quo culpa totam eligendi et.",
"key": "hp",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Sed autem autem.",
"value_type": "Vel dolore dolorem minima excepturi.",
"var_type": "Et vero qui quam doloribus."
}
]
}No content
Update existing inventory variables.
Org is the organisation identifier.
rProject is the project identifier.
3ftThe unique identifier for this inventory
test_inventoryAccount is the internal customer account ID.
nOK response.
No content
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
PUT /api/orgs/{org}/projects/{project}/ansible/inventory/{identifier}/vars HTTP/1.1
Host: localhost:80
Harness-Account: n
Content-Type: application/json
Accept: */*
Content-Length: 1682
{
"env_vars": [
{
"file_name": "Eaque quisquam quo culpa totam eligendi et.",
"key": "hp",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Sed autem autem.",
"value_type": "Vel dolore dolorem minima excepturi.",
"var_type": "Et vero qui quam doloribus."
},
{
"file_name": "Eaque quisquam quo culpa totam eligendi et.",
"key": "hp",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Sed autem autem.",
"value_type": "Vel dolore dolorem minima excepturi.",
"var_type": "Et vero qui quam doloribus."
},
{
"file_name": "Eaque quisquam quo culpa totam eligendi et.",
"key": "hp",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Sed autem autem.",
"value_type": "Vel dolore dolorem minima excepturi.",
"var_type": "Et vero qui quam doloribus."
},
{
"file_name": "Eaque quisquam quo culpa totam eligendi et.",
"key": "hp",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Sed autem autem.",
"value_type": "Vel dolore dolorem minima excepturi.",
"var_type": "Et vero qui quam doloribus."
}
],
"vars": [
{
"file_name": "Eaque quisquam quo culpa totam eligendi et.",
"key": "hp",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Sed autem autem.",
"value_type": "Vel dolore dolorem minima excepturi.",
"var_type": "Et vero qui quam doloribus."
},
{
"file_name": "Eaque quisquam quo culpa totam eligendi et.",
"key": "hp",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Sed autem autem.",
"value_type": "Vel dolore dolorem minima excepturi.",
"var_type": "Et vero qui quam doloribus."
},
{
"file_name": "Eaque quisquam quo culpa totam eligendi et.",
"key": "hp",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Sed autem autem.",
"value_type": "Vel dolore dolorem minima excepturi.",
"var_type": "Et vero qui quam doloribus."
}
]
}No content
Create a new inventory group.
Org is the organisation identifier.
uProject is the project identifier.
5The unique identifier for this inventory
test_inventoryAccount is the internal customer account ID.
dConnector identifier is the connector identifier to use.
my_aws_connectorConnector Type is the type of connector to use.
workspacePossible values: List of host addresses that belong to the group
["Est sed tenetur sit dignissimos.","Accusamus iure adipisci repellendus.","Inventore ullam et sunt.","Reiciendis quaerat."]The identifier of the group
test_groupName is the friendly name of the group.
My GroupCreated response.
No content
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
POST /api/orgs/{org}/projects/{project}/ansible/inventory/{inventory_identifier}/groups HTTP/1.1
Host: localhost:80
Harness-Account: d
Content-Type: application/json
Accept: */*
Content-Length: 1868
{
"configuration": {
"host_address_attribute": "<+attributes.public_dns>",
"resource_type": "aws_instance",
"selectors": [
{
"attribute": "<+attributes.region>",
"operator": "equals",
"value": "europe"
},
{
"attribute": "<+attributes.region>",
"operator": "equals",
"value": "europe"
},
{
"attribute": "<+attributes.region>",
"operator": "equals",
"value": "europe"
},
{
"attribute": "<+attributes.region>",
"operator": "equals",
"value": "europe"
}
]
},
"connector_identifier": "my_aws_connector",
"connector_type": "workspace",
"dynamic_vars": [
{
"file_name": "Enim facilis libero rerum.",
"key": "yv",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Optio ut dolorum dignissimos fuga nisi.",
"value_type": "Sit qui quam soluta consequatur."
},
{
"file_name": "Enim facilis libero rerum.",
"key": "yv",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Optio ut dolorum dignissimos fuga nisi.",
"value_type": "Sit qui quam soluta consequatur."
}
],
"hosts": [
"Et ad provident fugit nihil.",
"Praesentium dolores enim voluptatem neque optio.",
"Rerum facere.",
"Deleniti ea aut."
],
"identifier": "test_group",
"name": "My Group",
"vars": [
{
"file_name": "Enim facilis libero rerum.",
"key": "yv",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Optio ut dolorum dignissimos fuga nisi.",
"value_type": "Sit qui quam soluta consequatur."
},
{
"file_name": "Enim facilis libero rerum.",
"key": "yv",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Optio ut dolorum dignissimos fuga nisi.",
"value_type": "Sit qui quam soluta consequatur."
},
{
"file_name": "Enim facilis libero rerum.",
"key": "yv",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Optio ut dolorum dignissimos fuga nisi.",
"value_type": "Sit qui quam soluta consequatur."
},
{
"file_name": "Enim facilis libero rerum.",
"key": "yv",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Optio ut dolorum dignissimos fuga nisi.",
"value_type": "Sit qui quam soluta consequatur."
}
]
}No content
Update an existing inventory group.
Org is the organisation identifier.
tProject is the project identifier.
85The unique identifier for this inventory
test_inventoryThe identifier of the group
test_groupAccount is the internal customer account ID.
ncConnector identifier is the connector identifier to use.
my_aws_connectorConnector Type is the type of connector to use.
workspacePossible values: List of host addresses that belong to the group
["Recusandae facere nemo.","Provident earum aut.","Voluptas voluptatem commodi.","Illo dolore accusamus voluptas et."]Name is the friendly name of the group.
My GroupOK response.
No content
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
PUT /api/orgs/{org}/projects/{project}/ansible/inventory/{inventory_identifier}/groups/{identifier} HTTP/1.1
Host: localhost:80
Harness-Account: nc
Content-Type: application/json
Accept: */*
Content-Length: 2042
{
"configuration": {
"host_address_attribute": "<+attributes.public_dns>",
"resource_type": "aws_instance",
"selectors": [
{
"attribute": "<+attributes.region>",
"operator": "equals",
"value": "europe"
},
{
"attribute": "<+attributes.region>",
"operator": "equals",
"value": "europe"
},
{
"attribute": "<+attributes.region>",
"operator": "equals",
"value": "europe"
},
{
"attribute": "<+attributes.region>",
"operator": "equals",
"value": "europe"
}
]
},
"connector_identifier": "my_aws_connector",
"connector_type": "workspace",
"dynamic_vars": [
{
"file_name": "Enim facilis libero rerum.",
"key": "yv",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Optio ut dolorum dignissimos fuga nisi.",
"value_type": "Sit qui quam soluta consequatur."
},
{
"file_name": "Enim facilis libero rerum.",
"key": "yv",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Optio ut dolorum dignissimos fuga nisi.",
"value_type": "Sit qui quam soluta consequatur."
},
{
"file_name": "Enim facilis libero rerum.",
"key": "yv",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Optio ut dolorum dignissimos fuga nisi.",
"value_type": "Sit qui quam soluta consequatur."
}
],
"hosts": [
"Ut ex sit voluptatem deserunt omnis tempore.",
"Dolores ea quis nesciunt numquam.",
"Dolores sit enim omnis assumenda."
],
"name": "My Group",
"vars": [
{
"file_name": "Enim facilis libero rerum.",
"key": "yv",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Optio ut dolorum dignissimos fuga nisi.",
"value_type": "Sit qui quam soluta consequatur."
},
{
"file_name": "Enim facilis libero rerum.",
"key": "yv",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Optio ut dolorum dignissimos fuga nisi.",
"value_type": "Sit qui quam soluta consequatur."
},
{
"file_name": "Enim facilis libero rerum.",
"key": "yv",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Optio ut dolorum dignissimos fuga nisi.",
"value_type": "Sit qui quam soluta consequatur."
},
{
"file_name": "Enim facilis libero rerum.",
"key": "yv",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Optio ut dolorum dignissimos fuga nisi.",
"value_type": "Sit qui quam soluta consequatur."
}
]
}No content
Delete an existing inventory group.
Org is the organisation identifier.
lProject is the project identifier.
brzThe unique identifier for this inventory
test_inventoryThe identifier of the group
test_groupAccount is the internal customer account ID.
udOK response.
No content
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
DELETE /api/orgs/{org}/projects/{project}/ansible/inventory/{inventory_identifier}/groups/{identifier} HTTP/1.1
Host: localhost:80
Harness-Account: ud
Accept: */*
No content
Update an existing inventory host.
Org is the organisation identifier.
2koProject is the project identifier.
zThe unique identifier for this inventory
test_inventoryHost address is the address of the host.
host1.example.comAccount is the internal customer account ID.
acnGroups is the list of groups the host belongs to.
["Eum velit vel ipsam et fugit.","Eius eos facere ut et eaque.","Est dolor modi dolores velit qui fugit."]OK response.
No content
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
PUT /api/orgs/{org}/projects/{project}/ansible/inventory/{inventory_identifier}/hosts/{host_address} HTTP/1.1
Host: localhost:80
Harness-Account: acn
Content-Type: application/json
Accept: */*
Content-Length: 945
{
"groups": [
"Distinctio similique vitae aut.",
"Debitis non aspernatur aut perspiciatis quibusdam.",
"Nihil perferendis aut vel distinctio sunt."
],
"vars": [
{
"file_name": "Enim facilis libero rerum.",
"key": "yv",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Optio ut dolorum dignissimos fuga nisi.",
"value_type": "Sit qui quam soluta consequatur."
},
{
"file_name": "Enim facilis libero rerum.",
"key": "yv",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Optio ut dolorum dignissimos fuga nisi.",
"value_type": "Sit qui quam soluta consequatur."
},
{
"file_name": "Enim facilis libero rerum.",
"key": "yv",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Optio ut dolorum dignissimos fuga nisi.",
"value_type": "Sit qui quam soluta consequatur."
},
{
"file_name": "Enim facilis libero rerum.",
"key": "yv",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Optio ut dolorum dignissimos fuga nisi.",
"value_type": "Sit qui quam soluta consequatur."
}
]
}No content
Delete a inventory host.
Org is the organisation identifier.
8kaProject is the project identifier.
18The unique identifier for this inventory
test_inventoryHost address is the address of the host.
host1.example.comAccount is the internal customer account ID.
74OK response.
No content
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
DELETE /api/orgs/{org}/projects/{project}/ansible/inventory/{inventory_identifier}/hosts/{host_address} HTTP/1.1
Host: localhost:80
Harness-Account: 74
Accept: */*
No content
Create a new static (manual) Ansible inventory by parsing YAML or INI content.
Org is the organisation identifier.
t7Project is the project identifier.
0n6Account is the internal customer account ID.
uokRaw inventory content as a string (paste or client-read file).
ogbSource format of the content.
iniPossible values: The identifier of the new inventory.
oDisplay name of the new inventory.
yOptional tags to apply to the new inventory.
["Enim enim.","Fugiat voluptas ad sint excepturi maiores et.","Est eveniet est qui ut dicta."]Created response.
Warnings surfaced during import (lossy conversions, flattened groups, etc.).
["Hic quia excepturi aspernatur et.","Sed explicabo."]BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
POST /api/orgs/{org}/projects/{project}/ansible/inventory/import HTTP/1.1
Host: localhost:80
Harness-Account: uok
Content-Type: application/json
Accept: */*
Content-Length: 180
{
"content": "93c",
"format": "ini",
"identifier": "0y",
"name": "i",
"tags": [
"Eos deserunt reprehenderit neque.",
"Doloribus numquam qui sit.",
"Facere odit beatae ullam delectus tenetur."
]
}{
"inventory": {
"account": "zd",
"created": 1627590400,
"description": "Production infrastructure inventory",
"identifier": "test_inventory",
"name": "test inventory",
"org": "2w0",
"project": "u",
"tags": [
"Molestias autem cum sint.",
"Eum omnis."
],
"type": "remote",
"updated": 1627686800
},
"warnings": [
"Nisi ea eius sunt facilis similique.",
"Adipisci omnis labore voluptatem autem et.",
"Sapiente distinctio nostrum nostrum vero."
]
}List all playbooks.
Org is the organisation identifier.
2jiProject is the project identifier.
xtLimit is the number of records to return for a page.
30Example: 30Page is the page number to return relative to the page 'limit'.
1Example: 1Filter results by partial name match
""Example: mystaSort order for results
name,ASCExample: updated,ASCPossible values: Filter results by tags (OR logic, exact match)
["A ratione dolorum.","Voluptatem sit rerum quis.","Repellendus vero et."]Account is the internal customer account ID.
lOK response.
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/orgs/{org}/projects/{project}/ansible/playbook HTTP/1.1
Host: localhost:80
Harness-Account: l
Accept: */*
[
{
"account": "r",
"ansible_galaxy": true,
"ansible_galaxy_requirements_file": "requirements.yml",
"created": 1627590400,
"description": "Playbook for deploying web services to production",
"env_vars": "Rem reprehenderit qui dolore quo qui similique.",
"identifier": "Aspernatur repudiandae voluptate.",
"name": "test playbook",
"org": "7af",
"project": "yt",
"repository": "my-repo",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "my-connector",
"repository_path": "playbooks/",
"tags": [
"Sit dolores.",
"Voluptas facilis in est sunt veniam repudiandae.",
"Quas praesentium magni.",
"Rerum cumque sunt."
],
"updated": 1627686800,
"vars": "Et iste maiores consectetur doloribus autem laboriosam."
},
{
"account": "r",
"ansible_galaxy": true,
"ansible_galaxy_requirements_file": "requirements.yml",
"created": 1627590400,
"description": "Playbook for deploying web services to production",
"env_vars": "Rem reprehenderit qui dolore quo qui similique.",
"identifier": "Aspernatur repudiandae voluptate.",
"name": "test playbook",
"org": "7af",
"project": "yt",
"repository": "my-repo",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "my-connector",
"repository_path": "playbooks/",
"tags": [
"Sit dolores.",
"Voluptas facilis in est sunt veniam repudiandae.",
"Quas praesentium magni.",
"Rerum cumque sunt."
],
"updated": 1627686800,
"vars": "Et iste maiores consectetur doloribus autem laboriosam."
}
]Create a new playbook.
Org is the organisation identifier.
tfqProject is the project identifier.
qfwAccount is the internal customer account ID.
7Install Ansible Galaxy dependencies
falseExample: falsePath to Ansible Galaxy requirements file
requirements.ymlDescription documents the playbook purpose and usage
Playbook for deploying web services to productionThe unique identifier for this playbook
Deserunt exercitationem dolor labore ut.Name is the human readable name
test playbookRepository is the name of the repository to use.
my-repoRepository Branch in which the playbook should be accessed.
mainRepository Commit/Tag in which the playbook should be accessed.
abc10edRepository Connector is the reference to the connector to use for this playbook.
my-connectorRepository Path is the path in which the playbook resides.
""Example: playbooks/Tags associated with the playbook
["Voluptas mollitia maiores facere.","Molestias et optio deleniti amet delectus sit.","Nulla repellendus nemo aut."]Created response.
Account is the internal customer account ID.
5wInstall Ansible Galaxy dependencies
falseExample: falsePath to Ansible Galaxy requirements file
requirements.ymlTimestamp when the resource was created.
1627590400Description documents the playbook purpose and usage
Playbook for deploying web services to productionThe environment vars in the playbook
Non sed.The unique identifier for this playbook
Eaque minima.Name is the human readable name
test playbookOrg is the organisation identifier.
rProject is the project identifier.
5bRepository is the name of the repository to use.
my-repoRepository Branch in which the playbook should be accessed.
mainRepository Commit/Tag in which the playbook should be accessed.
abc10edRepository Connector is the reference to the connector to use for this playbook.
my-connectorRepository Path is the path in which the playbook resides.
""Example: playbooks/Tags associated with the playbook
["Praesentium deserunt quia quos a non.","Architecto et et in voluptatum numquam animi.","Accusantium commodi cum quia.","Delectus illum rem est vel soluta."]Timestamp when the resource was last updated.
1627686800The vars in the playbook
Iure eligendi quaerat blanditiis quaerat harum.BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
POST /api/orgs/{org}/projects/{project}/ansible/playbook HTTP/1.1
Host: localhost:80
Harness-Account: 7
Content-Type: application/json
Accept: */*
Content-Length: 1612
{
"ansible_galaxy": false,
"ansible_galaxy_requirements_file": "requirements.yml",
"description": "Playbook for deploying web services to production",
"env_vars": {
"Beatae qui quam ipsam incidunt qui.": {
"file_name": "Enim facilis libero rerum.",
"key": "yv",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Optio ut dolorum dignissimos fuga nisi.",
"value_type": "Sit qui quam soluta consequatur."
},
"Doloribus quidem quibusdam perspiciatis.": {
"file_name": "Enim facilis libero rerum.",
"key": "yv",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Optio ut dolorum dignissimos fuga nisi.",
"value_type": "Sit qui quam soluta consequatur."
}
},
"identifier": "Vitae commodi nisi maxime.",
"name": "test playbook",
"repository": "my-repo",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "my-connector",
"repository_path": "playbooks/",
"tags": [
"Totam debitis facere voluptas iusto.",
"Non deserunt."
],
"vars": {
"Fugit vitae adipisci.": {
"file_name": "Enim facilis libero rerum.",
"key": "yv",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Optio ut dolorum dignissimos fuga nisi.",
"value_type": "Sit qui quam soluta consequatur."
},
"Quo distinctio consectetur unde.": {
"file_name": "Enim facilis libero rerum.",
"key": "yv",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Optio ut dolorum dignissimos fuga nisi.",
"value_type": "Sit qui quam soluta consequatur."
},
"Tempora sint sit perferendis optio.": {
"file_name": "Enim facilis libero rerum.",
"key": "yv",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Optio ut dolorum dignissimos fuga nisi.",
"value_type": "Sit qui quam soluta consequatur."
}
}
}{
"account": "1",
"ansible_galaxy": false,
"ansible_galaxy_requirements_file": "requirements.yml",
"created": 1627590400,
"description": "Playbook for deploying web services to production",
"env_vars": "Sed earum voluptas non cum.",
"identifier": "Ut est aliquid illum harum.",
"name": "test playbook",
"org": "7hd",
"policy_evaluation": {
"account_id": "XRQAjvT37acOiXx9PRaQMF",
"action": "onrun",
"created": 1636370209475,
"details": [
{
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"action": "onrun",
"created": 1636669297674,
"description": "Captures critical production policies",
"details": [
{
"deny_messages": [
"deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}",
"policy": {
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
},
{
"deny_messages": [
"deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}",
"policy": {
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
}
],
"enabled": true,
"identifier": "policyset-1",
"name": "Production Policies",
"org_id": "test-org",
"project_id": "test-project",
"status": "error",
"type": "pipeline",
"updated": 1636669297674
},
{
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"action": "onrun",
"created": 1636669297674,
"description": "Captures critical production policies",
"details": [
{
"deny_messages": [
"deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}",
"policy": {
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
},
{
"deny_messages": [
"deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}",
"policy": {
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
}
],
"enabled": true,
"identifier": "policyset-1",
"name": "Production Policies",
"org_id": "test-org",
"project_id": "test-project",
"status": "error",
"type": "pipeline",
"updated": 1636669297674
},
{
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"action": "onrun",
"created": 1636669297674,
"description": "Captures critical production policies",
"details": [
{
"deny_messages": [
"deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}",
"policy": {
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
},
{
"deny_messages": [
"deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}",
"policy": {
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
}
],
"enabled": true,
"identifier": "policyset-1",
"name": "Production Policies",
"org_id": "test-org",
"project_id": "test-project",
"status": "error",
"type": "pipeline",
"updated": 1636669297674
}
],
"entity": "7bbca5d4-e9f2-4955-9b2a-019ec4d3645e",
"entity_metadata": "7bbca5d4-e9f2-4955-9b2a-019ec4d3645e",
"id": 123,
"input": "",
"org_id": "test-org",
"project_id": "test-project",
"status": "error",
"type": "pipeline,service"
},
"project": "kr",
"repository": "my-repo",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "my-connector",
"repository_path": "playbooks/",
"tags": [
"Perferendis quisquam quasi.",
"Modi quis doloremque ex."
],
"updated": 1627686800,
"vars": "Esse quod consequatur eos voluptate beatae."
}Show an individual playbook.
Org is the organisation identifier.
mProject is the project identifier.
oThe unique identifier for this playbook
In cum.Account is the internal customer account ID.
7slOK response.
Account is the internal customer account ID.
rcInstall Ansible Galaxy dependencies
falseExample: falsePath to Ansible Galaxy requirements file
requirements.ymlTimestamp when the resource was created.
1627590400Description documents the playbook purpose and usage
Playbook for deploying web services to productionThe environment vars in the playbook
Aliquid tempora qui at in.The unique identifier for this playbook
Iusto maxime deleniti officia.Name is the human readable name
test playbookOrg is the organisation identifier.
4qxProject is the project identifier.
1Repository is the name of the repository to use.
my-repoRepository Branch in which the playbook should be accessed.
mainRepository Commit/Tag in which the playbook should be accessed.
abc10edRepository Connector is the reference to the connector to use for this playbook.
my-connectorRepository Path is the path in which the playbook resides.
""Example: playbooks/Tags associated with the playbook
["Enim aliquid aspernatur assumenda quisquam.","Id voluptas qui.","Necessitatibus quo ipsam eius deleniti."]Timestamp when the resource was last updated.
1627686800The vars in the playbook
Quidem aut exercitationem rerum asperiores neque.BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/orgs/{org}/projects/{project}/ansible/playbook/{identifier} HTTP/1.1
Host: localhost:80
Harness-Account: 7sl
Accept: */*
{
"account": "9",
"ansible_galaxy": true,
"ansible_galaxy_requirements_file": "requirements.yml",
"created": 1627590400,
"description": "Playbook for deploying web services to production",
"env_vars": "Ut aperiam veniam in quis sit.",
"identifier": "Non aut.",
"name": "test playbook",
"org": "47l",
"project": "8k",
"repository": "my-repo",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "my-connector",
"repository_path": "playbooks/",
"tags": [
"Mollitia est facere inventore officiis dicta labore.",
"Ducimus voluptas ipsum illum error."
],
"updated": 1627686800,
"vars": "Possimus sed quo cumque."
}Update an existing playbook.
Org is the organisation identifier.
oxProject is the project identifier.
5bThe unique identifier for this playbook
Aut voluptas fugiat consequuntur qui rerum.Account is the internal customer account ID.
y3Install Ansible Galaxy dependencies
falseExample: falsePath to Ansible Galaxy requirements file
requirements.ymlDescription documents the playbook purpose and usage
Playbook for deploying web services to productionName is the human readable name
test playbookRepository is the name of the repository to use.
my-repoRepository Branch in which the playbook should be accessed.
mainRepository Commit/Tag in which the playbook should be accessed.
abc10edRepository Connector is the reference to the connector to use for this playbook.
my-connectorRepository Path is the path in which the playbook resides.
""Example: playbooks/Tags associated with the playbook
["Voluptatum et aut.","Dolores sunt doloribus.","Suscipit explicabo at voluptatem est expedita mollitia."]OK response.
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
PUT /api/orgs/{org}/projects/{project}/ansible/playbook/{identifier} HTTP/1.1
Host: localhost:80
Harness-Account: y3
Content-Type: application/json
Accept: */*
Content-Length: 1398
{
"ansible_galaxy": true,
"ansible_galaxy_requirements_file": "requirements.yml",
"description": "Playbook for deploying web services to production",
"env_vars": {
"Optio assumenda exercitationem.": {
"file_name": "Enim facilis libero rerum.",
"key": "yv",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Optio ut dolorum dignissimos fuga nisi.",
"value_type": "Sit qui quam soluta consequatur."
},
"Sint assumenda eos et sed possimus enim.": {
"file_name": "Enim facilis libero rerum.",
"key": "yv",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Optio ut dolorum dignissimos fuga nisi.",
"value_type": "Sit qui quam soluta consequatur."
}
},
"name": "test playbook",
"repository": "my-repo",
"repository_branch": "main",
"repository_commit": "abc10ed",
"repository_connector": "my-connector",
"repository_path": "playbooks/",
"tags": [
"Eligendi non accusantium doloribus omnis quasi officiis.",
"Ducimus sit ipsa."
],
"vars": {
"Quasi possimus tempora incidunt velit.": {
"file_name": "Enim facilis libero rerum.",
"key": "yv",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Optio ut dolorum dignissimos fuga nisi.",
"value_type": "Sit qui quam soluta consequatur."
},
"Quisquam fugit voluptas consequuntur temporibus laborum sit.": {
"file_name": "Enim facilis libero rerum.",
"key": "yv",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Optio ut dolorum dignissimos fuga nisi.",
"value_type": "Sit qui quam soluta consequatur."
}
}
}{
"policy_evaluation": {
"account_id": "XRQAjvT37acOiXx9PRaQMF",
"action": "onrun",
"created": 1636370209475,
"details": [
{
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"action": "onrun",
"created": 1636669297674,
"description": "Captures critical production policies",
"details": [
{
"deny_messages": [
"deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}",
"policy": {
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
},
{
"deny_messages": [
"deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}",
"policy": {
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
}
],
"enabled": true,
"identifier": "policyset-1",
"name": "Production Policies",
"org_id": "test-org",
"project_id": "test-project",
"status": "error",
"type": "pipeline",
"updated": 1636669297674
},
{
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"action": "onrun",
"created": 1636669297674,
"description": "Captures critical production policies",
"details": [
{
"deny_messages": [
"deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}",
"policy": {
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
},
{
"deny_messages": [
"deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}",
"policy": {
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
}
],
"enabled": true,
"identifier": "policyset-1",
"name": "Production Policies",
"org_id": "test-org",
"project_id": "test-project",
"status": "error",
"type": "pipeline",
"updated": 1636669297674
},
{
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"action": "onrun",
"created": 1636669297674,
"description": "Captures critical production policies",
"details": [
{
"deny_messages": [
"deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}",
"policy": {
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
},
{
"deny_messages": [
"deployment stage 'example-stage' does not have a HarnessApproval step",
"deployment stage 'example-stage' has step 'run-script' that is forbidden type 'ShellScript'"
],
"output": "{\n \"deny\": [\n \"deployment stage 'deploy' does not have a HarnessApproval step\"\n ],\n \"stages_with_approval\": []\n}",
"policy": {
"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"updated": 1636669297674
},
"rego_error": "policy.rego:25: rego_parse_error: non-terminated string m == \"test",
"status": "error"
}
],
"enabled": true,
"identifier": "policyset-1",
"name": "Production Policies",
"org_id": "test-org",
"project_id": "test-project",
"status": "error",
"type": "pipeline",
"updated": 1636669297674
}
],
"entity": "7bbca5d4-e9f2-4955-9b2a-019ec4d3645e",
"entity_metadata": "7bbca5d4-e9f2-4955-9b2a-019ec4d3645e",
"id": 123,
"input": "",
"org_id": "test-org",
"project_id": "test-project",
"status": "error",
"type": "pipeline,service"
}
}Delete an existing playbook.
Org is the organisation identifier.
nProject is the project identifier.
vThe unique identifier for this playbook
A rerum recusandae nam molestiae et corrupti.Account is the internal customer account ID.
0yOK response.
No content
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
DELETE /api/orgs/{org}/projects/{project}/ansible/playbook/{identifier} HTTP/1.1
Host: localhost:80
Harness-Account: 0y
Accept: */*
No content
Show an individual playbook vars.
Org is the organisation identifier.
qProject is the project identifier.
upPlaybook identifier
Non vitae similique quo pariatur dolorem architecto.Limit is the number of records to return for a page.
30Example: 30Page is the page number to return relative to the page 'limit'.
1Example: 1Account is the internal customer account ID.
oOK response.
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
GET /api/orgs/{org}/projects/{project}/ansible/playbook/{identifier}/vars HTTP/1.1
Host: localhost:80
Harness-Account: o
Accept: */*
{
"env_vars": [
{
"created": "Suscipit et earum aut distinctio.",
"file_name": "Vel blanditiis labore consectetur.",
"key": "i",
"updated": "Dignissimos ut nobis sunt natus.",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Magnam a ut quas ea possimus omnis.",
"value_type": "Et enim est totam nihil.",
"var_type": "Rerum ut numquam incidunt facere vero."
},
{
"created": "Suscipit et earum aut distinctio.",
"file_name": "Vel blanditiis labore consectetur.",
"key": "i",
"updated": "Dignissimos ut nobis sunt natus.",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Magnam a ut quas ea possimus omnis.",
"value_type": "Et enim est totam nihil.",
"var_type": "Rerum ut numquam incidunt facere vero."
},
{
"created": "Suscipit et earum aut distinctio.",
"file_name": "Vel blanditiis labore consectetur.",
"key": "i",
"updated": "Dignissimos ut nobis sunt natus.",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Magnam a ut quas ea possimus omnis.",
"value_type": "Et enim est totam nihil.",
"var_type": "Rerum ut numquam incidunt facere vero."
}
],
"vars": [
{
"created": "Suscipit et earum aut distinctio.",
"file_name": "Vel blanditiis labore consectetur.",
"key": "i",
"updated": "Dignissimos ut nobis sunt natus.",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Magnam a ut quas ea possimus omnis.",
"value_type": "Et enim est totam nihil.",
"var_type": "Rerum ut numquam incidunt facere vero."
},
{
"created": "Suscipit et earum aut distinctio.",
"file_name": "Vel blanditiis labore consectetur.",
"key": "i",
"updated": "Dignissimos ut nobis sunt natus.",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Magnam a ut quas ea possimus omnis.",
"value_type": "Et enim est totam nihil.",
"var_type": "Rerum ut numquam incidunt facere vero."
},
{
"created": "Suscipit et earum aut distinctio.",
"file_name": "Vel blanditiis labore consectetur.",
"key": "i",
"updated": "Dignissimos ut nobis sunt natus.",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Magnam a ut quas ea possimus omnis.",
"value_type": "Et enim est totam nihil.",
"var_type": "Rerum ut numquam incidunt facere vero."
}
]
}Create a new dynamic playbook variable.
Org is the organisation identifier.
cpProject is the project identifier.
nqThe unique identifier for this inventory
test_inventoryAccount is the internal customer account ID.
ryCreated response.
No content
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
POST /api/orgs/{org}/projects/{project}/ansible/playbook/{identifier}/vars HTTP/1.1
Host: localhost:80
Harness-Account: ry
Content-Type: application/json
Accept: */*
Content-Length: 1682
{
"env_vars": [
{
"file_name": "Eaque quisquam quo culpa totam eligendi et.",
"key": "hp",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Sed autem autem.",
"value_type": "Vel dolore dolorem minima excepturi.",
"var_type": "Et vero qui quam doloribus."
},
{
"file_name": "Eaque quisquam quo culpa totam eligendi et.",
"key": "hp",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Sed autem autem.",
"value_type": "Vel dolore dolorem minima excepturi.",
"var_type": "Et vero qui quam doloribus."
},
{
"file_name": "Eaque quisquam quo culpa totam eligendi et.",
"key": "hp",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Sed autem autem.",
"value_type": "Vel dolore dolorem minima excepturi.",
"var_type": "Et vero qui quam doloribus."
},
{
"file_name": "Eaque quisquam quo culpa totam eligendi et.",
"key": "hp",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Sed autem autem.",
"value_type": "Vel dolore dolorem minima excepturi.",
"var_type": "Et vero qui quam doloribus."
}
],
"vars": [
{
"file_name": "Eaque quisquam quo culpa totam eligendi et.",
"key": "hp",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Sed autem autem.",
"value_type": "Vel dolore dolorem minima excepturi.",
"var_type": "Et vero qui quam doloribus."
},
{
"file_name": "Eaque quisquam quo culpa totam eligendi et.",
"key": "hp",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Sed autem autem.",
"value_type": "Vel dolore dolorem minima excepturi.",
"var_type": "Et vero qui quam doloribus."
},
{
"file_name": "Eaque quisquam quo culpa totam eligendi et.",
"key": "hp",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Sed autem autem.",
"value_type": "Vel dolore dolorem minima excepturi.",
"var_type": "Et vero qui quam doloribus."
}
]
}No content
Update an existing dynamic playbook variable.
Org is the organisation identifier.
sProject is the project identifier.
x6The unique identifier for this inventory
test_inventoryAccount is the internal customer account ID.
hyOK response.
No content
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
PUT /api/orgs/{org}/projects/{project}/ansible/playbook/{identifier}/vars HTTP/1.1
Host: localhost:80
Harness-Account: hy
Content-Type: application/json
Accept: */*
Content-Length: 1208
{
"env_vars": [
{
"file_name": "Eaque quisquam quo culpa totam eligendi et.",
"key": "hp",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Sed autem autem.",
"value_type": "Vel dolore dolorem minima excepturi.",
"var_type": "Et vero qui quam doloribus."
},
{
"file_name": "Eaque quisquam quo culpa totam eligendi et.",
"key": "hp",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Sed autem autem.",
"value_type": "Vel dolore dolorem minima excepturi.",
"var_type": "Et vero qui quam doloribus."
}
],
"vars": [
{
"file_name": "Eaque quisquam quo culpa totam eligendi et.",
"key": "hp",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Sed autem autem.",
"value_type": "Vel dolore dolorem minima excepturi.",
"var_type": "Et vero qui quam doloribus."
},
{
"file_name": "Eaque quisquam quo culpa totam eligendi et.",
"key": "hp",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Sed autem autem.",
"value_type": "Vel dolore dolorem minima excepturi.",
"var_type": "Et vero qui quam doloribus."
},
{
"file_name": "Eaque quisquam quo culpa totam eligendi et.",
"key": "hp",
"uuid": "123e4567-e89b-12d3-a456-426655440000",
"value": "Sed autem autem.",
"value_type": "Vel dolore dolorem minima excepturi.",
"var_type": "Et vero qui quam doloribus."
}
]
}No content
Delete a dynamic playbook variable.
Org is the organisation identifier.
iProject is the project identifier.
1hzThe unique identifier for this inventory
test_inventoryAccount is the internal customer account ID.
s2i["Quam neque ipsum est ut.","Nostrum officiis autem."]OK response.
No content
BadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
DELETE /api/orgs/{org}/projects/{project}/ansible/playbook/{identifier}/vars HTTP/1.1
Host: localhost:80
Harness-Account: s2i
Content-Type: application/json
Accept: */*
Content-Length: 126
{
"vars": [
"Qui velit.",
"Et et in nulla aut corporis.",
"Assumenda dolor cupiditate.",
"Aut quidem beatae sint mollitia et est."
]
}No content
Store ansible run results and create an activity record in a single call.
Org is the organisation identifier.
nfgProject is the project identifier.
z6The unique identifier for the associated pipeline
Officia iure labore sapiente.The unique identifier for a stage
Fugit sequi ut sed quis illo ducimus.The unique identifier for the associated pipeline execution
Eum nostrum quibusdam ex nihil culpa ullam.The unique identifier for the associated pipeline execution stage
Aspernatur voluptas veniam rem dolores velit quis.Type of data stored
task_resultsPossible values: Inventories associated with this event
Optio illum.Playbooks associated with this event
Accusantium omnis consequatur temporibus necessitatibus repudiandae et.The type of event that occurred.
activity-executionPossible values: JSON-encoded activity metadata (activity_status, git_branch, git_repo, etc.).
Totam incidunt.Account is the internal customer account ID.
6sSize in bytes of the data.
4603568117895322000OK response.
The unique identifier for the data
dc538c61-de48-4220-958c-5f3c4f983daaBadRequestError: Bad Request response.
UnauthorizedError: Unauthorized response.
ForbiddenError: Forbidden response.
NotFoundError: Not Found response.
TimeoutError: Request Timeout response.
ConflictError: Conflict response.
LockedError: Locked response.
ContextCancelledError: response.
InternalServerError: Internal Server Error response.
BadGatewayError: Bad Gateway response.
POST /api/orgs/{org}/projects/{project}/ansible/results?data_type=task_results&inventories=Optio+illum.&playbooks=Accusantium+omnis+consequatur+temporibus+necessitatibus+repudiandae+et.&event_type=activity-execution HTTP/1.1
Host: localhost:80
Harness-Account: 6s
Accept: */*
{
"id": "dc538c61-de48-4220-958c-5f3c4f983daa"
}Last updated
Was this helpful?