logo

TLS

Endpoints related to TLS certificate generation.

List TLS Generation Attempts

Requires the dns-view capability.

SecuritybearerAuth and hubAuth
Request
query Parameters
object

Filter Field

The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.

sort
Array of strings

An array of sort values. To sort descending, put a - in front of the value, e.g. -id.

object

In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be page[size]=20&page[number]=2

Responses
200

Returns a list of TLS certificate generation attempts.

default

General error response from the platform

get/v1/dns/tls/attempts
Response samples
application/json
{
  • "data": [
    ]
}

Lookup TLS Certificate

Lookup and retrieve a TLS certificate bundle for a specified domain.

Requires the dns-view capability.

SecuritybearerAuth and hubAuth
Request
query Parameters
domain
required
string

The domain to lookup.

wildcard
boolean

Whether or not to lookup a *. wildcard certificate that would be applicable for this domain. For example, if you are looking for a certificate for x.test.com, setting this to true will identify a *.test.com certificate that would also be applicable.

Responses
200

Returns a TLS certificate bundle.

default

General error response from the platform

get/v1/dns/tls/certificates/lookup
Response samples
application/json
{
  • "data": {
    }
}
➔ Next to Environments