Get SSL certificate information for a domain

GET

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

curl --request GET \
  --url https://api.wpengineapi.com/v1/installs/example/domains/example/ssl_certificate \
  --header 'Authorization: Basic <credentials>'

Returns certificate information for a given domain on an install

Authorizations

• basicAuth

Parameters

Path Parameters

install_id

required

string format: uuid

ID of install

domain_id

required

string format: uuid

ID of domain

Responses

200

Domain certificate information

Media type application/json

object

cert_name

The name of the certificate

string

cert_info

object

key

The private key of the certificate

string

cert

The certificate

string

certificate

object

id

The id of the certificate

integer

account

The account name of the owner of the certificate

string

auto_renew

Whether auto renew is enabled (true) or disabled (false)

boolean

auth_file

The auth file for the certificate

string

approver_email

The approver email for the certificate

string

common_name

The common name for the domain

string

cancel_time

The time when the certificate was cancelled

string

cert_source

The source of the certificate

string

Allowed values: CERT_SOURCE_UNSPECIFIED THIRD_PARTY LETS_ENCRYPT SELF_SIGNED

ordered_time

The time when the certificate was ordered

string

wildcard

A boolean flag that indicates if the certificate is for a wildcard domain

boolean

domains

A list of domains for the certificate

Array<string>

status

The current status of the certificate

string

Allowed values: SSL_STATE_UNSPECIFIED ENABLED DISABLED EXPIRED CANCELED REJECTED SUBMITTED

approved_time

The time the certificate was approved

string

expires_time

The time when the certificate expires

string

serial_number

The Certificate Serial Number as defined in the X.509 standard. Presented as a hexadecimal string.

string

criteria

The criteria of the certificate

string

Example

{
  "cert_name": "customdomain.com",
  "certificate": {
    "account": "myaccountname",
    "common_name": "customdomain.com",
    "cert_source": "CERT_SOURCE_UNSPECIFIED",
    "domains": [
      "customdomain.com",
      "www.customdomain.com"
    ],
    "status": "SSL_STATE_UNSPECIFIED",
    "serial_number": "18F662FB207C19E7841E8F41E6771BEE"
  }
}

401

Authentication Error

Media type application/json

object

message

required

A message regarding the error that occurred on the server

string

documentation_url

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

string

Example

{
  "message": "Bad Credentials"
}

403

Not authorized

Media type application/json

object

message

required

A message regarding the error that occurred on the server

string

documentation_url

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

string

Example

{
  "message": "You don't have permission to perform that action"
}

404

Not found

Media type application/json

object

message

required

A message regarding the error that occurred on the server

string

documentation_url

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

string

Example

{
  "message": "Not Found"
}

429

Too many requests

Media type application/json

503

Service unavailable

Media type application/json