get_share

Read a share by id.

get_share

Read a share by id.

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

📘

Confinement

Class C: read-only; reference only shares you created. Non-prod only.

Signatures

def get_share(sdk, share_id):
    """Read a share by id; return the share dict or None."""
    return sdk.get_share(share_id)
export async function getShare(sdk, shareId) {
    // Read a share by id.
    return await sdk.getShare(shareId);
}

Parameters

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

Returns

dict | None — the share record; None if not found.

Errors

  • 401 unauthenticated
  • 404 share not found

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