835047dab520

latestSwagger 2.02026-08-101,9168873.7 MB
Certificates

Lists the X.509 certificates in the supplied Octopus Deploy Space in pages. Current certificates are sorted by soonest expiry first unless OrderBy says otherwise; archived certificates are always sorted by most recently archived.

Skip and Take are required. TotalResults is always the real count of matching certificates, including when Tenant or FirstResult is supplied. Certificate data and passwords are never returned by this endpoint.

get/certificates/v2

Query parameters

archivedboolean

When true, returns only archived certificates. Otherwise, returns only current (non-archived) certificates.

firstResultstring

A certificate to return at the top of the first page even if it does not match the other filters, or is archived. Intended for a selector that has to show the currently selected certificate whatever else it lists.

idsstring[]

Filters the certificates using the specified ids.

orderBystring

The order to return current certificates in: Expiry (the default, soonest to expire first) or Created (most recently added first). Ignored when Archived is true, since archived certificates are always returned most recently archived first. An unrecognised value is treated as Expiry.

searchstring

Filters the certificates using the specified fragment, matched against each certificate's name, subject and thumbprint.

skipinteger required

Number of items to skip. Defaults to zero

takeinteger required

Number of items to take. Defaults to 30

tenantstring

Filters the certificates to those the specified Tenant can use, honouring both direct tenant links and tenant tags.

Response

Success

ItemsPerPageinteger
ItemTypestring
LastPageNumberinteger
NumberOfPagesinteger
TotalResultsinteger