Skip to content

Request an ACME-issued SSL certificate.

POST
/v1/projects/{projectId}/lb/ssl-certificates/actions/request
Code sample: Shell / cURL
curl --request POST \
--url https://stratum.example.com/v1/projects/example/lb/ssl-certificates/actions/request \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "name": "example", "domainNames": [ "example" ] }'

Slice B. Asynchronous, ACM-shaped. Records an ACME order; the leader-only order worker proves control of each domain via DNS-01 against the project’s hosted zone, stores the issued material in OpenBao, and creates a regular ssl-certificate (issuer=acme, state=active) on success. Poll the returned order for progress; failures carry stateReason. Certificates renew automatically ahead of expiry. Every requested domain must be covered by an active public hosted zone in the project.

projectId
required
string
/^p-[a-z0-9-]+$/
Media typeapplication/json
object
name
required

Becomes the issued certificate’s name.

string
domainNames
required

Fully qualified names the certificate covers (the first is the subject CN). Each must sit under an active public hosted zone in the project. Wildcards are not supported yet.

Array<string>
>= 1 items

Example generated

{
"name": "example",
"domainNames": [
"example"
]
}

Order accepted.

Media typeapplication/json

One asynchronous ACME issuance request (Slice B).

object
id
required
string
/^ord-[a-z0-9]+$/
projectId
required
string
name
required
string
domainNames
required
Array<string>
state
required
string
Allowed values: pending issued failed
stateReason

Last failure detail; set while retrying and on terminal failure.

string
certificateId

The issued ssl-certificate id (state=issued only).

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

Example

{
"state": "pending"
}

Bad request.

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"
}
]
}

Quota exceeded.

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"
}
]
}