Get cluster SSL certificate details
This page will soon be available only on the dedicated Dynatrace Managed Documentation site. Update your bookmarks.
This API call retrieves cluster SSL certificate details.
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.
Endpoint
/api/v1.0/onpremise/sslCertificate
Parameter
Parameter | Type | Description | In | Required |
---|---|---|---|---|
entityType | string | entity type, possible values = "SERVER, COLLECTOR"
| 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 | SSLDetails | Success |
500 | - | Internal server error. |
Response body objects
The SSLDetails
object
Element | Type | Description |
---|---|---|
customKeyStore | boolean | - |
customKeyStoreWritable | boolean | - |
default | boolean | - |
expirationDate | string | - |
inProgress | boolean | - |
issuer | string | - |
restartRequired | boolean | - |
subject | string | - |
Response body JSON model
1{2 "customKeyStore": true,3 "customKeyStoreWritable": true,4 "default": true,5 "expirationDate": "string",6 "inProgress": true,7 "issuer": "string",8 "restartRequired": true,9 "subject": "string"10}
Example
In this example, you check the SSL certificate details on 32
node of the myManaged.cluster.com
cluster. In return you receive information on current SSL certificate.
Curl
1curl -X GET "https://myManaged.cluster.com/api/v1.0/onpremise/sslCertificate/SERVER/32" -H "accept: application/json" -H "Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890"
Request URL
1https://myManaged.cluster.com/api/v1.0/onpremise/sslCertificate/SERVER/32
Response body
1{2 "issuer": "EV SSL Intermediate CA RSA",3 "subject": "n32.myManaged.cluster.com",4 "expirationDate": 1615956886000,5 "customKeyStore": false,6 "customKeyStoreWritable": true,7 "inProgress": false,8 "restartRequired": false,9 "default": false10}
Response code
200