Request a Let's Encrypt Certificate for a legacy domain

POST

/installs/{install_id}/domains/{domain_id}/ssl_certificate

Submits a request for a Let’s Encrypt Certificate for a given domain on an install. This is for domains on the legacy network.

Authorizations

• basicAuth

Parameters

Path Parameters

install_id

required

string format: uuid

ID of install

domain_id

required

string format: uuid

ID of domain

Request Body

Properties

• email_address - required - The certificate’s holder’s email address
• given_name - required - The certificate holder’s first / given name
• family_name - required - The certificate holder’s last / family name
• region_code - required - The two-letter ISO 3166-1 alpha-2 code for the certificate’s country
• state - optional - The certificate’s state / region
• city - optional - The certificate’s city / locality
• phone - optional - The certificate holder’s phone number

object

email_address

required

The certificate’s holder’s email address

string

Example

jane@example.com

given_name

required

The certificate holder’s first / given name

string

Example

Jane

family_name

required

The certificate holder’s last / family name

string

Example

Doe

region_code

required

The two-letter ISO 3166-1 alpha-2 code for the certificate’s country

string

Example

US

state

The certificate’s state/region

string

Example

Texas

city

The certificate’s city/locality

string

Example

Austin

phone

The certificate holder’s phone number

string

Example

800-123-4567

Responses

202

Accepted. Order has been accepted for processing.

401

Authentication Error

object

message

required

A message regarding the error that occurred on the server

string

Example

Bad Credentials

documentation_url

(Optional) A URL where documentation regarding this specific error can be found

string

403

Not authorized

object

message

required

A message regarding the error that occurred on the server

string

Example

You don't have permission to perform that action

documentation_url

(Optional) A URL where documentation regarding this specific error can be found

string

404

Not found

object

message

required

A message regarding the error that occurred on the server

string

Example

Not Found

documentation_url

(Optional) A URL where documentation regarding this specific error can be found

string

429

Too many requests

500

Internal server error

object

message

required

A message regarding the error that occurred on the server

string

Example

An unexpected error occurred, please try again in a few minutes

503

Service unavailable