archive

Move an asset to archival (cold) storage.

Archive a confined asset to cold storage. Pair with restore.

Safety class: B · API type: admin · Min version: —

📘
Confinement
Class B: asset_id must be within your run-root anchor.

Signatures

def archive(sdk, asset_id):
    """Archive asset_id; return the response dict or None."""
    return sdk.archive_asset(asset_id)

export async function archive(sdk, assetId) {
    // Archive a confined asset to cold storage; pair with restore.
    return await sdk.archiveAsset(assetId);
}

Parameters

Parameter (Python)	Parameter (JS)	Type	Required	Notes
`sdk`	`sdk`	Nomad_SDK	yes
`asset_id`	`assetId`	str	yes	e.g. `<asset-uuid>`

Returns

dict | None — job/confirmation; None on failure. Async transition.

Errors

401 unauthenticated
404 asset not found