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

Parameter
Type
Description
In
Required
entityType
string

entity type, possible values = "COLLECTOR"

  • COLLECTOR
  • SERVER
path
required
entityId
integer

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

path
required

Response

Response codes

Code
Type
Description
200

Successful or in progress

400

Incorrect entity type

404

Status not found

500
-

Internal error

522

Certificate chain is invalid

523

Private key does not match public key certificate

525

Public key certificate is invalid

526

Private key is invalid

527

Error while storing SSL certificate

528

Certificate has been stored but has not been refreshed

529

Internal error

Response body objects

The CertificateStoreStatus object

Element
Type
Description
certificateStoreStatus
string
-
  • 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
detailedError
string
-

Response body JSON model

{
  "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

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

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

Response body

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

Response code

200