API docs by Redocly

Certificate Manager Service API (2.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.

Certificate

TLS/SSL certificates are used to secure network communications and prove the identity of websites on the Internet and resources on private networks. The certificates and their associated private keys are provided in PEM (Privacy Enhanced Mail) format.

This tag groups all operations for certificate.

Retrieve all Certificate

This endpoint enables retrieving all Certificate using pagination and optional filters.

Authorizations:
tokenAuth
query Parameters
offset
integer <int32> >= 0
Default: 0

The first element (of the total list of elements) to include in the response. Use together with limit for pagination.

limit
integer <int32> [ 1 .. 1000 ]
Default: 100
Example: limit=100

The maximum number of elements to return. Use together with offset for pagination.

filter.commonName
string
Example: filter.commonName=www.example.com

Filter by the common name (DNS).

filter.autoCertificate
string <uuid>
Example: filter.autoCertificate=b471cd03-ef51-52c5-91a5-49195b0a04d4

Filter by autoCertificateID.

Responses

Response samples

Content type
application/json
{
  • "id": "e7057759-25b4-5a26-b2f2-4c41e61f1044",
  • "type": "collection",
  • "href": "/certificates",
  • "items": [
    ],
  • "offset": 0,
  • "limit": 42,
  • "_links": {}
}

Create Certificate

Creates a new Certificate.

The full Certificate needs to be provided to create the object. Optional data will be filled with defaults or left empty.

Authorizations:
tokenAuth
Request Body schema: application/json

Certificate to create.

object

Metadata

required
object (Certificate)

TLS/SSL certificates are used to secure network communications and prove the identity of websites on the Internet and resources on private networks. The certificates and their associated private keys are provided in PEM (Privacy Enhanced Mail) format.

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": "cbee81a3-9389-57ba-bc50-393adcfca141",
  • "type": "certificate",
  • "href": "/certificates/cbee81a3-9389-57ba-bc50-393adcfca141",
  • "metadata": {
    },
  • "properties": {
    }
}

Retrieve Certificate

Returns the Certificate by ID.

Authorizations:
tokenAuth
path Parameters
certificateId
required
string <uuid>
Example: cbee81a3-9389-57ba-bc50-393adcfca141

The ID (UUID) of the Certificate.

Responses

Response samples

Content type
application/json
{
  • "id": "cbee81a3-9389-57ba-bc50-393adcfca141",
  • "type": "certificate",
  • "href": "/certificates/cbee81a3-9389-57ba-bc50-393adcfca141",
  • "metadata": {
    },
  • "properties": {
    }
}

Updates Certificate

Changes Certificate with the provided ID. Values provides will replace the existing data.

Authorizations:
tokenAuth
path Parameters
certificateId
required
string <uuid>
Example: cbee81a3-9389-57ba-bc50-393adcfca141

The ID (UUID) of the Certificate.

Request Body schema: application/json

patch Certificate

object

Metadata

required
object (PatchName)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": "cbee81a3-9389-57ba-bc50-393adcfca141",
  • "type": "certificate",
  • "href": "/certificates/cbee81a3-9389-57ba-bc50-393adcfca141",
  • "metadata": {
    },
  • "properties": {
    }
}

Delete Certificate

Deletes the specified Certificate.

Authorizations:
tokenAuth
path Parameters
certificateId
required
string <uuid>
Example: cbee81a3-9389-57ba-bc50-393adcfca141

The ID (UUID) of the Certificate.

Responses

Response samples

Content type
application/json
{
  • "httpStatus": 400,
  • "messages": [
    ]
}

AutoCertificate

Auto certificates create new certificates based on a certificate provider.

This tag groups all operations for autocertificate.

Retrieve all AutoCertificate

This endpoint enables retrieving all AutoCertificate using pagination and optional filters.

Authorizations:
tokenAuth
query Parameters
offset
integer <int32> >= 0
Default: 0

The first element (of the total list of elements) to include in the response. Use together with limit for pagination.

limit
integer <int32> [ 1 .. 1000 ]
Default: 100
Example: limit=100

The maximum number of elements to return. Use together with offset for pagination.

filter.commonName
string
Example: filter.commonName=www.example.com

Filter by the common name (DNS).

Responses

Response samples

Content type
application/json
{
  • "id": "b57af488-a991-522a-9fea-bbca2e2d097f",
  • "type": "collection",
  • "href": "/auto-certificates",
  • "items": [
    ],
  • "offset": 0,
  • "limit": 42,
  • "_links": {}
}

Create AutoCertificate

Creates a new AutoCertificate.

The full AutoCertificate needs to be provided to create the object. Optional data will be filled with defaults or left empty.

Authorizations:
tokenAuth
Request Body schema: application/json

AutoCertificate to create.

object

Metadata

required
object (AutoCertificate)

