API: customization

GET `/v1/customization/specs`

GET /v1/customization/specs

Status	Description	Schema
200	Customization specifications	array of `CustomizationSpecView`

POST /v1/customization/specs

Name	Type	Required	Description
`description`	`string` or `null`		Optional description.
`dnsServers`	array of `string` or `null`		DNS servers.
`dnsSuffixes`	array of `string` or `null`		DNS search suffixes.
`domain`	`string` or `null`		DNS domain.
`domainAdmin`	`string` or `null`		Domain-join account name.
`domainAdminPassword`	`string` or `null`		Domain-join account password (stored; never returned on GET).
`domainOu`	`string` or `null`		Optional target OU DN.
`fullName`	`string` or `null`		Windows registered owner.
`hostname`	`string` or `null`		Fixed host name.
`joinDomain`	`string` or `null`		AD domain to join.
`joinWorkgroup`	`string` or `null`		Workgroup when not joining a domain.
`metadata`	`string` or `null`		Raw cloud-init metadata (overrides hostname synthesis when set).
`name`	`string`	yes	Spec name (1..=80; ignored on PUT path overwrite in favour of the path).
`nics`	array of `CustomizationNicSetting` or `null`		NIC mappings (static IP / DHCP).
`orgName`	`string` or `null`		Windows organisation.
`password`	`string` or `null`		Plaintext guest password (stored; never returned on GET).
`sshUser`	`string` or `null`		Optional SSH username that also receives the password.
`timezone`	`string` or `null`		Timezone.
`type`	`string` or `null`		Guest OS family (`Linux` or `Windows`); defaults to Linux.
`unattend`	`string` or `null`		Raw unattend.xml for Windows (stored; never returned on GET).
`userdata`	`string` or `null`		Raw cloud-init user-data (overrides synthesized user-data when set).

Status	Description	Schema
201	Created specification	`CustomizationSpecView`

GET /v1/customization/specs/{name}

Name	In	Type	Required	Description
`name`	path	`string`	yes	Specification name

Status	Description	Schema
200	Specification	`CustomizationSpecView`

PUT /v1/customization/specs/{name}

Name	In	Type	Required	Description
`name`	path	`string`	yes	Specification name

Name	Type	Required	Description
`description`	`string` or `null`		Optional description.
`dnsServers`	array of `string` or `null`		DNS servers.
`dnsSuffixes`	array of `string` or `null`		DNS search suffixes.
`domain`	`string` or `null`		DNS domain.
`domainAdmin`	`string` or `null`		Domain-join account name.
`domainAdminPassword`	`string` or `null`		Domain-join account password (stored; never returned on GET).
`domainOu`	`string` or `null`		Optional target OU DN.
`fullName`	`string` or `null`		Windows registered owner.
`hostname`	`string` or `null`		Fixed host name.
`joinDomain`	`string` or `null`		AD domain to join.
`joinWorkgroup`	`string` or `null`		Workgroup when not joining a domain.
`metadata`	`string` or `null`		Raw cloud-init metadata (overrides hostname synthesis when set).
`name`	`string`	yes	Spec name (1..=80; ignored on PUT path overwrite in favour of the path).
`nics`	array of `CustomizationNicSetting` or `null`		NIC mappings (static IP / DHCP).
`orgName`	`string` or `null`		Windows organisation.
`password`	`string` or `null`		Plaintext guest password (stored; never returned on GET).
`sshUser`	`string` or `null`		Optional SSH username that also receives the password.
`timezone`	`string` or `null`		Timezone.
`type`	`string` or `null`		Guest OS family (`Linux` or `Windows`); defaults to Linux.
`unattend`	`string` or `null`		Raw unattend.xml for Windows (stored; never returned on GET).
`userdata`	`string` or `null`		Raw cloud-init user-data (overrides synthesized user-data when set).

Status	Description	Schema
200	Updated specification	`CustomizationSpecView`

DELETE /v1/customization/specs/{name}

Name	In	Type	Required	Description
`name`	path	`string`	yes	Specification name

Status	Description	Schema
204	Deleted