PlatformHub

Search the specified platform hub feed for packages based on the provided search term

get/platformhub/feeds/{id}/packages/search

Request

  • Base URL
    https://demo.octopus.app/api
  • URL
    https://demo.octopus.app/api/platformhub/feeds/{id}/packages/search
  • Auth
    • API key in header X-Octopus-ApiKey
    • or API key in query parameter ApiKey
    • or API key in header X-NuGet-ApiKey

Path parameters

idstring required

The id of the feed resource.

Query parameters

packageTypestring

The package type to filter results by. Used by feeds that can contain multiple package types. Valid values are ContainerImage and HelmChart.

skipinteger

Number of items to skip. Defaults to zero

takeinteger

Number of items to take. Defaults to 20

termstring

The term to search for.

Response

Returns a paginated collection of searched package descriptions in platform hub

ItemsPerPageinteger
ItemTypestring

The type of item in this list

LastPageNumberinteger
NumberOfPagesinteger
TotalResultsinteger

Example response

{
  "ItemsPerPage": 30,
  "ItemType": "PlatformHubPackageDescription",
  "LastPageNumber": 1,
  "NumberOfPages": 2,
  "TotalResults": 42
}

Changes

No recorded changes to this operation across all 13 revisions of this API.