support

GET /api/support/packages/{name}/

Changed on

Search and retrieve package definitions for support investigation.

List action supports full-text search via ?q= (matched against package name / registry id and verbose name).

Retrieve action looks up a single package by its registry id (the name field, e.g. @scope/collection/package). An optional ?version= query parameter returns the config at that semantic version instead of the current version.

Request

  • Base URL
    https://app.pixiebrix.com
  • Auth
    none declared

Path parameters

namestring required

Query parameters

versionstring

Optional semantic version. When provided, returns that package version instead of the current version.

Response

idstring uuid

Surrogate primary key

namestring required

Unique package identifier, including the scope and collection

verbose_namestring nullable

Human-readable name

versionstring
kindstring required
updated_atstring date-time
configobject
raw_configstring

Changes