GET /api/ptables
List all partition tables

GET /api/operatingsystems/:operatingsystem_id/ptables
List all partition tables for an operating system

GET /api/locations/:location_id/ptables
List all partition tables per location

GET /api/organizations/:organization_id/ptables
List all partition tables per organisation

Params

Param name Description
operatingsystem_id
optional

ID of operating system

Validations:

  • Must be a String

location_id
optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
optional

Scope by organisations

Validations:

  • Must be a Integer

search
optional

filter results

Validations:

  • Must be a String

order
optional

sort results

Validations:

  • Must be a String

page
optional

paginate results

Validations:

  • Must be a String

per_page
optional

number of entries per request

Validations:

  • Must be a String


GET /api/ptables/:id
Show a partition table

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.


POST /api/ptables
Create a partition table

Params

Param name Description
ptable
required

Validations:

  • Must be a Hash

ptable[name]
required

Validations:

  • Must be a String

ptable[layout]
required

Validations:

  • Must be a String

ptable[snippet]
optional , nil allowed

Validations:

  • Must be one of: true, false, 1, 0

ptable[audit_comment]
optional , nil allowed

Validations:

  • Must be a String

ptable[locked]
optional , nil allowed

Whether or not the template is locked for editing

Validations:

  • Must be one of: true, false, 1, 0

ptable[os_family]
optional , nil allowed

Validations:

  • Must be a String

ptable[operatingsystem_ids]
optional , nil allowed

Array of operating system IDs to associate with the partition table

Validations:

  • Must be an array of any type

ptable[host_ids]
optional , nil allowed

Array of host IDs to associate with the partition table

Validations:

  • Must be an array of any type

ptable[hostgroup_ids]
optional , nil allowed

Array of host group IDs to associate with the partition table

Validations:

  • Must be an array of any type

ptable[location_ids]
optional , nil allowed

REPLACE locations with given ids

Validations:

  • Must be an array of any type

ptable[organization_ids]
optional , nil allowed

REPLACE organisations with given ids.

Validations:

  • Must be an array of any type


GET /api/ptables/revision

Params

Param name Description
version
optional

template version

Validations:

  • Must be a String


PUT /api/ptables/:id
Update a partition table

Params

Param name Description
id
required

Validations:

  • Must be a String

ptable
required

Validations:

  • Must be a Hash

ptable[name]
optional

Validations:

  • Must be a String

ptable[layout]
optional

Validations:

  • Must be a String

ptable[snippet]
optional , nil allowed

Validations:

  • Must be one of: true, false, 1, 0

ptable[audit_comment]
optional , nil allowed

Validations:

  • Must be a String

ptable[locked]
optional , nil allowed

Whether or not the template is locked for editing

Validations:

  • Must be one of: true, false, 1, 0

ptable[os_family]
optional , nil allowed

Validations:

  • Must be a String

ptable[operatingsystem_ids]
optional , nil allowed

Array of operating system IDs to associate with the partition table

Validations:

  • Must be an array of any type

ptable[host_ids]
optional , nil allowed

Array of host IDs to associate with the partition table

Validations:

  • Must be an array of any type

ptable[hostgroup_ids]
optional , nil allowed

Array of host group IDs to associate with the partition table

Validations:

  • Must be an array of any type

ptable[location_ids]
optional , nil allowed

REPLACE locations with given ids

Validations:

  • Must be an array of any type

ptable[organization_ids]
optional , nil allowed

REPLACE organisations with given ids.

Validations:

  • Must be an array of any type


DELETE /api/ptables/:id
Delete a partition table

Params

Param name Description
id
required

Validations:

  • Must be a String


POST /api/ptables/:id/clone
Clone a template

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.

ptable
required

Validations:

  • Must be a Hash

ptable[name]
required

template name

Validations:

  • Must be a String


GET /api/ptables/:id/export
Export a partition template to ERB

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.