update_share

Update a share's name (and/or other fields) by id.

update_share

Update a share's name (and/or other fields) by id.

Safety class: C · API type: portal · Min version: —

📘
Confinement
Class C: only update shares you created. Non-prod only.

Signatures

def update_share(sdk, share_id, name=None):
    """Patch a share (e.g. rename) by id; return the updated share or None."""
    return sdk.update_share(share_id, name=name)

export async function updateShare(sdk, shareId, name = null) {
    // Positional: (shareId, id, name, sharedContents, ...). Rename only here.
    return await sdk.updateShare(shareId, null, name, null, null, null, null,
        null, null, null, null, null, null);
}

Parameters

Parameter (Python)	Parameter (JS)	Type	Required	Notes
`sdk`	`sdk`	Nomad_SDK	yes
`share_id`	`shareId`	str	yes	e.g. `<share-uuid>`
`name`	`name`	str \| None	no	e.g. `renamed share`

Returns

dict | None — updated share; None on failure.

Errors

401 unauthenticated
404 share not found