Link Search Menu Expand Document

Overview

Get a List of Certificates in a user’s subscription

Authorization

Include an API Key as a query string parameter in the request URL

Request URL

https://rclapi.azure-api.net/v2/stand-alone/certificate/list?api-key={apikey}

Method

GET

Request Parameters

Name In Required Type Description
api-key query true string The user’s API Key for the subscription

Response

Name Type Description
200 OK List of Certificate The response body contains a List of Certificate objects

Sample Response

200 OK

[{
    "id": 233,
    "name": "shopeneur.com",
    "issueDate": "2021-08-31T12:11:51.9405833+00:00",
    "expiryDate": "2021-11-29T12:11:51.9405842+00:00",
    "remoteCreateDate": null,
    "remoteCreate": "",
    "target": "Stand ALone",
    "renewal": "Manual",
    "pemUri": "https://rclstrgdev.blob.core.windows.net/pem/cert%2F46217",
    "pfxUri": "https://rclstrgdev.blob.core.windows.net/pem/cert%2F46217",
    "crtUri": "https://rclstrgdev.blob.core.windows.net/pem/cert%2F46217",
    "cerUri": "https://rclstrgdev.blob.core.windows.net/pem/cert%2F46217",
    "privateKeyUri": "https://rclstrgdev.blob.core.windows.net/pem/cert%2F",
    "certificateUri": "https://rclstrgdev.blob.core.windows.net/pem/cert%2F",
    "intermediateCertificateUri": "https://rclstrgdev.blob.core.windows.net/pem/cert%2F",
    "fullChainCertificateUri": "https://rclstrgdev.blob.core.windows.net/pem/cert%2F462",
    "pfxpwd": "pwd1234"
}]

Definitions

Certificate

Certificate Object

Name Type Required Description
id int yes The unique id of the Certificate
name string yes The name (hostname) of the Certificate
issueDate string yes The date the certificate was issued
expiryDate string yes The expiry date of the certificate
remoteCreateDate string yes The date the certificate was installed in a server
remoteCreate string yes The identifier for the server the certificate was installed in
target string yes The classification for the certificate : “Stand ALone”
renewal string yes The renewal type of the certificate : “Manual”
pemUri string yes The link to download the .pem certificate
pfxUri string yes The link to download the .pfx certificate
crtUri string yes The link to download the .crt certificate
cerUri string yes The link to download the .cer certificate
privateKeyUri string yes The link to download the certificate private key
certificateUri string yes The link to download the primary certificate (.crt) file
intermediateCertificateUri string yes The link to download the intermediate certificate (.crt) file
fullChainCertificateUri string yes The link to download the full chain certificate (.crt) file
pfxpwd string yes The password for the .pfx certificate

Error

Name Code Description
Bad Request 400 Error details will be included as a string in the body of the response
Not Found 404 No Certificates were not found in the user’s subscription

Test the API

Note: Authorization in the Header is not supported for this API. Leave the authorization blank when testing. Use the API Key in the url parameter instead.

Test the API in the Developer’s Portal