AI Model Hub for free till June 30, 2025.
Try now
Test nowLog inShare Feedback

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

get

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

Authorizations
Query parameters
offsetinteger · int32Optional

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

Default: 0Example: 0
limitinteger · int32 · min: 1 · max: 1000Optional

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

Default: 100Example: 100
filter.commonNamestringOptional

Filter by the common name (DNS).

Example: www.example.com
filter.autoCertificatestring · uuidOptional

Filter by autoCertificateID.

Example: b471cd03-ef51-52c5-91a5-49195b0a04d4
Responses
200
Returned all requested Certificate successfully.
application/json
Responseall of
and
get
GET /certificates HTTP/1.1
Host: certificate-manager.de-fra.ionos.com
Authorization: Bearer JWT
Accept: */*

{
  "id": "e7057759-25b4-5a26-b2f2-4c41e61f1044",
  "type": "collection",
  "href": "/certificates",
  "items": [
    {
      "id": "cbee81a3-9389-57ba-bc50-393adcfca141",
      "type": "certificate",
      "href": "/certificates/cbee81a3-9389-57ba-bc50-393adcfca141",
      "metadata": {
        "createdDate": "2020-12-10T13:37:50+01:00",
        "createdBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
        "createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
        "lastModifiedDate": "2020-12-11T13:37:50+01:00",
        "lastModifiedBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
        "lastModifiedByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
        "resourceURN": "ionos:<product>:<location>:<contract>:<resource-path>",
        "state": "AVAILABLE",
        "message": "Issue in progress.",
        "autoCertificate": "b471cd03-ef51-52c5-91a5-49195b0a04d4",
        "lastIssuedCertificate": "cbee81a3-9389-57ba-bc50-393adcfca141",
        "expired": false,
        "notBefore": "2021-12-31T23:59:59Z",
        "notAfter": "2022-12-31T23:59:59Z",
        "serialNumber": "33:00:00:04:5F:2B:0D:65:9D:71:72:3E:7D:00:00:00:00:04:5F",
        "commonName": "www.example.com",
        "subjectAlternativeNames": [
          "app.example.com"
        ]
      },
      "properties": {
        "name": "My Certificate",
        "certificate": "-----BEGIN CERTIFICATE-----\nMIIE5TCCAs2gAwIBAgIBATANBgkqhkiG9w0BAQsFADA2MQswCQYDVQQGEwJSTzEK\n-----END CERTIFICATE-----\n",
        "certificateChain": "-----BEGIN CERTIFICATE-----\nMIIDoTCCAokCFDrAUWffdxWJVz2Axl9lp/4xiUteMA0GCSqGSIb3DQEBCwUAMIGG\n-----END CERTIFICATE-----\n"
      }
    }
  ],
  "offset": 0,
  "limit": 42,
  "_links": {
    "prev": "http://PREVIOUS-PAGE-URI",
    "self": "http://THIS-PAGE-URI",
    "next": "http://NEXT-PAGE-URI"
  }
}

Create Certificate

post

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
Body
metadataanyOptional

Metadata

Responses
201
Certificate successfully created.
application/json
post
POST /certificates HTTP/1.1
Host: certificate-manager.de-fra.ionos.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 483

{
  "metadata": {},
  "properties": {
    "name": "My Certificate",
    "certificate": "-----BEGIN CERTIFICATE-----\nMIIE5TCCAs2gAwIBAgIBATANBgkqhkiG9w0BAQsFADA2MQswCQYDVQQGEwJSTzEK\n-----END CERTIFICATE-----\n",
    "certificateChain": "-----BEGIN CERTIFICATE-----\nMIIDoTCCAokCFDrAUWffdxWJVz2Axl9lp/4xiUteMA0GCSqGSIb3DQEBCwUAMIGG\n-----END CERTIFICATE-----\n",
    "privateKey": "-----BEGIN RSA PRIVATE KEY-----\nMIIJKQIBAAKCAgEAzDehfqWBr+9q0pxwCDDRph7QSPiMbkDGaGKc+Fd2h3doT8Li\n-----END RSA PRIVATE KEY-----\n"
  }
}
{
  "id": "cbee81a3-9389-57ba-bc50-393adcfca141",
  "type": "certificate",
  "href": "/certificates/cbee81a3-9389-57ba-bc50-393adcfca141",
  "metadata": {
    "createdDate": "2020-12-10T13:37:50+01:00",
    "createdBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "lastModifiedDate": "2020-12-11T13:37:50+01:00",
    "lastModifiedBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "lastModifiedByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "resourceURN": "ionos:<product>:<location>:<contract>:<resource-path>",
    "state": "AVAILABLE",
    "message": "Issue in progress.",
    "autoCertificate": "b471cd03-ef51-52c5-91a5-49195b0a04d4",
    "lastIssuedCertificate": "cbee81a3-9389-57ba-bc50-393adcfca141",
    "expired": false,
    "notBefore": "2021-12-31T23:59:59Z",
    "notAfter": "2022-12-31T23:59:59Z",
    "serialNumber": "33:00:00:04:5F:2B:0D:65:9D:71:72:3E:7D:00:00:00:00:04:5F",
    "commonName": "www.example.com",
    "subjectAlternativeNames": [
      "app.example.com"
    ]
  },
  "properties": {
    "name": "My Certificate",
    "certificate": "-----BEGIN CERTIFICATE-----\nMIIE5TCCAs2gAwIBAgIBATANBgkqhkiG9w0BAQsFADA2MQswCQYDVQQGEwJSTzEK\n-----END CERTIFICATE-----\n",
    "certificateChain": "-----BEGIN CERTIFICATE-----\nMIIDoTCCAokCFDrAUWffdxWJVz2Axl9lp/4xiUteMA0GCSqGSIb3DQEBCwUAMIGG\n-----END CERTIFICATE-----\n"
  }
}

Retrieve Certificate

get

Returns the Certificate by ID.

Authorizations
Path parameters
certificateIdstring · uuidRequired

The ID (UUID) of the Certificate.

Example: cbee81a3-9389-57ba-bc50-393adcfca141
Responses
200
Getting Certificate was successful.
application/json
get
GET /certificates/{certificateId} HTTP/1.1
Host: certificate-manager.de-fra.ionos.com
Authorization: Bearer JWT
Accept: */*

