Ansible playbooks

>>>

GET /acd/api/ansible_playbooks/:id
Show ansible playbook

Params

Param name Description
id
required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
>>>

GET /acd/api/ansible_playbooks
List ansible playbooks

Params

Param name Description
search
optional

filter results

Validations:

  • Must be a String
order
optional

Sort and order by a searchable field, e.g. 'id DESC'

Validations:

  • Must be a String
page
optional

Page number, starting at 1

Validations:

  • Must be a number.
per_page
optional

Number of results per page to return, 'all' to return all results

Validations:

  • Must match regular expression /\A([1-9]\d*|all)\Z$/.

Search fields

Field name Type Possible values
location
location_id
name
organization
organization_id
>>>

POST /acd/api/ansible_playbooks
Create a ansible playbook

Params

Param name Description
ansible_playbook
required

Validations:

  • Must be a Hash
ansible_playbook[name]
required

Validations:

  • Must be a String
ansible_playbook[location_ids]
optional , nil allowed

REPLACE locations with given ids

Validations:

  • Must be an array of any type
ansible_playbook[organization_ids]
optional , nil allowed

REPLACE organizations with given ids.

Validations:

  • Must be an array of any type
ansible_playbook[description]
required

Validations:

  • Must be a String
ansible_playbook[services]
required

Validations:

  • Must be a String
>>>

DELETE /acd/api/ansible_playbooks/:id
Deletes ansible playbook

Params

Param name Description
id
required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
>>>

GET /acd/api/ansible_playbooks/:id/grab
Grab ansible playbook

Params

Param name Description
id
required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.