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": {
    }
}

List User Supplied TLS Certificates

Retrieve a list of TLS certificates that were uploaded to Cycle.

Requires the dns-certs-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 TLS certificate.

default

General error response from the platform

get/v1/dns/tls/certificates/user-supplied
Response samples
application/json
{
  • "data": [
    ]
}

Upload User Supplied TLS Certificate

Upload a user-supplied TLS certificate to the hub. This TLS certificate can be utilized by LINKED records matching the specified domains.

Requires the dns-manage capability.

SecuritybearerAuth and hubAuth
Request
Request Body schema: application/json

Parameters for creating a new TLS certificate.

private_key
required
string

The certificate's private key.

bundle
required
string

A PEM encoded certificate bundle.

Responses
201

Returns a TLS certificate.

default

General error response from the platform

post/v1/dns/tls/certificates/user-supplied
Request samples
application/json
{
  • "private_key": "string",
  • "bundle": "string"
}
Response samples
application/json
{
  • "data": {
    }
}

Get User Supplied TLS Certificate

Gets a list of custom TLS certificates uploaded to the hub.

Requires the dns-certs-view capability.

SecuritybearerAuth and hubAuth
Request
path Parameters
certificateId
required
string

The ID of the TLS certificate.

Responses
200

Returns a TLS certificate.

default

General error response from the platform

get/v1/dns/tls/certificates/user-supplied/{certificateId}
Response samples
application/json
{
  • "data": {
    }
}

Create User Supplied TLS Certificate Job

Used to perform different actions on a given user supplied TLS certificate.

Requires the dns-manage capability.

SecuritybearerAuth and hubAuth
Request
path Parameters
certificateId
required
string

The ID of the TLS certificate.

Request Body schema: application/json

Parameters for creating a new TLS certificate job.

action
required
string

The action that the job will take.

deprecate: Cycle will deprecate this certificate, and try to find another usable certificate. If none exists, it will generate a new one for the applicable domains.

Value: "deprecate"
Responses
202

Returns a job descriptor.

default

General error response from the platform

post/v1/dns/tls/certificates/user-supplied/{certificateId}/tasks
Request samples
application/json
{
  • "action": "deprecate"
}
Response samples
application/json
{
  • "data": {
    }
}
➔ Next to Environments