view release on metacpan or  search on metacpan

lib/VM/HetznerCloud/Schema.pm  view on Meta::CPAN

                                          "nullable" : true,
                                          "type" : "number"
                                       },
                                       "page" : {
                                          "description" : "Current page number",
                                          "example" : 3,
                                          "type" : "number"
                                       },
                                       "per_page" : {
                                          "description" : "Maximum number of items shown per page in the response",
                                          "example" : 25,
                                          "type" : "number"
                                       },
                                       "previous_page" : {
                                          "description" : "ID of the previous page. Can be null if the current page is the first one.",
                                          "example" : 2,
                                          "nullable" : true,
                                          "type" : "number"
                                       },
                                       "total_entries" : {
                                          "description" : "The total number of entries that exist in the database for this query. Nullable if unknown.",
                                          "example" : 100,
                                          "nullable" : true,
                                          "type" : "number"
                                       }
                                    },
                                    "required" : [
                                       "page",
                                       "per_page",
                                       "previous_page",
                                       "next_page",
                                       "last_page",
                                       "total_entries"
                                    ],
                                    "type" : "object"
                                 }
                              },
                              "required" : [
                                 "pagination"
                              ],
                              "type" : "object"
                           }
                        },
                        "required" : [
                           "certificates"
                        ],
                        "title" : "CertificatesResponse",
                        "type" : "object"
                     }
                  }
               },
               "description" : "The `certificates` key contains an array of Certificate objects"
            }
         },
         "summary" : "Get all Certificates",
         "tags" : [
            "Certificates"
         ]
      },
      "post" : {
         "description" : "Creates a new Certificate.\n\nThe default type **uploaded** allows for uploading your existing `certificate` and `private_key` in PEM format. You have to monitor its expiration date and handle renewal yourself.\n\nIn contras...
         "requestBody" : {
            "content" : {
               "application/json" : {
                  "examples" : {
                     "managed" : {
                        "summary" : "Creating a type `managed` Certificate",
                        "value" : {
                           "domain_names" : [
                              "example.com",
                              "webmail.example.com",
                              "www.example.com"
                           ],
                           "name" : "my website cert",
                           "type" : "managed"
                        }
                     },
                     "uploaded" : {
                        "summary" : "Creating a type `uploaded` Certificate",
                        "value" : {
                           "certificate" : "-----BEGIN CERTIFICATE-----\n...",
                           "name" : "my website cert",
                           "private_key" : "-----BEGIN PRIVATE KEY-----\n...",
                           "type" : "uploaded"
                        }
                     }
                  },
                  "schema" : {
                     "properties" : {
                        "certificate" : {
                           "description" : "Certificate and chain in PEM format, in order so that each record directly certifies the one preceding. Required for type `uploaded` Certificates.",
                           "example" : "-----BEGIN CERTIFICATE-----\n...",
                           "type" : "string"
                        },
                        "domain_names" : {
                           "description" : "Domains and subdomains that should be contained in the Certificate issued by *Let's Encrypt*. Required for type `managed` Certificates.",
                           "example" : null,
                           "items" : {
                              "type" : "string"
                           },
                           "type" : "array"
                        },
                        "labels" : {
                           "description" : "User-defined labels (key-value pairs)",
                           "type" : "object"
                        },
                        "name" : {
                           "description" : "Name of the Certificate",
                           "example" : "my website cert",
                           "type" : "string"
                        },
                        "private_key" : {
                           "description" : "Certificate key in PEM format. Required for type `uploaded` Certificates.",
                           "example" : "-----BEGIN PRIVATE KEY-----\n...",
                           "type" : "string"
                        },
                        "type" : {
                           "description" : "Choose between uploading a Certificate in PEM format or requesting a managed *Let's Encrypt* Certificate. If omitted defaults to `uploaded`.",
                           "enum" : [
                              "uploaded",
                              "managed"
                           ],
                           "example" : "uploaded",
                           "type" : "string"
                        }
                     },
                     "required" : [
                        "name"
                     ],
                     "title" : "CreateCertificateRequest",
                     "type" : "object"
                  }
               }
            }
         },
         "responses" : {
            "201" : {
               "content" : {
                  "application/json" : {
                     "examples" : {
                        "managed" : {
                           "summary" : "Response when creating a type `managed` Certificate",
                           "value" : {
                              "action" : {
                                 "command" : "create_certificate",
                                 "error" : {
                                    "code" : "action_failed",
                                    "message" : "Action failed"
                                 },
                                 "finished" : null,
                                 "id" : 13,
                                 "progress" : 0,
                                 "resources" : [
                                    {
                                       "id" : 879,
                                       "type" : "certificate"
                                    }
                                 ],
                                 "started" : "2019-01-08T12:10:00+00:00",
                                 "status" : "running"
                              },
                              "certificate" : {
                                 "certificate" : null,
                                 "created" : "2019-01-08T12:10:00+00:00",
                                 "domain_names" : [
                                    "example.com",
                                    "webmail.example.com",
                                    "www.example.com"
                                 ],
                                 "fingerprint" : null,
                                 "id" : 897,
                                 "labels" : {