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

    Interface EndpointsRequestBuilder

    Builds and executes requests for operations under /v2/cdn/endpoints

    interface EndpointsRequestBuilder {
        byCdn_id(cdn_id: string): WithCdn_ItemRequestBuilder;
        get(
            requestConfiguration?: RequestConfiguration<
                EndpointsRequestBuilderGetQueryParameters,
            >,
        ): Promise<undefined | EndpointsGetResponse>;
        post(
            body: Cdn_endpoint,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | EndpointsPostResponse>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<
                EndpointsRequestBuilderGetQueryParameters,
            >,
        ): RequestInformation;
        toPostRequestInformation(
            body: Cdn_endpoint,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): EndpointsRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    byCdn_id get post toGetRequestInformation toPostRequestInformation withUrl

    Methods

    post

    • post(
          body: Cdn_endpoint,
          requestConfiguration?: RequestConfiguration<object>,
      ): Promise<undefined | EndpointsPostResponse>

      To create a new CDN endpoint, send a POST request to /v2/cdn/endpoints. Theorigin attribute must be set to the fully qualified domain name (FQDN) of aDigitalOcean Space. Optionally, the TTL may be configured by setting the ttlattribute.A custom subdomain may be configured by specifying the custom_domain andcertificate_id attributes.

      Parameters

      • body: Cdn_endpoint

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | EndpointsPostResponse>

      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 create a new CDN endpoint, send a POST request to /v2/cdn/endpoints. Theorigin attribute must be set to the fully qualified domain name (FQDN) of aDigitalOcean Space. Optionally, the TTL may be configured by setting the ttlattribute.A custom subdomain may be configured by specifying the custom_domain andcertificate_id attributes.

      Parameters

      • body: Cdn_endpoint

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • Parameters

      • rawUrl: string

      Returns EndpointsRequestBuilder

    Settings

    Member Visibility

    On This Page

    Methods