1. Docs
  2. Reference
  3. REST API Docs
  4. Schema
  5. ListPackagesResponse

ListPackagesResponse

    Response containing a list of packages.

    Properties

    • packages array[PackageMetadata] required
      The list of packages
    • name string required
      The name of the package.
    • publisher string required
      The publisher of the package.
    • publisherDisplayName string optional
      The display name of the publisher.
    • source string required
      The source of the package.
    • version string required
      The version of the package in semver format.
    • title string optional
      The title/display name of the package.
    • description string optional
      The description of the package.
    • logoUrl string optional
      The URL of the logo for the package.
    • repoUrl string optional
      The URL of the repository the package is hosted in.
    • category string optional
      The category of the package.
    • isFeatured boolean required
      Whether the package is featured.
    • packageTypes array[string] optional
      The package types, e.g. “native”, “component”, “bridged”
    • packageStatus enum required
      The maturity level of the package, e.g. “ga”, “public_preview”
      Values: ga, public_preview
    • readmeURL string required
      The URL of the readme for the package.
    • schemaURL string required
      The URL of the schema for the package.
    • pluginDownloadURL string optional
      The URL to download the plugin at, as found in the schema.
    • createdAt string required
      The date and time the package version was created.
    • visibility enum required
      The visibility of the package.
      Values: public, private
    • parameterization PackageParameterization optional
      The parameterization of the provider, if any.
    • usageStats PackageUsageStats optional
      Usage statistics for this package within the requesting org. Only populated when the caller is authenticated.
    • continuationToken string optional
      Continuation token for pagination