List Certificates

Overview

Retrieves all certificates for a specified project. Certificates are used for SSL/TLS encryption and authentication.

Endpoint

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

Authentication

Requires a Personal API Access Token.

Authorization: Bearer YOUR_TOKEN

Request

Headers

Header Value Required
Authorization Bearer {token} Yes

Path Parameters

Parameter Type Required Description
projectName string Yes Project name

Query Parameters

None.

Response

Success Response (200 OK)

{
  "success": true,
  "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

Field Type Description
success boolean Indicates if the request was successful
resultList array[object] List of certificates

Certificate Object

Field Type Description
name string Certificate name
description string Certificate description
certificateEnvironmentList array[object] List of certificate environments. See Certificate Environment Object

Certificate Environment Object

Field Type Description
environmentName string Environment name where certificate is deployed
startDate string Certificate start date in ISO 8601 format
endDate string Certificate expiration date in ISO 8601 format
base64EncodedContent string Base64-encoded certificate content
sha1Thumbprint string SHA-1 thumbprint of the certificate
subjectDn string Subject Distinguished Name (DN) of the certificate
alias string Certificate 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)

{
  "error": "unauthorized_client",
  "error_description": "Invalid token"
}

Error Response (404 Not Found)

{
  "error": "not_found",
  "error_description": "Project(MyProject) was not found or user does not have privilege to access it!"
}

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:
    • Requires ROLE_MANAGE_PROXIES permission
    • User must have access to the project