List CA certificates

GET

/api/v1/ca-certificates

const url = 'http://localhost:3000/api/v1/ca-certificates?limit=20&offset=0&isRoot=true&isDefault=true&includeRetired=false';
const options = {method: 'GET', headers: {'X-API-Key': '<X-API-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'http://localhost:3000/api/v1/ca-certificates?limit=20&offset=0&isRoot=true&isDefault=true&includeRetired=false' \
  --header 'X-API-Key: <X-API-Key>'

Retrieves a paginated list of CA certificates for the organization.

Authorizations

api-key
bearer

Parameters

Query Parameters

limit

number

default: 20 >= 1 <= 100

Maximum number of CA certificates to return

offset

number

Number of CA certificates to skip

cursor

string format: uuid

Cursor for pagination (CA certificate ID)

isRoot

boolean

Example

true

Filter by root CA status

isDefault

boolean

Example

true

Filter by default signing CA status

includeRetired

boolean

Example

false

Include retired CA certificates

Responses

200

List of CA certificates retrieved successfully

application/json

object

data

required

List of CA certificates

Array<object>

object

required

Unique CA certificate identifier (UUID)

string format: uuid

name

required

Human-readable name for the CA certificate

string

fingerprint

required

SHA-256 fingerprint of the certificate

string

isRoot

required

Whether this is a root CA certificate

boolean

isDefault

required

Whether this is the default signing CA

boolean

notBefore

required

Certificate validity start date

string format: date-time

notAfter

required

Certificate validity end date (expiration)

string format: date-time

retiredAt

Date when the CA certificate was retired

string format: date-time

createdAt

required

Timestamp when the CA certificate was created

string format: date-time

subject

Full subject distinguished name

string

issuer

Full issuer distinguished name

string

serialNumber

Certificate serial number (hex)

string

keyAlgorithm

Public key algorithm and size

string

signatureAlgorithm

Signature algorithm

string

subjectAltNames

Subject Alternative Names

Array<string>

certificate

PEM-encoded public certificate (safe to share)

string

total

required

Total number of CA certificates

number

hasMore

required

Whether there are more results available

boolean

nextCursor

Cursor for the next page of results

string format: uuid

Example

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Production Root CA",
      "fingerprint": "A1:B2:C3:D4:E5:F6:A1:B2:C3:D4:E5:F6:A1:B2:C3:D4:E5:F6:A1:B2:C3:D4:E5:F6:A1:B2:C3:D4:E5:F6:A1:B2",
      "isRoot": true,
      "isDefault": true,
      "notBefore": "2024-01-01T00:00:00Z",
      "notAfter": "2034-01-01T00:00:00Z",
      "retiredAt": "2024-06-01T00:00:00Z",
      "createdAt": "2024-01-01T00:00:00Z",
      "subject": "CN=Root CA, O=logiccloud, C=US",
      "issuer": "CN=Root CA, O=logiccloud, C=US",
      "serialNumber": "01:AB:CD:EF",
      "keyAlgorithm": "RSA-4096",
      "signatureAlgorithm": "SHA256withRSA",
      "subjectAltNames": [
        "DNS:example.com",
        "IP:192.168.1.1"
      ],
      "certificate": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----"
    }
  ],
  "total": 5,
  "hasMore": false,
  "nextCursor": "550e8400-e29b-41d4-a716-446655440001"
}

401

Unauthorized - Invalid or missing authentication

403

Forbidden - Insufficient permissions