Air APIAPI ReferenceManifests

Create an OS configuration template

View as Markdown
Creates an OS template owned by the requesting client's org. The `(os_type, os_template_version)` pair must be globally unique. `generate` maps variable names to a generation strategy (currently `MGMT_MAC`); `render` maps absolute POSIX file paths to render entries, each with a `content` template body plus optional `owner`, `group`, and `mode` (default root/root/0644). The owning org is set automatically from the request and cannot be supplied by the client. **Required scope:** `air:image_write` (roles: `air_image_publisher`, `air_image_uploader`)

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
os_typestringRequired1-128 characters
OS family identifier.
os_template_versionstringRequired1-255 characters
Template version string.
rendermap from strings to objectsRequired

Dict mapping canonical absolute POSIX paths to render entries. Keys must start with / and contain no .. or . segments, redundant separators, or trailing separator. Each value has a required content (template body) plus optional owner, group, and mode (default root/root/0644).

generatemap from strings to enumsOptional
Dict mapping variable names to generation strategies.
varslist of stringsOptional
Variable names the render templates reference. Must exactly match the variables used across the render bodies.

Response

idstringRead-onlyformat: "uuid"
createddatetimeRead-only
modifieddatetimeRead-only
os_typestring<=128 characters
OS family identifier.
os_template_versionstring<=255 characters
Template version string.
rendermap from strings to objects

Dict mapping canonical absolute POSIX paths to render entries. Keys must start with / and contain no .. or . segments, redundant separators, or trailing separator. Each value has a required content (template body) plus optional owner, group, and mode (default root/root/0644).

orgstringRead-onlyformat: "uuid"
The org that owns this OS template. Taken from the creator.
creatorstring or nullRead-only
The username of the user who created the OS template.
generatemap from strings to enumsOptional
Dict mapping variable names to generation strategies.
varslist of stringsOptional
Variable names the render templates reference. Must exactly match the variables used across the render bodies.

Errors

400
Bad Request Error
403
Forbidden Error
500
Internal Server Error