PIpixiebrix
support

GET /api/support/packages/

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

Query parameters

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

created_at_gtestring

Filter packages created on or after this date (YYYY-MM-DD)

created_at_ltestring

Filter packages created on or before this date (YYYY-MM-DD)

updated_at_gtestring

Filter packages updated on or after this date (YYYY-MM-DD)

updated_at_ltestring

Filter packages updated on or before this date (YYYY-MM-DD)

qstring

A search term.

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

Changes