Skip to content
StratumStratum Docs

Describe an SSL certificate.

GET
/v1/projects/{projectId}/lb/ssl-certificates/{certificateId}
Code sample: Shell / cURL
curl --request GET \
  --url https://stratum.example.com/v1/projects/example/lb/ssl-certificates/example \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
projectId
required
string
/^p-[a-z0-9-]+$/
certificateId
required
string
/^cert-[a-z0-9]+$/

Responses

Section titled “Responses”

200

Section titled “200”

The certificate.

Media typeapplication/json

An SSL/TLS certificate for HTTPS listeners. Only metadata is returned; the cert + key material lives in OpenBao and is never surfaced over the API.

object
id
required
string
/^cert-[a-z0-9]+$/
projectId
required
string
name
required
string
issuer
required

How the certificate was obtained (uploaded vs ACME-issued).

string
Allowed values: manual acme
domainNames
required

The SNI match set (SANs, or the common name).

Array<string>
notBefore
string format: date-time
notAfter
string format: date-time
state
required
string
autoRenew

Whether Stratum renews this certificate automatically before expiry. True for ACME-issued certs (the leader sweep re-obtains them); false for uploaded (manual) certs, which the operator must rotate themselves.

boolean
renewsAt

When an auto-renewing certificate becomes due for renewal — one renewal window (30d) before notAfter. Present only for ACME certs with a known validity; absent for manual certs.

string format: date-time
createdAt
required
string format: date-time
updatedAt
string format: date-time
createdBy
string

Example 

{
  "issuer": "manual"
}

404

Section titled “404”

Resource not found.

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
>= 400 <= 599
detail
string
instance
string format: uri-reference
requestId
required
string
code
required
string
issues

The findings of a rejected IAM policy document (custom and resource policies).

Array<object>

One finding of a rejected IAM policy document. A rejection lists every finding, so the author fixes the document in one round trip.

object
code
required

The finding, e.g. INVALID_DOCUMENT, UNKNOWN_ACTION, ACTION_NOT_APPLICABLE.

string
statement
required

Index of the statement at fault; -1 for the document as a whole.

integer
>= -1
detail
required
string
action

The offending action, where one is at fault (ACTION_NOT_APPLICABLE).

string
errors

Field errors, for codes that carry them: each problem at its field (see FieldError). Documented on the responses that set it, e.g. approveNodeJoin’s INVALID_INPUT and JOIN_APPROVAL_REFUSED. Absent otherwise.

Array<object>

One field’s problem, the stage-2 installer API’s shape. field is the field’s path, message what is wrong with it.

object
field
required

The field’s path, e.g. links[0].interface, disks[1].confirm, mgmt.address or role; empty for the whole request.

string
message
required
string
details

Structured facts about the refusal, for codes that carry them. The shape is fixed per code and documented on the response that answers it, e.g. IMAGE_POOL_MISMATCH (see ImagePoolMismatchDetails) and IMAGE_IN_USE. Absent for codes that carry none.

object
key
additional properties
any

Example 

{
  "issues": [
    {
      "code": "ACTION_NOT_APPLICABLE",
      "action": "compute:CreateVpc"
    }
  ]
}