expire_share

Force-expire a share immediately (revoke access without deleting it).

expire_share

Force-expire a share immediately (revoke access without deleting it).

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

📘

Confinement

Class C: only expire shares you created. Non-prod only.

Signatures

def expire_share(sdk, share_id):
    """Force-expire a share by id; returns None."""
    return sdk.share_expire(share_id)
export async function expireShare(sdk, shareId) {
    // Force-expire a share by id.
    return await sdk.shareExpire(shareId);
}

Parameters

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

Returns

None — no body on success.

Errors

  • 401 unauthenticated
  • 404 share not found

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