SSL/TLS

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

List SSL Certificates

get

Retrieve a paginated list of SSL certificates for the specified organization. You can filter by certificate name or common name.

Authorizations
Path parameters
organization_uuidstringRequired

Unique identifier of the organization.

Example: 123e4567-e89b-12d3-a456-426614174000
Query parameters
ssl_namestringOptional

Filter by SSL certificate name or description.

common_namestringOptional

Filter by common name of the SSL certificate.

sort_fieldstring · enumOptional

Field to sort results by.

Default: created_atPossible values:
sortstring · enumOptional

Sort order for results.

Default: descPossible values:
pageintegerOptional

Page number for pagination.

Default: 1
per_pageintegerOptional

Number of items per page.

Default: 24
Responses
200

List of SSL certificates retrieved successfully.

application/json
Responseobject
get
/api/v1/ssl/{organization_uuid}/
GET /api/v1/ssl/{organization_uuid}/ HTTP/1.1
Host: cloud.medianova.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{}

Create SSL Certificate

post

Upload and register a new SSL certificate for the specified organization. You can use a custom certificate or an auto-generated Let's Encrypt certificate.

Authorizations
Path parameters
organization_uuidstringRequired

Unique identifier of the organization.

Example: 123e4567-e89b-12d3-a456-426614174000
Body
objectOptional
Responses
200

SSL certificate created successfully.

application/json
Responseobject
post
/api/v1/ssl/{organization_uuid}/
POST /api/v1/ssl/{organization_uuid}/ HTTP/1.1
Host: cloud.medianova.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
{}

Update SSL Certificate

put

Update an existing SSL certificate’s information, such as name or key details, for the specified organization.

Authorizations
Path parameters
organization_uuidstringRequired

Unique identifier of the organization.

ssl_uuidstringRequired

Unique identifier of the SSL certificate.

Body
objectOptional
Responses
200

SSL certificate updated successfully.

application/json
Responseobject
put
/api/v1/ssl/{organization_uuid}/{ssl_uuid}/
PUT /api/v1/ssl/{organization_uuid}/{ssl_uuid}/ HTTP/1.1
Host: cloud.medianova.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
{}

Delete SSL Certificate

delete

Remove an SSL certificate from the specified organization.

Authorizations
Path parameters
organization_uuidstringRequired

Unique identifier of the organization.

ssl_uuidstringRequired

Unique identifier of the SSL certificate.

Responses
200

SSL certificate deleted successfully.

application/json
delete
/api/v1/ssl/{organization_uuid}/{ssl_uuid}/
DELETE /api/v1/ssl/{organization_uuid}/{ssl_uuid}/ HTTP/1.1
Host: cloud.medianova.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "status": true,
  "message": "text"
}

Initiate Let's Encrypt DNS Challenge

post

Start the DNS-based verification process for issuing a Let's Encrypt SSL certificate. The response includes the required CNAME record details.

Authorizations
Path parameters
organization_uuidstringRequired

Unique identifier of the organization.

Body
objectOptional
Responses
200

DNS challenge initiated successfully.

application/json
post
/api/v1/ssl/{organization_uuid}/lets-encrypt/initiate-dns-verification/
POST /api/v1/ssl/{organization_uuid}/lets-encrypt/initiate-dns-verification/ HTTP/1.1
Host: cloud.medianova.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
{
  "status": true,
  "data": {
    "cname_host": "text",
    "cname_target": "text"
  },
  "operation_id": "text"
}

Finalize Let's Encrypt SSL Creation

post

Complete the Let's Encrypt SSL certificate creation after DNS verification has succeeded.

Authorizations
Path parameters
organization_uuidstringRequired

Unique identifier of the organization.

Body
objectOptional
Responses
200

Let's Encrypt SSL certificate created successfully.

application/json
post
/api/v1/ssl/{organization_uuid}/lets-encrypt/finalize-ssl-creation/
POST /api/v1/ssl/{organization_uuid}/lets-encrypt/finalize-ssl-creation/ HTTP/1.1
Host: cloud.medianova.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
{
  "status": true,
  "data": {
    "message": "text",
    "uuid": "text"
  },
  "operation_id": "text"
}

Last updated

Was this helpful?