View S3 certificate details by using the UI

To view the expiration date and status of the S3 certificate, on the IBM Cloud console, go to IBM Storage Ceph as a Service > Settings.

Here, you can view the S3 certificate expiration date and status.

Retrieve list of configured certificates

You can retrieve the list of configured certificates by using the CLI command cert-types.

ibmcloud software-defined-storage cert-types --url string

See following command example.

ibmcloud software-defined-storage cert-types s3 --url $sds_endpoint
...

Certificates   [s3]

The $sds_endpoint is an environment variable that points to the endpoint provided to you when IBM Storage Ceph as a Service was configured. It is in the URL form. For example, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1. You can set the URL once and then not have to add it for every command. For guidance on how to set the URL, see Config commands.

You can also use the alias sds as an alternative to software-defined-storage and crtt as an alternative to cred-types for the CLI actions.

Retrieving S3 certificate status using the CLI

Use the cert command along with certificate type --cert-type CERT-TYPE option to retrieve and view the SSL Certificates expiration date and its status.

Run the following command and ensure that you have provided the endpoint url.

ibmcloud software-defined-storage cert --cert-type CERT-TYPE --url string

See the following example.

ibmcloud software-defined-storage cert --cert-type s3 --url $sds_endpoint
...

Name             s3
ExpirationDate  "2024-08-13T05:23:42Z"
Expired          false

The $sds_endpoint is an environment variable that points to the endpoint provided to you when IBM Storage Ceph as a Service was configured. It is in the URL form. For example, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1. You can set the URL once and then not have to add it for every command. For guidance on how to set the URL, see Config commands.

You can also use the alias sds as an alternative to software-defined-storage for the CLI actions.

Retrieve list of configured certificates with the API

Make Get /certificates to retrieve the list of configured certificates.

curl -X GET $sds_endpoint/certificates -H "accept: application/json" -H "Authorization: Bearer $IAM_TOKEN" -H "IBM-API-Version: 2025-02-01"

Example of a successful response.

curl -X GET $sds_endpoint/certificates -H "accept: application/json" -H "Authorization: Bearer $IAM_TOKEN" -H 'IBM-API-Version: 2025-01-15'
...
{
  "certificates": [
    "s3"
  ]
}

The $sds_endpoint is an environment variable that points to the endpoint provided to you when IBM Storage Ceph as a Service was configured. It is in the URL form. For example, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1. You can set the URL once and then not have to add it for every command. For guidance on how to set the URL, see Config commands.

See Setting up your CLI and API environment for instructions on how to set the $IAM_TOKEN variables.

Retrieve S3 certificate status with the API

Make a GET /certificates/{cert_type} to retrieve the S3 certificate expiration date and status.

curl -X GET $sds_endpoint/certificates/s3 -H "accept: application/json" -H "Authorization: Bearer $IAM_TOKEN" -H 'IBM-API-Version: 2025-02-01'

A successful response looks like this:

{
  "name": "s3",
  "expiration_date": "2035-02-04T08:33:04Z",
  "expired": false
}

Example of a response when there is no certificate available:

curl -X GET $sds_endpoint/certificates/s3 -H 'accept: application/json'  -H "Authorization: Bearer $IAM_TOKEN" -H 'IBM-API-Version: 2025-01-15'
...

{
  "name": "s3",
  "expiration_date": "",
  "expired": false
}

Use this API call to learn when the S3 certificate is about to expire and update them before they expire, so that it does not affect the I/O usage. You can automate the expiry notification process within your environment to prevent an outage.

The $sds_endpoint is an environment variable that points to the endpoint provided to you when IBM Storage Ceph as a Service was configured. It is in the URL form. For example, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1. You can set the URL once and then not have to add it for every command. For guidance on how to set the URL, see Config commands.

See Setting up your CLI and API environment for instructions on how to set the $IAM_TOKEN variables.