ByCloud Docs
GuidesCLIAPISDK
get/v1/certificates

List certificates

List all certificates in the current organization

Query Parameters

limit

integeroptional

query

Maximum number of items to return

Default: 20

Example: 20

marker

string<uuid>optional

query

ID of the last item from the previous page (for pagination)

Example: "550e8400-e29b-41d4-a716-446655440000"

status

stringoptional

query

Filter by certificate status

Enum: "pending_dns", "pending_issuance", "active", "expired", "error", "revoked"

Header Parameters

X-Region

stringrequired

header

Region code to query resources from. Required for all resource operations.

Example: "sao1"

Responses

200

List of certificates

Content-Type: application/json

certificates

arrayrequired

meta

objectrequired
401

Authentication required or token invalid

Content-Type: application/json

error

objectrequired
500

Internal server error

Content-Type: application/json

error

objectrequired
curl -X GET "https://api.spo1.mycloud.com/v1/certificates" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json"

Response

List of certificates

{
  "certificates": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "crn": "crn:sao1:certificate:certificate:550e8400-e29b-41d4-a716-446655440000",
      "name": "my-certificate",
      "type": "acme",
      "domains": [
        "example.com",
        "*.example.com"
      ],
      "status": "active",
      "expires_at": "2024-01-15T10:30:00Z",
      "renew_after": "2024-01-15T10:30:00Z",
      "error_message": "string",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    }
  ],
  "meta": {
    "total": 150,
    "limit": 20,
    "marker": "550e8400-e29b-41d4-a716-446655440000",
    "has_more": true
  }
}