List Ansible playbooks on account level

List all playbooks at account scope. Org and project scoped playbooks are not included.

get

Query parameters

limitinteger · int64 · min: 1 · max: 1000Optional

Limit is the number of records to return for a page.

Default: 30Example: 30

pageinteger · int64 · min: 1Optional

Page is the page number to return relative to the page 'limit'.

Default: 1Example: 1

searchTermstringOptional

Filter results by partial name match

Default: ""Example: mysta

sortstring · enumOptional

Sort order for results

Default: name,ASCExample: updated,DESCPossible values:

tagsstring[]Optional

Filter results by tags (OR logic, exact match)

Example: ["Eius vitae.","Molestiae tenetur consequuntur.","Ut et nihil soluta doloribus enim.","Iure asperiores."]

Header parameters

Harness-Accountstring · min: 1 · max: 128Required

Account is the internal customer account ID.

Example: 0rx

Responses

200

OK response.

application/json

400

BadRequestError: Bad Request response.

application/vnd.goa.error

401

UnauthorizedError: Unauthorized response.

application/vnd.goa.error

403

ForbiddenError: Forbidden response.

application/vnd.goa.error

404

NotFoundError: Not Found response.

application/vnd.goa.error

408

TimeoutError: Request Timeout response.

application/vnd.goa.error

409

ConflictError: Conflict response.

application/vnd.goa.error

423

LockedError: Locked response.

application/vnd.goa.error

499

ContextCancelledError: response.

application/vnd.goa.error

500

InternalServerError: Internal Server Error response.

application/vnd.goa.error

502

BadGatewayError: Bad Gateway response.

application/vnd.goa.error

get/api/ansible/playbook

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."
  }
]