@digitalocean/dots - v1.0.1
    Preparing search index...

    Interface CertificatesRequestBuilder

    Builds and executes requests for operations under /v2/certificates

    interface CertificatesRequestBuilder {
        byCertificate_id(
            certificate_id: string,
        ): WithCertificate_ItemRequestBuilder;
        get(
            requestConfiguration?: RequestConfiguration<
                CertificatesRequestBuilderGetQueryParameters,
            >,
        ): Promise<undefined | CertificatesGetResponse>;
        post(
            body: Certificate_request_custom | Certificate_request_lets_encrypt,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | CertificatesPostResponse>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<
                CertificatesRequestBuilderGetQueryParameters,
            >,
        ): RequestInformation;
        toPostRequestInformation(
            body: Certificate_request_custom | Certificate_request_lets_encrypt,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): CertificatesRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    byCertificate_id get post toGetRequestInformation toPostRequestInformation withUrl

    Methods

    post

    • post(
          body: Certificate_request_custom | Certificate_request_lets_encrypt,
          requestConfiguration?: RequestConfiguration<object>,
      ): Promise<undefined | CertificatesPostResponse>

      To upload new SSL certificate which you have previously generated, send a POSTrequest to /v2/certificates.When uploading a user-generated certificate, the private_key,leaf_certificate, and optionally the certificate_chain attributes shouldbe provided. The type must be set to custom.When using Let's Encrypt to create a certificate, the dns_names attributemust be provided, and the type must be set to lets_encrypt.

      Parameters

      • body: Certificate_request_custom | Certificate_request_lets_encrypt

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

        Configuration for the request such as headers, query parameters, and middleware options.

      Returns Promise<undefined | CertificatesPostResponse>

      error when the service returns a 401 status code

      error when the service returns a 429 status code

      error when the service returns a 500 status code

      error when the service returns a 4XX or 5XX status code

    • To upload new SSL certificate which you have previously generated, send a POSTrequest to /v2/certificates.When uploading a user-generated certificate, the private_key,leaf_certificate, and optionally the certificate_chain attributes shouldbe provided. The type must be set to custom.When using Let's Encrypt to create a certificate, the dns_names attributemust be provided, and the type must be set to lets_encrypt.

      Parameters

      • body: Certificate_request_custom | Certificate_request_lets_encrypt

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

        Configuration for the request such as headers, query parameters, and middleware options.

      Returns RequestInformation

    Settings

    Member Visibility

    On This Page

    Methods