create_folder

Create a sub-folder under a parent folder; return the new folder id.

create_folder

Create a sub-folder under a parent folder; return the new folder id.

Create a folder under parent_id and return its id.

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

📘

Confinement

parent_id must be your run-root anchor or a folder beneath it. Never the tree root.

Signatures

def create_folder(sdk, parent_id, display_name):
    """Create a folder under parent_id; return the new folder's id (str)."""
    result = sdk.create_folder_asset(parent_id, display_name)
    return result["id"]
export async function createFolder(sdk, parentId, displayName) {
    // Create a folder under parentId; return the new folder's id.
    const result = await sdk.createFolderAsset(parentId, displayName);
    return result.id;
}

Parameters

Parameter (Python)Parameter (JS)TypeRequiredNotes
sdksdkNomad_SDKyes
parent_idparentIdstryesmust be an existing folder (assetType == 1)
display_namedisplayNamestryese.g. my-folder

Returns

str - the new folder's id (from create_folder_asset -> {id})

Errors

  • 401 unauthenticated
  • 404 parent not found

See also: Python ↔ JS naming map · Return shapes.


Did this page help you?