CLcloudsmith
metadata

Retrieve a package metadata entry

Changed on

Retrieve a specific metadata entry for a package.

get/metadata/packages/{package_slug_perm}/{slug_perm}/

Request

  • Base URL
    https://api.cloudsmith.io/v2
  • Auth
    • API key in header X-Api-Key
    • or HTTP basic

Path parameters

package_slug_permstring required

The slug_perm of the package.

slug_permstring required

The slug_perm of the metadata entry.

Response

The requested metadata entry.

slug_permstring required

The unique slug identifying this metadata entry.

contentobject required

The metadata payload as a JSON object.

content_typestring required

The content type describing the structure of the metadata payload.

classification'UNKNOWN' | 'INTRINSIC' | 'SECURITY' | 'PROVENANCE' | 'SBOM' | 'GENERIC' required
  • UNKNOWN - Unknown
  • INTRINSIC - Intrinsic
  • SECURITY - Security
  • PROVENANCE - Provenance
  • SBOM - SBOM
  • GENERIC - Generic
source_kind'UNKNOWN' | 'SYSTEM' | 'UPSTREAM' | 'CUSTOM' | 'THIRD_PARTY' required
  • UNKNOWN - Unknown
  • SYSTEM - System
  • UPSTREAM - Upstream
  • CUSTOM - Custom
  • THIRD_PARTY - Third Party
source_identitystring required

The identifier for the source that supplied this metadata.

is_canonicalboolean required

Whether this entry is the canonical metadata record for its type.

source_tablestring required

The backing table or source model for this metadata entry.

created_atstring date-time required

When this metadata entry was created.

Changes

  • 287eea61ef65Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 3f44fa7d59b0Revision changes
    • info

      the endpoint scheme security apikey was removed from the API

    • info

      the endpoint scheme security basic was removed from the API