Auto certificates create new certificates based on a certificate provider.

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": "f88467f8-a2d6-5871-83b9-e10f23d0a48a",
  • "type": "autocertificate",
  • "href": "/auto-certificates/f88467f8-a2d6-5871-83b9-e10f23d0a48a",
  • "metadata": {
    },
  • "properties": {
    }
}

Retrieve AutoCertificate

Returns the AutoCertificate by ID.

Authorizations:
tokenAuth
path Parameters
autoCertificateId
required
string <uuid>
Example: f88467f8-a2d6-5871-83b9-e10f23d0a48a

The ID (UUID) of the AutoCertificate.

Responses

Response samples

Content type
application/json
{
  • "id": "f88467f8-a2d6-5871-83b9-e10f23d0a48a",
  • "type": "autocertificate",
  • "href": "/auto-certificates/f88467f8-a2d6-5871-83b9-e10f23d0a48a",
  • "metadata": {
    },
  • "properties": {
    }
}

Updates AutoCertificate

Changes AutoCertificate with the provided ID. Values provides will replace the existing data.

Authorizations:
tokenAuth
path Parameters
autoCertificateId
required
string <uuid>
Example: f88467f8-a2d6-5871-83b9-e10f23d0a48a

The ID (UUID) of the AutoCertificate.

Request Body schema: application/json

patch AutoCertificate

object

Metadata

required
object (PatchName)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": "f88467f8-a2d6-5871-83b9-e10f23d0a48a",
  • "type": "autocertificate",
  • "href": "/auto-certificates/f88467f8-a2d6-5871-83b9-e10f23d0a48a",
  • "metadata": {
    },
  • "properties": {
    }
}

Delete AutoCertificate

Deletes the specified AutoCertificate.

Authorizations:
tokenAuth
path Parameters
autoCertificateId
required
string <uuid>
Example: f88467f8-a2d6-5871-83b9-e10f23d0a48a

The ID (UUID) of the AutoCertificate.

Responses

Response samples

Content type
application/json
{
  • "httpStatus": 400,
  • "messages": [
    ]
}

Provider

Certificate provider used to renew certificates before their expiry.

This tag groups all operations for provider.

Retrieve all Provider

This endpoint enables retrieving all Provider using pagination and optional filters.

Authorizations:
tokenAuth
query Parameters
offset
integer <int32> >= 0
Default: 0

The first element (of the total list of elements) to include in the response. Use together with limit for pagination.

limit
integer <int32> [ 1 .. 1000 ]
Default: 100
Example: limit=100

The maximum number of elements to return. Use together with offset for pagination.

Responses

Response samples

Content type
application/json
{
  • "id": "36c38284-7cb0-5d88-8701-636aa547617f",
  • "type": "collection",
  • "href": "/providers",
  • "items": [
    ],
  • "offset": 0,
  • "limit": 42,
  • "_links": {}
}

Create Provider

Creates a new Provider.

The full Provider needs to be provided to create the object. Optional data will be filled with defaults or left empty.

Authorizations:
tokenAuth
Request Body schema: application/json

Provider to create.

object

Metadata

required
object (Provider)

Certificate provider used to renew certificates before their expiry.

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "id": "74edc770-5cc6-5976-ac99-013ddb4af403",
  • "type": "provider",
  • "href": "/providers/74edc770-5cc6-5976-ac99-013ddb4af403",
  • "metadata": {
    },
  • "properties": {}
}

Retrieve Provider

Returns the Provider by ID.

Authorizations:
tokenAuth
path Parameters
providerId
required
string <uuid>
Example: 74edc770-5cc6-5976-ac99-013ddb4af403

The ID (UUID) of the Provider.

Responses

Response samples

Content type
application/json
{
  • "id": "74edc770-5cc6-5976-ac99-013ddb4af403",
  • "type": "provider",
  • "href": "/providers/74edc770-5cc6-5976-ac99-013ddb4af403",
  • "metadata": {
    },
  • "properties": {}
}

Updates Provider

Changes Provider with the provided ID. Values provides will replace the existing data.

Authorizations:
tokenAuth
path Parameters
providerId
required
string <uuid>
Example: 74edc770-5cc6-5976-ac99-013ddb4af403

The ID (UUID) of the Provider.

Request Body schema: application/json

patch Provider

object

Metadata

required
object (PatchName)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": "74edc770-5cc6-5976-ac99-013ddb4af403",
  • "type": "provider",
  • "href": "/providers/74edc770-5cc6-5976-ac99-013ddb4af403",
  • "metadata": {
    },
  • "properties": {}
}

Delete Provider

Deletes the specified Provider.

Authorizations:
tokenAuth
path Parameters
providerId
required
string <uuid>
Example: 74edc770-5cc6-5976-ac99-013ddb4af403

The ID (UUID) of the Provider.

Responses

Response samples

Content type
application/json
{
  • "httpStatus": 400,
  • "messages": [
    ]
}