v57

latestOpenAPI 3.1.0Apache-2.0raw.githubusercontent.com2026-08-012143051018.3 KB

iPXE Template

Retrieve an iPXE template

Retrieve an iPXE template by its stable core ID. The caller must be authorized for at least one Site at which the template is available.

The Infrastructure Provider and Tenant are inferred from the org's membership. User must have authorization role with PROVIDER_ADMIN, PROVIDER_VIEWER, or TENANT_ADMIN suffix.

get/v2/org/{org}/nico/ipxe-template/{ipxeTemplateId}

Response

idstring uuid required

Stable template UUID assigned by core

namestring required

Globally unique template name

templatestring required

Raw iPXE script content

requiredParamsstring[] required

Parameters that must be provided to render the template

reservedParamsstring[] required

Parameters reserved by the template and not user-supplied

requiredArtifactsstring[] required

Artifact names required for the template

visibilitystring required

Template visibility: Internal or Public

createdstring date-time

updatedstring date-time

Example response

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "ubuntu-autoinstall",
  "template": "#!ipxe\nkernel ${kernel_url} initrd=initrd autoinstall\ninitrd ${initrd_url}\nboot\n",
  "requiredParams": [
    "kernel_url",
    "initrd_url"
  ],
  "reservedParams": [
    "mac"
  ],
  "requiredArtifacts": [
    "kernel",
    "initrd"
  ],
  "visibility": "Public",
  "created": "2026-07-14T14:15:22Z",
  "updated": "2026-07-14T14:15:22Z"
}