AutoCertificate

Auto certificates create new certificates based on a certificate provider.

This tag groups all operations for autocertificate.

Retrieve all AutoCertificate

get

This endpoint enables retrieving all AutoCertificate 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

Responses

200

Returned all requested AutoCertificate successfully.

application/json

Responseall of

and

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

HTTPcURLJavaScriptPython

GET /auto-certificates HTTP/1.1
Host: certificate-manager.de-fra.ionos.com
Authorization: Bearer JWT
Accept: */*

{
  "id": "b57af488-a991-522a-9fea-bbca2e2d097f",
  "type": "collection",
  "href": "/auto-certificates",
  "items": [
    {
      "id": "f88467f8-a2d6-5871-83b9-e10f23d0a48a",
      "type": "autocertificate",
      "href": "/auto-certificates/f88467f8-a2d6-5871-83b9-e10f23d0a48a",
      "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.",
        "lastIssuedCertificate": "cbee81a3-9389-57ba-bc50-393adcfca141"
      },
      "properties": {
        "provider": "b471cd03-ef51-52c5-91a5-49195b0a04d4",
        "commonName": "www.example.com",
        "keyAlgorithm": "rsa4096",
        "name": "My Auto renewed certificate",
        "subjectAlternativeNames": [
          "app.example.com"
        ]
      }
    }
  ],
  "offset": 0,
  "limit": 42,
  "_links": {
    "prev": "http://PREVIOUS-PAGE-URI",
    "self": "http://THIS-PAGE-URI",
    "next": "http://NEXT-PAGE-URI"
  }
}

Create AutoCertificate

post

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

Body

metadataanyOptional

Metadata

Responses

201

AutoCertificate 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

HTTPcURLJavaScriptPython

POST /auto-certificates HTTP/1.1
Host: certificate-manager.de-fra.ionos.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 219

{
  "metadata": {},
  "properties": {
    "provider": "b471cd03-ef51-52c5-91a5-49195b0a04d4",
    "commonName": "www.example.com",
    "keyAlgorithm": "rsa4096",
    "name": "My Auto renewed certificate",
    "subjectAlternativeNames": [
      "app.example.com"
    ]
  }
}

{
  "id": "f88467f8-a2d6-5871-83b9-e10f23d0a48a",
  "type": "autocertificate",
  "href": "/auto-certificates/f88467f8-a2d6-5871-83b9-e10f23d0a48a",
  "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.",
    "lastIssuedCertificate": "cbee81a3-9389-57ba-bc50-393adcfca141"
  },
  "properties": {
    "provider": "b471cd03-ef51-52c5-91a5-49195b0a04d4",
    "commonName": "www.example.com",
    "keyAlgorithm": "rsa4096",
    "name": "My Auto renewed certificate",
    "subjectAlternativeNames": [
      "app.example.com"
    ]
  }
}

Retrieve AutoCertificate

get

Returns the AutoCertificate by ID.

Authorizations

Path parameters

autoCertificateIdstring · uuidRequired

The ID (UUID) of the AutoCertificate.

Example: f88467f8-a2d6-5871-83b9-e10f23d0a48a

Responses

200

Getting AutoCertificate was successful.

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

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

HTTPcURLJavaScriptPython

GET /auto-certificates/{autoCertificateId} HTTP/1.1
Host: certificate-manager.de-fra.ionos.com
Authorization: Bearer JWT
Accept: */*

{
  "id": "f88467f8-a2d6-5871-83b9-e10f23d0a48a",
  "type": "autocertificate",
  "href": "/auto-certificates/f88467f8-a2d6-5871-83b9-e10f23d0a48a",
  "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.",
    "lastIssuedCertificate": "cbee81a3-9389-57ba-bc50-393adcfca141"
  },
  "properties": {
    "provider": "b471cd03-ef51-52c5-91a5-49195b0a04d4",
    "commonName": "www.example.com",
    "keyAlgorithm": "rsa4096",
    "name": "My Auto renewed certificate",
    "subjectAlternativeNames": [
      "app.example.com"
    ]
  }
}

Delete AutoCertificate

delete

Deletes the specified AutoCertificate.

Authorizations

Path parameters

autoCertificateIdstring · uuidRequired

The ID (UUID) of the AutoCertificate.

Example: f88467f8-a2d6-5871-83b9-e10f23d0a48a

Responses

202

Deleting AutoCertificate 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

HTTPcURLJavaScriptPython

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

No content

Updates AutoCertificate

patch

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

Authorizations

Path parameters

autoCertificateIdstring · uuidRequired

The ID (UUID) of the AutoCertificate.

Example: f88467f8-a2d6-5871-83b9-e10f23d0a48a

Body

metadataanyOptional

Metadata

Responses

200

AutoCertificate successfully updated.

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

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

HTTPcURLJavaScriptPython

PATCH /auto-certificates/{autoCertificateId} 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": "f88467f8-a2d6-5871-83b9-e10f23d0a48a",
  "type": "autocertificate",
  "href": "/auto-certificates/f88467f8-a2d6-5871-83b9-e10f23d0a48a",
  "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.",
    "lastIssuedCertificate": "cbee81a3-9389-57ba-bc50-393adcfca141"
  },
  "properties": {
    "provider": "b471cd03-ef51-52c5-91a5-49195b0a04d4",
    "commonName": "www.example.com",
    "keyAlgorithm": "rsa4096",
    "name": "My Auto renewed certificate",
    "subjectAlternativeNames": [
      "app.example.com"
    ]
  }
}