ARartifacthub
Packages

Search packages that meet the provided criteria

Changed on

Search packages that meet the provided criteria

get/packages/search

Request

Query parameters

offsetinteger

The number of items to skip before starting to collect the result set

limitinteger

The number of items to return

facetsboolean required

Whether we should get facets or not

ts_query_webstring
Example:database

Text search query (websearch format)

kindRepositoryKind[]

Repository kind:

  • 0 - Helm charts
  • 1 - Falco rules
  • 2 - OPA policies
  • 3 - OLM operators
  • 4 - Tinkerbell actions
  • 5 - Krew kubectl plugins
  • 6 - Helm plugins
  • 7 - Tekton tasks
  • 8 - KEDA scalers
  • 9 - Core DNS plugins
  • 10 - Keptn integrations
  • 11 - Tekton pipelines
  • 12 - Container images
  • 13 - Kubewarden policies
  • 14 - Gatekeeper policies
  • 15 - Kyverno policies
  • 16 - Knative client plugins
  • 17 - Backstage plugins
  • 18 - Argo templates
  • 19 - KubeArmor templates
  • 20 - KCL packages
  • 21 - Headlamp plugins
  • 22 - Inspektor gadgets
  • 23 - Tekton stepactions
  • 24 - Meshery designs
  • 25 - Opencost plugins
  • 26 - Radius recipes
  • 27 - Bootable containers
  • 28 - Kagent agents
categoryinteger[]

Package category:

  • 1 - AI / Machine learning
  • 2 - Database
  • 3 - Integration and delivery
  • 4 - Monitoring and logging
  • 5 - Networking
  • 6 - Security
  • 7 - Storage
  • 8 - Streaming and messaging
  • 9 - Analytics
  • 10 - Data processing
  • 11 - Web applications
userstring[]

List of aliases

[
  "user1",
  "user2"
]
orgstring[]

List of organization names

[
  "org1",
  "org2"
]
repostring[]

List of repository names

[
  "repo1",
  "repo2"
]
licensestring[]

List of SPDX identifiers

[
  "MIT",
  "Apache-2.0"
]
capabilitiesstring[]

List of operator capability levels

[
  "basic install",
  "seamless upgrades",
  "full lifecycle",
  "deep insights",
  "auto pilot"
]
deprecatedboolean

Whether to include deprecated packages or not

operatorsboolean

Whether to get only operators

verified_publisherboolean

Whether to get only verified publisher

officialboolean

Whether to get only official repositories

cncfboolean

Whether to get only packages published by CNCF projects

sort'relevance' | 'stars' | 'last_updated'
Example:relevance

Sort criteria

Response

Example response

{
  "packages": [
    {
      "name": "pkg1",
      "normalized_name": "pkg1",
      "logo_image_id": "12345abcde",
      "display_name": "Package 1",
      "description": "This is a package sample",
      "version": "1.0.0",
      "app_version": "0.1.0",
      "license": "MIT",
      "repository": {
        "name": "repo1",
        "display_name": "Repository 1",
        "url": "http://repourl",
        "user_alias": "jdoe",
        "organization_name": "org1",
        "organization_display_name": "Organization 1"
      },
      "category_display_name": "Database",
      "stars": 3
    }
  ],
  "facets": [
    {
      "title": "Publisher",
      "filter_key": "publisher",
      "options": [
        {
          "id": "f41e7480-8d5c-40d3-9ba6-65ac0da8fc9c",
          "name": "Helm",
          "total": 292,
          "filter_key": "org"
        },
        {
          "id": "b771c9a8-0076-444c-ad5e-927abe14173d",
          "name": "Artifact Hub",
          "total": 1,
          "filter_key": "org"
        },
        {
          "id": "a70u69a8-0326-324c-fd3e-0iu87e14173d",
          "name": "user1",
          "total": 3,
          "filter_key": "user"
        }
      ]
    }
  ]
}

Changes

  • d2e9234264b1Revision changes
    • warning

      added the new 10.00 enum value to the /// response property for the response status

    • warning

      added the new 11.00 enum value to the /// response property for the response status

    • warning

      added the new 9.00 enum value to the /// response property for the response status

    • info

      added the enum value 10.00 to the property items/ of the query request parameter category

    • info

      added the enum value 11.00 to the property items/ of the query request parameter category

    • info

      added the enum value 9.00 to the property items/ of the query request parameter category

    • info

      added the optional property /// to the response with the status

  • 081ff21a6f42Revision changes
    • warning

      added the new 22.00 enum value to the /////// response property for the response status

    • warning

      added the new 23.00 enum value to the /////// response property for the response status

    • warning

      added the new 24.00 enum value to the /////// response property for the response status

    • warning

      added the new 25.00 enum value to the /////// response property for the response status

    • warning

      added the new 26.00 enum value to the /////// response property for the response status

    • warning

      added the new 27.00 enum value to the /////// response property for the response status

    • info

      added the enum value 22.00 to the property items/ of the query request parameter kind

    • info

      added the enum value 23.00 to the property items/ of the query request parameter kind

    • info

      added the enum value 24.00 to the property items/ of the query request parameter kind

    • info

      added the enum value 25.00 to the property items/ of the query request parameter kind

    • info

      added the enum value 26.00 to the property items/ of the query request parameter kind

    • info

      added the enum value 27.00 to the property items/ of the query request parameter kind