PlatformHub

Get Platform Hub certificates.

get/platformhub/certificates

Request

  • Base URL
    https://demo.octopus.app/api
  • URL
    https://demo.octopus.app/api/platformhub/certificates
  • Auth
    • API key in header X-Octopus-ApiKey
    • or API key in query parameter ApiKey
    • or API key in header X-NuGet-ApiKey

Query parameters

archivedboolean

If true, returns only archived certificates. Otherwise, returns only non-archived certificates.

firstResultstring

Certificate ID which if specified, adds the certificate with matching ID to the result if it is not already included.

idsstring

Comma delimited list of certificate IDs used to filter the result.

orderBystring

If the value is 'recent' (case-insensitive), the result is sorted by Created instead of NotAfter.

partialNamestring

Alternative parameter to Search; filters certificates by Name, Subject, or Thumbprint.

searchstring

Filters certificates by Name, Subject, or Thumbprint.

skipinteger

Number of items to skip. Defaults to zero

takeinteger

Number of items to take. Defaults to 15

Response

The requested Platform Hub certificates.

ItemsPerPageinteger
ItemTypestring

The type of item in this list

LastPageNumberinteger
NumberOfPagesinteger
TotalResultsinteger

Example response

{
  "Items": [
    {
      "Links": {
        "Self": "/api/..."
      }
    }
  ],
  "ItemsPerPage": 30,
  "ItemType": "PlatformHubCertificate",
  "LastPageNumber": 1,
  "NumberOfPages": 2,
  "TotalResults": 42
}

Changes

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