API docs by Redocly

Certificate Manager Service API (1.0)

Download OpenAPI specification:Download

Using the Certificate Manager Service, you can conveniently provision and manage SSL certificates with IONOS services and your internal connected resources. For the Application Load Balancer, you usually need a certificate to encrypt your HTTPS traffic.

The service provides the basic functions of uploading and deleting your certificates for this purpose.

Information

These endpoints are for documentation and information purposes.

Get the Open API Documentation YAML

Displays the Open API documentation in the YAML format.

Authorizations:
basicAuthtokenAuth

Responses

Get the Open API Documentation JSON

Displays the Open API documentation in the JSON format.

Authorizations:
basicAuthtokenAuth

Responses

Response samples

Content type
application/json
"string"

Get the Service API Information

Retrieves the service API information.

Authorizations:
basicAuthtokenAuth

Responses

Response samples

Content type
application/json
{}

Certificates

SSL certificates are used to secure network communications and prove the identity of websites on the Internet and resources on private networks.

Get Certificates

Retrieves all available certificates.

Authorizations:
basicAuthtokenAuth
query Parameters
offset
string

'Limit' and 'Offset' are optional; you can use these filter parameters to retrieve only part of the results obtained by a request.

Offset is the first element (from the complete list of elements) to be included in the response.

limit
string

'Limit' and 'Offset' are optional; you can use these filter parameters to retrieve only part of the results of a query.

If both 'Offset' and 'Limit'are specified, the offset lines are skipped before counting the returned limit lines.

Responses

Response samples

Content type
application/json
{}

Add a New Certificate

Adds a new PEM (Privacy Enhanced Mail) file that is used to store SSL certificates and their associated private keys.

Authorizations:
basicAuthtokenAuth
Request Body schema: application/json
required
object (CertificatePostPropertiesDto)

Responses

Request samples

Content type
application/json
{
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "id": "63f766c7-3f85-4d83-b528-8ddeec5b436c",
  • "type": "certificate",
  • "href": "https://api.ionos.com/certificatemanager/certificates/63f766c7-3f85-4d83-b528-8ddeec5b436c",
  • "metadata": {
    },
  • "properties": {
    }
}

Get a Certificate by ID

Retrieves a certificate specified by its ID.

Authorizations:
basicAuthtokenAuth
path Parameters
certificateId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "63f766c7-3f85-4d83-b528-8ddeec5b436c",
  • "type": "certificate",
  • "href": "https://api.ionos.com/certificatemanager/certificates/63f766c7-3f85-4d83-b528-8ddeec5b436c",
  • "metadata": {
    },
  • "properties": {
    }
}

Update a Certificate Name by ID

Updates the name of the specified certificate.

Authorizations:
basicAuthtokenAuth
path Parameters
certificateId
required
string
Request Body schema: application/json
required
object (CertificatePatchPropertiesDto)

Responses

Request samples

Content type
application/json
{
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "id": "63f766c7-3f85-4d83-b528-8ddeec5b436c",
  • "type": "certificate",
  • "href": "https://api.ionos.com/certificatemanager/certificates/63f766c7-3f85-4d83-b528-8ddeec5b436c",
  • "metadata": {
    },
  • "properties": {
    }
}

Delete a Certificate by ID

Deletes a certificate specified by its ID.

Authorizations:
basicAuthtokenAuth
path Parameters
certificateId
required
string

Responses