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

Examples

GET /api/ptables
200
{
  "total": 2,
  "subtotal": 2,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "os_family": null,
      "created_at": "2019-09-11 14:34:13 UTC",
      "updated_at": "2019-09-11 14:34:13 UTC",
      "name": "Example partition table",
      "id": 615088209
    },
    {
      "os_family": "Redhat",
      "created_at": "2019-09-11 14:34:42 UTC",
      "updated_at": "2019-09-11 14:34:42 UTC",
      "name": "ptable214",
      "id": 1007981802
    }
  ]
}

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 organizations

Validations:

  • Must be a Integer

search
Optional

filtrera resultat

Validations:

  • Must be a String

order
Optional

Sort field and order, eg. ‘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

Validations:

  • Must be a number.

Search fields

Field name Typ 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

Examples

GET /api/ptables/1007981804-ptable216
200
{
  "layout": "zerombr\\nclearpart --all    --initlabel\\npart /boot --fstype ext3 --size=<%= 10 * 10 %> --asprimary\\npart /     --f   stype ext3 --size=1024 --grow\\npart swap  --recommended",
  "locked": false,
  "os_family": "Redhat",
  "created_at": "2019-09-11 14:34:43 UTC",
  "updated_at": "2019-09-11 14:34:43 UTC",
  "name": "ptable216",
  "id": 1007981804,
  "operatingsystems": [
    {
      "id": 1073012828,
      "name": "Redhat",
      "title": "RHEL 6.1"
    }
  ],
  "locations": [
    {
      "id": 255093256,
      "name": "Location 1",
      "title": "Location 1",
      "description": null
    }
  ],
  "organizations": [
    {
      "id": 447626438,
      "name": "Organization 1",
      "title": "Organization 1",
      "description": null
    }
  ]
}

Params

Param Name Description
location_id
Optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
Optional

Scope by organizations

Validations:

  • Must be a Integer

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

Examples

POST /api/ptables
{
  "ptable": {
    "name": "W",
    "layout": "d-i partman-auto/disk"
  }
}
201
{
  "layout": "d-i partman-auto/disk",
  "locked": false,
  "os_family": null,
  "created_at": "2019-09-11 14:34:42 UTC",
  "updated_at": "2019-09-11 14:34:42 UTC",
  "name": "W",
  "id": 1007981781,
  "operatingsystems": [],
  "locations": [],
  "organizations": []
}

Params

Param Name Description
location_id
Optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
Optional

Scope by organizations

Validations:

  • Must be a Integer

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 , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Validations:

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

ptable[audit_comment]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a String

ptable[locked]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Whether or not the template is locked for editing

Validations:

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

ptable[os_family]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a String

