• Home
  • Dynatrace Managed
  • Cluster API
  • Cluster API v1
  • SSL certificates v1
  • Get cluster SSL certificate storage status

Get cluster SSL certificate storage status

This API call retrieves the cluster SSL certificate storage status.

Authentication

To execute this request, you need the Service Provider API (ServiceProviderAPI) permission assigned to your API token. Generate your API token via Cluster Management Console (CMC). To learn how to obtain and use it, see Cluster API - Authentication.

BAD_REQUEST

The certificate storage status is only available in runtime during the certificate update or upload. Once the certificate is uploaded and the node restarted, this API call will return BAD_REQUEST because no storage status is availabile.

Endpoint

/api/v1.0/onpremise/sslCertificate/store

Parameter

ParameterTypeDescriptionInRequired
entityTypestring

entity type, possible values = "COLLECTOR"

The element can hold these values
  • COLLECTOR
  • SERVER
pathrequired
entityIdinteger

Node ID, which can be extracted from the URL in 'Node details' view.

pathrequired

Response

Response codes

CodeTypeDescription
200CertificateStoreStatus

Successful or in progress

400CertificateStoreStatus

Incorrect entity type

404CertificateStoreStatus

Status not found

500

Internal error

522CertificateStoreStatus

Certificate chain is invalid

523CertificateStoreStatus

Private key does not match public key certificate

525CertificateStoreStatus

Public key certificate is invalid

526CertificateStoreStatus

Private key is invalid

527CertificateStoreStatus

Error while storing SSL certificate

528CertificateStoreStatus

Certificate has been stored but has not been refreshed

529CertificateStoreStatus

Internal error

Response body objects

The CertificateStoreStatus object

ElementTypeDescription
certificateStoreStatusstring-
The element can hold these values
  • BAD_REQUEST
  • CERTIFICATE_CHAIN_IS_INVALID
  • CERTIFICATE_IS_EXPIRED
  • CERTIFICATE_STORED_BUT_NOT_REFRESHED
  • ERROR
  • GENERAL_ERROR_WHILE_STORING_CERTIFICATE
  • IN_PROGRESS
  • NOT_FOUND
  • OK
  • PRIVATE_KEY_DOES_NOT_MATCH_PUBLIC_KEY_CERTIFICATE
  • PRIVATE_KEY_IS_INVALID
  • PUBLIC_KEY_CERTIFICATE_IS_INVALID
detailedErrorstring-

Response body JSON model

json
{
  "certificateStoreStatus": "BAD_REQUEST",
  "detailedError": "string"
}

Example

In this example, you check the SSL certificate storage status on 32 node of the myManaged.cluster.com cluster. In return you receive information on SSL certificate storage status indicating that the SSL certificate has been successfully stored.

Curl

bash
curl -X GET "https://myManaged.cluster.com/api/v1.0/onpremise/sslCertificate/store/SERVER/32" -H  "accept: application/json" -H  "Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890"

Request URL

plaintext
https://myManaged.cluster.com/api/v1.0/onpremise/sslCertificate/store/SERVER/32

Response body

json
{
  "certificateStoreStatus": "Successful",
  "detailedError": null
}

Response code

200