delete_share

Delete a share by id.

delete_share

Delete a share by id.

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

📘

Confinement

Class C: this is the teardown for a created share - always delete shares you create (cleanup registry). Non-prod only.

Signatures

def delete_share(sdk, share_id):
    """Delete a share by id; return the confirmation or None."""
    return sdk.delete_share(share_id)
export async function deleteShare(sdk, shareId) {
    // Delete a share by id.
    return await sdk.deleteShare(shareId);
}

Parameters

Parameter (Python)Parameter (JS)TypeRequiredNotes
sdksdkNomad_SDKyes
share_idshareIdstryese.g. <share-uuid>

Returns

dict | None — confirmation; None on failure.

Errors

  • 401 unauthenticated
  • 404 share not found

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