Examples

GET /api/template_kinds
200
{
  "total": 9,
  "subtotal": 9,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "created_at": "2024-02-22 16:16:06 UTC",
      "updated_at": "2024-02-22 16:16:06 UTC",
      "name": "iPXE",
      "id": 698706415
    },
    {
      "created_at": "2024-02-22 16:16:06 UTC",
      "updated_at": "2024-02-22 16:16:06 UTC",
      "name": "provision",
      "id": 983253650
    },
    {
      "created_at": "2024-02-22 16:16:06 UTC",
      "updated_at": "2024-02-22 16:16:06 UTC",
      "name": "PXELinux",
      "id": 452984334
    },
    {
      "created_at": "2024-02-22 16:16:06 UTC",
      "updated_at": "2024-02-22 16:16:06 UTC",
      "name": "script",
      "id": 478250810
    },
    {
      "created_at": "2024-02-22 16:16:06 UTC",
      "updated_at": "2024-02-22 16:16:06 UTC",
      "name": "finish",
      "id": 550103832
    },
    {
      "created_at": "2024-02-22 16:16:06 UTC",
      "updated_at": "2024-02-22 16:16:06 UTC",
      "name": "PXEGrub",
      "id": 131565194
    },
    {
      "created_at": "2024-02-22 16:16:06 UTC",
      "updated_at": "2024-02-22 16:16:06 UTC",
      "name": "PXEGrub2",
      "id": 701398793
    },
    {
      "created_at": "2024-02-22 16:16:06 UTC",
      "updated_at": "2024-02-22 16:16:06 UTC",
      "name": "host_init_config",
      "id": 508279162
    },
    {
      "created_at": "2024-02-22 16:16:06 UTC",
      "updated_at": "2024-02-22 16:16:06 UTC",
      "name": "registration",
      "id": 581478312
    }
  ]
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Integer

search
optional

filter results

Validations:

  • String

order
optional

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

Validations:

  • 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
id integer
name string