Certificates

Gets information about the specified certificate.

get/certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint})

Path parameters

thumbprintAlgorithmstring required

The algorithm used to derive the thumbprint parameter. This must be sha1.

thumbprintstring required

The thumbprint of the certificate to get.

Query parameters

$selectstring

An OData $select clause.

timeoutinteger

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.

api-versionstring required

Client API Version.

Headers

client-request-idstring uuid

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

return-client-request-idboolean

Whether the server should return the client-request-id in the response.

ocp-datestring date-time-rfc1123

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Response

A response containing the certificate.

thumbprintstring
thumbprintAlgorithmstring
urlstring
state'active' | 'deleting' | 'deleteFailed'

Values are:

active - The certificate is available for use in pools. deleting - The user has requested that the certificate be deleted, but the delete operation has not yet completed. You may not reference the certificate when creating or updating pools. deletefailed - The user requested that the certificate be deleted, but there are pools that still have references to the certificate, or it is still installed on one or more compute nodes. (The latter can occur if the certificate has been removed from the pool, but the node has not yet restarted. Nodes refresh their certificates only when they restart.) You may use the cancel certificate delete operation to cancel the delete, or the delete certificate operation to retry the delete.

stateTransitionTimestring date-time
previousState'active' | 'deleting' | 'deleteFailed'

Values are:

active - The certificate is available for use in pools. deleting - The user has requested that the certificate be deleted, but the delete operation has not yet completed. You may not reference the certificate when creating or updating pools. deletefailed - The user requested that the certificate be deleted, but there are pools that still have references to the certificate, or it is still installed on one or more compute nodes. (The latter can occur if the certificate has been removed from the pool, but the node has not yet restarted. Nodes refresh their certificates only when they restart.) You may use the cancel certificate delete operation to cancel the delete, or the delete certificate operation to retry the delete.

previousStateTransitionTimestring date-time

This property is not set if the certificate is in its initial Active state.

publicDatastring

Changes