SSL/TLS

Manage SSL and TLS certificates, Let's Encrypt integrations, and certificate lifecycle operations through the Security API.

Use these endpoints to manage SSL/TLS certificates for your organization. You can upload custom certificates or issue certificates through Let’s Encrypt.

List SSL/TLS Certificates

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organization_uuidanyRequired

Unique identifier of the organization.

Query parameters
ssl_nameany ofOptional

Filters results by SSL name.

stringOptional
or
nullOptional
common_namestringOptional

Filters results by common name.

sort_fieldall ofOptional

Field to sort by.

Default: created_at
string · enumOptionalPossible values:
sortall ofOptional

Sort order.

Default: desc
string · enumOptionalPossible values:
pageintegerOptional

Page number.

Default: 1
per_pageintegerOptional

Number of items per page.

Default: 24
Responses
200

Returns a paginated list of SSL/TLS certificates.

application/json
get
/api/v1/ssl/{organization_uuid}/

Create SSL/TLS Certificate

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organization_uuidanyRequired

Unique identifier of the organization.

Body

Create SSL/TLS certificate.

ssl_namestring · min: 3 · max: 55Required

Certificate name.

ssl_crtstringRequired

Certificate (PEM).

ssl_passany ofRequired

Private key password, if applicable.

stringOptional
or
nullOptional
ssl_keystringRequired

Private key (PEM).

Responses
200

Returns the created SSL/TLS certificate.

application/json
post
/api/v1/ssl/{organization_uuid}/

Update SSL/TLS Certificate

put
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organization_uuidanyRequired

Unique identifier of the organization.

ssl_uuidanyRequired

Unique identifier of the SSL/TLS certificate.

Body

Update SSL/TLS certificate.

ssl_nameany ofRequired

Certificate name.

stringOptional
or
nullOptional
ssl_crtstringRequired

Certificate (PEM).

ssl_passany ofRequired

Private key password, if applicable.

stringOptional
or
nullOptional
ssl_keystringRequired

Private key (PEM).

Responses
200

Returns the updated SSL/TLS certificate.

application/json
put
/api/v1/ssl/{organization_uuid}/{ssl_uuid}/

Delete SSL/TLS Certificate

delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organization_uuidanyRequired

Unique identifier of the organization.

ssl_uuidanyRequired

Unique identifier of the SSL/TLS certificate.

Responses
200

Returns a confirmation indicating that the certificate was deleted.

application/json
delete
/api/v1/ssl/{organization_uuid}/{ssl_uuid}/

Let’s Encrypt

Use these endpoints to issue an SSL/TLS certificate through Let’s Encrypt. Complete the DNS verification step before finalizing the certificate.

Initiate Let’s Encrypt DNS Verification

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organization_uuidstringRequired

Unique identifier of the organization.

Body

Certificate generation request.

domainstringRequired

Domain name to validate.

Responses
200

Returns DNS challenge records required for verification.

application/json
post
/api/v1/ssl/{organization_uuid}/lets-encrypt/initiate-dns-verification/

Finalize Let’s Encrypt Certificate Creation

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organization_uuidstringRequired

Unique identifier of the organization.

Body

Finalize certificate creation request.

ssl_namestring · min: 3 · max: 55Required

Certificate name.

domainstringRequired

Domain name to issue the certificate for.

cname_targetstring · min: 3 · max: 255Required

CNAME target value returned from DNS verification.

Responses
200

Returns the created certificate identifier.

application/json
post
/api/v1/ssl/{organization_uuid}/lets-encrypt/finalize-ssl-creation/

Last updated

Was this helpful?