{
  "id": "cbee81a3-9389-57ba-bc50-393adcfca141",
  "type": "certificate",
  "href": "/certificates/cbee81a3-9389-57ba-bc50-393adcfca141",
  "metadata": {
    "createdDate": "2020-12-10T13:37:50+01:00",
    "createdBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "lastModifiedDate": "2020-12-11T13:37:50+01:00",
    "lastModifiedBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "lastModifiedByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "resourceURN": "ionos:<product>:<location>:<contract>:<resource-path>",
    "state": "AVAILABLE",
    "message": "Issue in progress.",
    "autoCertificate": "b471cd03-ef51-52c5-91a5-49195b0a04d4",
    "lastIssuedCertificate": "cbee81a3-9389-57ba-bc50-393adcfca141",
    "expired": false,
    "notBefore": "2021-12-31T23:59:59Z",
    "notAfter": "2022-12-31T23:59:59Z",
    "serialNumber": "33:00:00:04:5F:2B:0D:65:9D:71:72:3E:7D:00:00:00:00:04:5F",
    "commonName": "www.example.com",
    "subjectAlternativeNames": [
      "app.example.com"
    ]
  },
  "properties": {
    "name": "My Certificate",
    "certificate": "-----BEGIN CERTIFICATE-----\nMIIE5TCCAs2gAwIBAgIBATANBgkqhkiG9w0BAQsFADA2MQswCQYDVQQGEwJSTzEK\n-----END CERTIFICATE-----\n",
    "certificateChain": "-----BEGIN CERTIFICATE-----\nMIIDoTCCAokCFDrAUWffdxWJVz2Axl9lp/4xiUteMA0GCSqGSIb3DQEBCwUAMIGG\n-----END CERTIFICATE-----\n"
  }
}

Delete Certificate

delete

Deletes the specified Certificate.

Authorizations
Path parameters
certificateIdstring · uuidRequired

The ID (UUID) of the Certificate.

Example: cbee81a3-9389-57ba-bc50-393adcfca141
Responses
202
Deleting Certificate was successful.
delete
DELETE /certificates/{certificateId} HTTP/1.1
Host: certificate-manager.de-fra.ionos.com
Authorization: Bearer JWT
Accept: */*

No content

Updates Certificate

patch

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

Authorizations
Path parameters
certificateIdstring · uuidRequired

The ID (UUID) of the Certificate.

Example: cbee81a3-9389-57ba-bc50-393adcfca141
Body
metadataanyOptional

Metadata

Responses
200
Certificate successfully updated.
application/json
patch
PATCH /certificates/{certificateId} HTTP/1.1
Host: certificate-manager.de-fra.ionos.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "metadata": {},
  "properties": {
    "name": "My name"
  }
}
{
  "id": "cbee81a3-9389-57ba-bc50-393adcfca141",
  "type": "certificate",
  "href": "/certificates/cbee81a3-9389-57ba-bc50-393adcfca141",
  "metadata": {
    "createdDate": "2020-12-10T13:37:50+01:00",
    "createdBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "lastModifiedDate": "2020-12-11T13:37:50+01:00",
    "lastModifiedBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "lastModifiedByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "resourceURN": "ionos:<product>:<location>:<contract>:<resource-path>",
    "state": "AVAILABLE",
    "message": "Issue in progress.",
    "autoCertificate": "b471cd03-ef51-52c5-91a5-49195b0a04d4",
    "lastIssuedCertificate": "cbee81a3-9389-57ba-bc50-393adcfca141",
    "expired": false,
    "notBefore": "2021-12-31T23:59:59Z",
    "notAfter": "2022-12-31T23:59:59Z",
    "serialNumber": "33:00:00:04:5F:2B:0D:65:9D:71:72:3E:7D:00:00:00:00:04:5F",
    "commonName": "www.example.com",
    "subjectAlternativeNames": [
      "app.example.com"
    ]
  },
  "properties": {
    "name": "My Certificate",
    "certificate": "-----BEGIN CERTIFICATE-----\nMIIE5TCCAs2gAwIBAgIBATANBgkqhkiG9w0BAQsFADA2MQswCQYDVQQGEwJSTzEK\n-----END CERTIFICATE-----\n",
    "certificateChain": "-----BEGIN CERTIFICATE-----\nMIIDoTCCAokCFDrAUWffdxWJVz2Axl9lp/4xiUteMA0GCSqGSIb3DQEBCwUAMIGG\n-----END CERTIFICATE-----\n"
  }
}
PreviousCertificate ManagerNextAutoCertificate

Was this helpful?