get_annotations

List the annotations on an asset.

get_annotations

List the annotations on an asset.

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

📘

Confinement

Read-only; safe anywhere.

Signatures

def get_annotations(sdk, asset_id):
    """Return the asset's annotations, or None if it does not resolve."""
    return sdk.get_annotations(asset_id)
export async function getAnnotations(sdk, assetId) {
    // Return the asset's annotations.
    return await sdk.getAnnotations(assetId);
}

Parameters

Parameter (Python)Parameter (JS)TypeRequiredNotes
sdksdkNomad_SDKyes
asset_idassetIdstryese.g. <asset-uuid>

Returns

dict | None — the asset's annotations (list/dict). None if not found.

Errors

  • 401 unauthenticated
  • 404 not found -> None

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