GET /api/ptables 200 { "total": 2, "subtotal": 1, "page": 1, "per_page": 20, "search": "ptable429", "sort": { "by": null, "order": null }, "results": [ { "description": null, "os_family": "Redhat", "created_at": "2024-02-22 16:22:41 UTC", "updated_at": "2024-02-22 16:22:41 UTC", "name": "ptable429", "id": 1007981717 } ] }
Param name | Description |
---|---|
operatingsystem_id
optional |
ID of operating system Validations:
|
location_id
optional |
Scope by locations Validations:
|
organization_id
optional |
Scope by organizations Validations:
|
search
optional |
filter results Validations:
|
order
optional |
Sort and order by a searchable field, e.g. '<field> DESC' Validations:
|
page
optional |
Page number, starting at 1 Validations:
|
per_page
optional |
Number of results per page to return, 'all' to return all results Validations:
|
Field name | Type | Possible values |
---|---|---|
default | true, false | |
family | string | |
id | integer | |
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/1007981724-ptable435 200 { "layout": "zerombr\nclearpart --all --initlabel\npart /boot --fstype ext3 --size=<%= 10 * 10 %> --asprimary\npart / --fstype ext3 --size=1024 --grow\npart swap --recommended", "locked": false, "description": null, "os_family": "Redhat", "created_at": "2024-02-22 16:22:42 UTC", "updated_at": "2024-02-22 16:22:42 UTC", "name": "ptable435", "id": 1007981724, "operatingsystems": [], "locations": [ { "id": 255093256, "name": "Location 1", "title": "Location 1", "description": null } ], "organizations": [ { "id": 447626438, "name": "Organization 1", "title": "Organization 1", "description": null } ] }
Param name | Description |
---|---|
location_id
optional |
Set the current location context for the request Validations:
|
organization_id
optional |
Set the current organization context for the request Validations:
|
id
required |
Validations:
|
POST /api/ptables { "ptable": { "name": "ptable_test", "layout": "d-i partman-auto/disk", "os_family": "Redhat" } } 201 { "layout": "d-i partman-auto/disk", "locked": false, "description": null, "os_family": "Redhat", "created_at": "2024-02-22 16:22:41 UTC", "updated_at": "2024-02-22 16:22:41 UTC", "name": "ptable_test", "id": 1007981707, "operatingsystems": [], "locations": [], "organizations": [] }
Param name | Description |
---|---|
location_id
optional |
Set the current location context for the request Validations:
|
organization_id
optional |
Set the current organization context for the request Validations:
|
ptable
required |
Validations:
|
ptable[name]
required |
Validations:
|
ptable[description]
optional , nil allowed |
Validations:
|
ptable[layout]
required |
Validations:
|
ptable[snippet]
optional , nil allowed |
Validations:
|
ptable[audit_comment]
optional , nil allowed |
Validations:
|
ptable[locked]
optional , nil allowed |
Whether or not the template is locked for editing Validations:
|
ptable[os_family]
optional , nil allowed |
Validations:
|
ptable[operatingsystem_ids]
optional , nil allowed |
Array of operating system IDs to associate with the partition table Validations:
|
ptable[host_ids]
optional , nil allowed |
Array of host IDs to associate with the partition table Validations:
|
ptable[hostgroup_ids]
optional , nil allowed |
Array of host group IDs to associate with the partition table Validations:
|
ptable[location_ids]
optional , nil allowed |
REPLACE locations with given ids Validations:
|
ptable[organization_ids]
optional , nil allowed |
REPLACE organizations with given ids. Validations:
|
POST /api/ptables/import { "ptable": { "name": "ptable420", "template": "b" } } 201 { "template": "b", "snippet": false, "description": null, "id": 1007981705, "name": "ptable420", "template_kind_id": null, "created_at": "2024-02-22T16:22:41.539Z", "updated_at": "2024-02-22T16:22:41.546Z", "locked": false, "default": false, "vendor": null, "os_family": "Redhat", "job_category": "Miscellaneous", "provider_type": null, "description_format": null, "execution_timeout_interval": null }
Param name | Description |
---|---|
location_id
optional |
Set the current location context for the request Validations:
|
organization_id
optional |
Set the current organization context for the request Validations:
|
ptable
required |
Validations:
|
ptable[name]
optional |
template name Validations:
|
ptable[template]
optional |
template contents including metadata Validations:
|
ptable[location_ids]
optional , nil allowed |
REPLACE locations with given ids Validations:
|
ptable[organization_ids]
optional , nil allowed |
REPLACE organizations with given ids. Validations:
|
options
optional |
Validations:
|
options[force]
optional , nil allowed |
use if you want update locked templates Validations:
|
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:
|
options[lock]
optional , nil allowed |
lock imported templates (false by default) Validations:
|
options[default]
optional , nil allowed |
makes the template default meaning it will be automatically associated with newly created organizations and locations (false by default) Validations:
|
Param name | Description |
---|---|
location_id
optional |
Set the current location context for the request Validations:
|
organization_id
optional |
Set the current organization context for the request Validations:
|
version
optional |
template version Validations:
|
PUT /api/ptables/1007981709-ptable423 { "ptable": { "audit_comment": "aha", "template": "tmp" } } 200 { "layout": "tmp", "locked": false, "description": null, "os_family": "Redhat", "created_at": "2024-02-22 16:22:41 UTC", "updated_at": "2024-02-22 16:22:41 UTC", "name": "ptable423", "id": 1007981709, "operatingsystems": [], "locations": [ { "id": 255093256, "name": "Location 1", "title": "Location 1", "description": null } ], "organizations": [ { "id": 447626438, "name": "Organization 1", "title": "Organization 1", "description": null } ] }
Param name | Description |
---|---|
location_id
optional |
Set the current location context for the request Validations:
|
organization_id
optional |
Set the current organization context for the request Validations:
|
id
required |
Validations:
|
ptable
required |
Validations:
|
ptable[name]
optional |
Validations:
|
ptable[description]
optional , nil allowed |
Validations:
|
ptable[layout]
optional |
Validations:
|
ptable[snippet]
optional , nil allowed |
Validations:
|
ptable[audit_comment]
optional , nil allowed |
Validations:
|
ptable[locked]
optional , nil allowed |
Whether or not the template is locked for editing Validations:
|
ptable[os_family]
optional , nil allowed |
Validations:
|
ptable[operatingsystem_ids]
optional , nil allowed |
Array of operating system IDs to associate with the partition table Validations:
|
ptable[host_ids]
optional , nil allowed |
Array of host IDs to associate with the partition table Validations:
|
ptable[hostgroup_ids]
optional , nil allowed |
Array of host group IDs to associate with the partition table Validations:
|
ptable[location_ids]
optional , nil allowed |
REPLACE locations with given ids Validations:
|
ptable[organization_ids]
optional , nil allowed |
REPLACE organizations with given ids. Validations:
|
DELETE /api/ptables/1007981719-ptable431 { "ptable": {} } 200 { "id": 1007981719, "name": "ptable431", "template": "zerombr\nclearpart --all --initlabel\npart /boot --fstype ext3 --size=<%= 10 * 10 %> --asprimary\npart / --fstype ext3 --size=1024 --grow\npart swap --recommended", "snippet": false, "template_kind_id": null, "created_at": "2024-02-22T16:22:41.818Z", "updated_at": "2024-02-22T16:22:41.818Z", "locked": false, "default": false, "vendor": null, "os_family": "Redhat", "job_category": "Miscellaneous", "provider_type": null, "description_format": null, "execution_timeout_interval": null, "description": null }
Param name | Description |
---|---|
location_id
optional |
Set the current location context for the request Validations:
|
organization_id
optional |
Set the current organization context for the request Validations:
|
id
required |
Validations:
|
POST /api/ptables/1007981703-ptable418/clone { "ptable": { "name": "MyClone" } } 201 { "name": "MyClone", "id": 1007981703, "template": "zerombr\nclearpart --all --initlabel\npart /boot --fstype ext3 --size=<%= 10 * 10 %> --asprimary\npart / --fstype ext3 --size=1024 --grow\npart swap --recommended", "snippet": false, "template_kind_id": null, "created_at": "2024-02-22T16:22:41.500Z", "updated_at": "2024-02-22T16:22:41.511Z", "locked": false, "default": false, "vendor": null, "os_family": "Redhat", "job_category": "Miscellaneous", "provider_type": null, "description_format": null, "execution_timeout_interval": null, "description": null }
Param name | Description |
---|---|
location_id
optional |
Set the current location context for the request Validations:
|
organization_id
optional |
Set the current organization context for the request Validations:
|
id
required |
Validations:
|
ptable
required |
Validations:
|
ptable[name]
required |
template name Validations:
|
GET /api/ptables/1007981731-ptable441/export 200 <%# name: ptable441 snippet: false model: Ptable os_family: Redhat organizations: - Organization 1 locations: - Location 1 -%> zerombr clearpart --all --initlabel part /boot --fstype ext3 --size=<%= 10 * 10 %> --asprimary part / --fstype ext3 --size=1024 --grow part swap --recommended
Param name | Description |
---|---|
location_id
optional |
Set the current location context for the request Validations:
|
organization_id
optional |
Set the current organization context for the request Validations:
|
id
required |
Validations:
|