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

AuthorizationstringRequired

The token can be generated using the Authentication API.

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

Pagination information. The offset and limit parameters are used to navigate the list of elements. The _links object contains URLs to navigate the different pages.

idstring · uuidRequired

ID of the list of Certificate resources.

Example: e7057759-25b4-5a26-b2f2-4c41e61f1044

typestring · enumRequired

The type of the resource.

Possible values:

hrefstringRequired

The URL of the list of Certificate resources.

Example: /certificates

offsetintegerRead-onlyRequired

The offset specified in the request (if none was specified, the default offset is 0).

Example: 0

limitintegerRead-onlyRequired

The limit specified in the request (if none was specified, use the endpoint's default pagination limit).

Example: 42

400

Bad Request

The request send to the API was malformed.

application/json

401

Unauthorized

The request is missing authorization information or the authorization information provided are expired.

application/json

403

Not Allowed

The user issuing the request does not have the needed permissions.

application/json

429

Too Many Requests

The user has sent too many requests in a given amount of time.

application/json

500

Internal Server Error

An internal error occurred. We apologize for the inconvenience!

application/json

503

Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance of the server.

application/json

default

Unexpected Internal Server Error

An unexpected internal error occurred. We apologize for the inconvenience!

application/json

get

/certificates

GET /certificates HTTP/1.1
Host: certificate-manager.de-fra.ionos.com
Authorization: Bearer YOUR_SECRET_TOKEN
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

AuthorizationstringRequired

The token can be generated using the Authentication API.

Body

metadataanyOptional

Metadata

Responses

201

Certificate successfully created.

application/json

400

Bad Request

The request send to the API was malformed.

application/json

401

Unauthorized

The request is missing authorization information or the authorization information provided are expired.

application/json

403

Not Allowed

The user issuing the request does not have the needed permissions.

application/json

415

Unsupported Media Type

The request has an unsupported media type.

application/json

422

Unprocessable Entity

The request was well-formed but was unable to be followed due to semantic errors.

application/json

429

Too Many Requests

The user has sent too many requests in a given amount of time.

application/json

500

Internal Server Error

An internal error occurred. We apologize for the inconvenience!

application/json

503

Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance of the server.

application/json

default

Unexpected Internal Server Error

An unexpected internal error occurred. We apologize for the inconvenience!

application/json

post

/certificates

POST /certificates HTTP/1.1
Host: certificate-manager.de-fra.ionos.com
Authorization: Bearer YOUR_SECRET_TOKEN
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

AuthorizationstringRequired

The token can be generated using the Authentication API.

Path parameters

certificateIdstring · uuidRequired

The ID (UUID) of the Certificate.

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

Responses

200

Getting Certificate was successful.

application/json

idstring · uuidRequired

The ID (UUID) of the Certificate.

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

typestring · enumRequired

The type of the resource.

Possible values:

hrefstringRequired

The URL of the Certificate.

Example: /certificates/cbee81a3-9389-57ba-bc50-393adcfca141

400

Bad Request

The request send to the API was malformed.

application/json

401

Unauthorized

The request is missing authorization information or the authorization information provided are expired.

application/json

403

Not Allowed

The user issuing the request does not have the needed permissions.

application/json

404

Not Found

The resource that was requested could not be found.

application/json

429

Too Many Requests

The user has sent too many requests in a given amount of time.

application/json

500

Internal Server Error

An internal error occurred. We apologize for the inconvenience!

application/json

503

Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance of the server.

application/json

default

Unexpected Internal Server Error

An unexpected internal error occurred. We apologize for the inconvenience!

application/json

get

/certificates/{certificateId}

GET /certificates/{certificateId} HTTP/1.1
Host: certificate-manager.de-fra.ionos.com
Authorization: Bearer YOUR_SECRET_TOKEN
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

AuthorizationstringRequired

The token can be generated using the Authentication API.

Path parameters

certificateIdstring · uuidRequired

The ID (UUID) of the Certificate.

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

Responses

202

Deleting Certificate was successful.

400

Bad Request

The request send to the API was malformed.

application/json

401

Unauthorized

The request is missing authorization information or the authorization information provided are expired.

application/json

403

Not Allowed

The user issuing the request does not have the needed permissions.

application/json

404

Not Found

The resource that was requested could not be found.

application/json

429

Too Many Requests

The user has sent too many requests in a given amount of time.

application/json

500

Internal Server Error

An internal error occurred. We apologize for the inconvenience!

application/json

503

Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance of the server.

application/json

default

Unexpected Internal Server Error

An unexpected internal error occurred. We apologize for the inconvenience!

application/json

delete

/certificates/{certificateId}

DELETE /certificates/{certificateId} HTTP/1.1
Host: certificate-manager.de-fra.ionos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Updates Certificate

patch

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

Authorizations

AuthorizationstringRequired

The token can be generated using the Authentication API.

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

idstring · uuidRequired

The ID (UUID) of the Certificate.

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

typestring · enumRequired

The type of the resource.

Possible values:

hrefstringRequired

The URL of the Certificate.

Example: /certificates/cbee81a3-9389-57ba-bc50-393adcfca141

400

Bad Request

The request send to the API was malformed.

application/json

401

Unauthorized

The request is missing authorization information or the authorization information provided are expired.

application/json

403

Not Allowed

The user issuing the request does not have the needed permissions.

application/json

404

Not Found

The resource that was requested could not be found.

application/json

409

Conflict

The UUID is already taken by another party, follow the guides to generate UUIDs uniquely.

application/json

415

Unsupported Media Type

The request has an unsupported media type.

application/json

422

Unprocessable Entity

The request was well-formed but was unable to be followed due to semantic errors.

application/json

429

Too Many Requests

The user has sent too many requests in a given amount of time.

application/json

500

Internal Server Error

An internal error occurred. We apologize for the inconvenience!

application/json

503

Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance of the server.

application/json

default

Unexpected Internal Server Error

An unexpected internal error occurred. We apologize for the inconvenience!

application/json

patch

/certificates/{certificateId}

PATCH /certificates/{certificateId} HTTP/1.1
Host: certificate-manager.de-fra.ionos.com
Authorization: Bearer YOUR_SECRET_TOKEN
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 Manager NextAutoCertificate

Last updated 2 months ago

Was this helpful?

Good evening

hashtagRetrieve all Certificate

Bad Request

Unauthorized

Not Allowed

Too Many Requests

Internal Server Error

Service Unavailable

Unexpected Internal Server Error

hashtagCreate Certificate

Bad Request

Unauthorized

Not Allowed

Unsupported Media Type

Unprocessable Entity

Too Many Requests

Internal Server Error

Service Unavailable

Unexpected Internal Server Error

hashtagRetrieve Certificate

Bad Request

Unauthorized

Not Allowed

Not Found

Too Many Requests

Internal Server Error

Service Unavailable

Unexpected Internal Server Error

hashtagDelete Certificate

Bad Request

Unauthorized

Not Allowed

Not Found

Too Many Requests

Internal Server Error

Service Unavailable

Unexpected Internal Server Error

hashtagUpdates Certificate

Bad Request

Unauthorized

Not Allowed

Not Found

Conflict

Unsupported Media Type

Unprocessable Entity

Too Many Requests

Internal Server Error

Service Unavailable

Unexpected Internal Server Error

Retrieve all Certificate

Create Certificate

Retrieve Certificate

Delete Certificate

Updates Certificate