ptable[operatingsystem_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Array of operating system IDs to associate with the partition table

Validations:

  • Must be an array of any type

ptable[host_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Array of host IDs to associate with the partition table

Validations:

  • Must be an array of any type

ptable[hostgroup_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Array of host group IDs to associate with the partition table

Validations:

  • Must be an array of any type

ptable[location_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

REPLACE locations with given ids

Validations:

  • Must be an array of any type

ptable[organization_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

REPLACE organizations with given ids.

Validations:

  • Must be an array of any type


POST /api/ptables/import
Import a provisioning template

Examples

POST /api/ptables/import
{
  "ptable": {
    "name": "ptable212",
    "template": "b"
  }
}
201
{
  "template": "b",
  "name": "ptable212",
  "id": 1007981800,
  "snippet": false,
  "template_kind_id": null,
  "created_at": "2019-09-11T14:34:42.858Z",
  "updated_at": "2019-09-11T14:34:42.873Z",
  "locked": false,
  "default": false,
  "vendor": null,
  "os_family": "Redhat"
}

Params

Param Name Description
location_id
Optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
Optional

Scope by organizations

Validations:

  • Must be a Integer

ptable
Required

Validations:

  • Must be a Hash

ptable[name]
Optional

mallnamn

Validations:

  • Must be a String

ptable[template]
Optional

template contents including metadata

Validations:

  • Must be a String

ptable[location_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

REPLACE locations with given ids

Validations:

  • Must be an array of any type

ptable[organization_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

REPLACE organizations with given ids.

Validations:

  • Must be an array of any type

options
Optional

Validations:

  • Must be a Hash

options[force]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

use if you want update locked templates

Validations:

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

options[associate]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

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 , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

lock imported templates (false by default)

Validations:

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

options[default]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

makes the template default meaning it will be automatically associated with newly created organizations and locations (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:

  • Must be a Integer

organization_id
Optional

Scope by organizations

Validations:

  • Must be a Integer

version
Optional

mallversion

Validations:

  • Must be a String


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

Examples

PUT /api/ptables/1007981787-ptable201
{
  "ptable": {
    "audit_comment": "aha",
    "template": "tmp"
  }
}
200
{
  "layout": "tmp",
  "locked": false,
  "os_family": "Redhat",
  "created_at": "2019-09-11 14:34:42 UTC",
  "updated_at": "2019-09-11 14:34:42 UTC",
  "name": "ptable201",
  "id": 1007981787,
  "operatingsystems": [],
  "locations": [
    {
      "id": 255093256,
      "name": "Location 1",
      "title": "Location 1",
      "description": null
    }
  ],
  "organizations": [
    {
      "id": 447626438,
      "name": "Organization 1",
      "title": "Organization 1",
      "description": null
    }
  ]
}

Params

Param Name Description
location_id
Optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
Optional

Scope by organizations

Validations:

  • Must be a Integer

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 , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Validations:

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

ptable[audit_comment]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a String

ptable[locked]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Whether or not the template is locked for editing

Validations:

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

ptable[os_family]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a String

ptable[operatingsystem_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Array of operating system IDs to associate with the partition table

Validations:

  • Must be an array of any type

ptable[host_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Array of host IDs to associate with the partition table

Validations:

  • Must be an array of any type

ptable[hostgroup_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Array of host group IDs to associate with the partition table

Validations:

  • Must be an array of any type

ptable[location_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

REPLACE locations with given ids

Validations:

  • Must be an array of any type

ptable[organization_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

REPLACE organizations with given ids.

Validations:

  • Must be an array of any type


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

Examples

DELETE /api/ptables/1007981794-ptable206
{
  "ptable": {}
}
422
{
  "error": {
    "id": 1007981794,
    "errors": {
      "base": [
        "ptable206 is used by host312"
      ]
    },
    "full_messages": [
      "ptable206 is used by host312"
    ]
  }
}

Params

Param Name Description
location_id
Optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
Optional

Scope by organizations

Validations:

  • Must be a Integer

id
Required

Validations:

  • Must be a String


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

Examples

POST /api/ptables/1007981806-ptable218/clone
{
  "ptable": {
    "name": ""
  }
}
422
{
  "error": {
    "id": 1007981806,
    "errors": {
      "name": [
        "can't be blank"
      ]
    },
    "full_messages": [
      "Name can't be blank"
    ]
  }
}

Params

Param Name Description
location_id
Optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
Optional

Scope by organizations

Validations:

  • Must be a Integer

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

mallnamn

Validations:

  • Must be a String


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

Examples

GET /api/ptables/1007981785-ptable199/export
200
zerombr\nclearpart --all    --initlabel\npart /boot --fstype ext3 --size=<%= 10 * 10 %> --asprimary\npart /     --f   stype ext3 --size=1024 --grow\npart swap  --recommended
<%#
name: ptable199
snippet: false
model: Ptable
os_family: Redhat
organizations:
- Organization 1
locations:
- Location 1
%>

Params

Param Name Description
location_id
Optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
Optional

Scope by organizations

Validations:

  • Must be a Integer

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.