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 organization

Params

Param name Description
operatingsystem_id
optional

ID of operating system

Validations:

  • String

location_id
optional

Scope by locations

Validations:

  • Integer

organization_id
optional

Scope by organizations

Validations:

  • Integer

search
optional

filter results

Validations:

  • String

order
optional

sort results

Validations:

  • String

page
optional

paginate results

Validations:

  • String

per_page
optional

number of entries per request

Validations:

  • String

Search fields

Field name Type Possible values
default true, false
family string
layout text
location string
location_id integer
locked true, false
name string
organization string
organization_id integer
snippet true, false
template text
vendor string

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

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Integer

organization_id
optional

Scope by organizations

Validations:

  • Integer

id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..


POST /api/ptables
Create a partition table

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Integer

organization_id
optional

Scope by organizations

Validations:

  • Integer

ptable
required

Validations:

  • Hash

ptable[name]
required

Validations:

  • String

ptable[layout]
required

Validations:

  • String

ptable[snippet]
optional , nil allowed

Validations:

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

ptable[audit_comment]
optional , nil allowed

Validations:

  • 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:

  • 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 organizations with given ids.

Validations:

  • Must be an array of any type


POST /api/ptables/import
Import a provisioning template

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Integer

organization_id
optional

Scope by organizations

Validations:

  • Integer

ptable
required

Validations:

  • Hash

ptable[name]
optional

template name

Validations:

  • String

ptable[template]
optional

template contents including metadata

Validations:

  • String

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 organizations with given ids.

Validations:

  • Must be an array of any type

options
optional

Validations:

  • Hash

options[force]
optional , nil allowed

use if you want update locked templates

Validations:

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

options[associate]
optional , nil allowed

determines when the template should associate objects based on metadata, new means only when new template is being created, always means both for new and existing template which is only being updated, never ignores metadata

Validations:

  • Must be one of: new, always, never.

options[lock]
optional , nil allowed

lock imported templates (false by default)

Validations:

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


GET /api/ptables/revision

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Integer

organization_id
optional

Scope by organizations

Validations:

  • Integer

version
optional

template version

Validations:

  • String


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

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Integer

organization_id
optional

Scope by organizations

Validations:

  • Integer

id
required

Validations:

  • String

ptable
required

Validations:

  • Hash

ptable[name]
optional

Validations:

  • String

ptable[layout]
optional

Validations:

  • String

ptable[snippet]
optional , nil allowed

Validations:

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

ptable[audit_comment]
optional , nil allowed

Validations:

  • 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:

  • 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 organizations with given ids.

Validations:

  • Must be an array of any type


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

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Integer

organization_id
optional

Scope by organizations

Validations:

  • Integer

id
required

Validations:

  • String


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

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Integer

organization_id
optional

Scope by organizations

Validations:

  • Integer

id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..

ptable
required

Validations:

  • Hash

ptable[name]
required

template name

Validations:

  • String


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

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Integer

organization_id
optional

Scope by organizations

Validations:

  • Integer

id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..