register

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

📘
Confinement
parent_id must be within your run-root anchor.

Signatures

def register(sdk, parent_id, bucket_name, object_key, display_object_key=None):
    """Register an existing storage object under parent_id; return the asset record."""
    return sdk.register_asset(None, parent_id, display_object_key, bucket_name, object_key)

export async function register(sdk, parentId, bucketName, objectKey, displayObjectKey = null) {
    // Register an existing storage object under parentId.
    return await sdk.registerAsset(null, parentId, displayObjectKey, bucketName, objectKey);
}

Parameters

Parameter (Python)	Parameter (JS)	Type	Required	Notes
`sdk`	`sdk`	Nomad_SDK	yes
`parent_id`	`parentId`	str	yes	destination folder
`bucket_name`	`bucketName`	str	yes	e.g. `my-bucket`
`object_key`	`objectKey`	str	yes	e.g. `path/to/object.mp4`
`display_object_key`	`displayObjectKey`	str \| None	no

Returns

dict | None — the new asset record; None on failure

Errors

401 unauthenticated
404 parent not found