Ana içeriğe geç

List Certificates

Endpoint​

GET /apiops/projects/{projectName}/certificates/

Authentication​

Requires a Personal API Access Token.

Authorization: Bearer YOUR_TOKEN

Request​

Headers​

HeaderValueRequired
AuthorizationBearer {token}Yes

Path Parameters​

ParameterTypeRequiredDescription
projectNamestringYesProject name

Query Parameters​

None.

Response​

Success Response (200 OK)​

{
"status": "SUCCESS",
"resultList": [
{
"name": "my-certificate",
"description": "SSL certificate for API",
"certificateEnvironmentList": [
{
"environmentName": "production",
"startDate": "2024-01-01T00:00:00.000Z",
"endDate": "2025-12-31T23:59:59.000Z",
"base64EncodedContent": "MIIFXTCCBEWgAwIBAgIQ...",
"sha1Thumbprint": "A1B2C3D4E5F6G7H8I9J0K1L2M3N4O5P6Q7R8S9T0",
"subjectDn": "CN=example.com, O=Example Inc, C=US",
"alias": "my-cert-alias"
},
{
"environmentName": "staging",
"startDate": "2024-01-01T00:00:00.000Z",
"endDate": "2025-12-31T23:59:59.000Z",
"base64EncodedContent": "MIIFXTCCBEWgAwIBAgIQ...",
"sha1Thumbprint": "A1B2C3D4E5F6G7H8I9J0K1L2M3N4O5P6Q7R8S9T0",
"subjectDn": "CN=example.com, O=Example Inc, C=US",
"alias": "my-cert-alias"
}
]
}
]
}

Response Fields​

FieldTypeDescription
statusstringResponse status: SUCCESS or FAILURE
resultListarray[object]List of certificates

Certificate Object​

FieldTypeDescription
namestringCertificate name
descriptionstringCertificate description
certificateEnvironmentListarray[object]List of certificate environments. See Certificate Environment Object

Certificate Environment Object​

FieldTypeDescription
environmentNamestringEnvironment name where certificate is deployed
startDatestringCertificate start date in ISO 8601 format
endDatestringCertificate expiration date in ISO 8601 format
base64EncodedContentstringBase64-encoded certificate content
sha1ThumbprintstringSHA-1 thumbprint of the certificate
subjectDnstringSubject Distinguished Name (DN) of the certificate
aliasstringCertificate alias (unique per environment)

Notes​

  • Certificate content is base64-encoded
  • Each certificate can be deployed to multiple environments
  • Each environment has its own alias
  • Certificate file content is excluded from list response for performance

Error Response (401 Unauthorized)​

{
"status": "FAILURE",
"resultMessage": "Token is not valid!"
}

cURL Example​

curl -X GET \
"https://demo.apinizer.com/apiops/projects/MyProject/certificates/" \
-H "Authorization: Bearer YOUR_TOKEN"

Notes and Warnings​

  • Performance:

    • Certificate file content is excluded from list response
    • Use Get Certificate endpoint to retrieve full certificate details
  • Multiple Environments:

    • Certificates can be deployed to multiple environments
    • Each environment has separate certificate configuration
  • Alias Uniqueness:

    • Alias must be unique per environment
    • Same alias can be used in different environments

Permissions​

User must have any permission in the project (read access).