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

    Interface WithCdn_ItemRequestBuilder

    Builds and executes requests for operations under /v2/cdn/endpoints/{cdn_id}

    interface WithCdn_ItemRequestBuilder {
        get cache(): CacheRequestBuilder;
        delete(requestConfiguration?: RequestConfiguration<object>): Promise<void>;
        get(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | WithCdn_GetResponse>;
        put(
            body: Update_endpoint,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | WithCdn_PutResponse>;
        toDeleteRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toPutRequestInformation(
            body: Update_endpoint,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): WithCdn_ItemRequestBuilder;
    }

    Hierarchy

    Index

    Accessors

    cache

    Methods

    delete get put toDeleteRequestInformation toGetRequestInformation toPutRequestInformation withUrl

    Accessors

    Methods

    • To delete a specific CDN endpoint, send a DELETE request to/v2/cdn/endpoints/$ENDPOINT_ID.A status of 204 will be given. This indicates that the request was processedsuccessfully, but that no response body is needed.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<void>

      error when the service returns a 401 status code

      error when the service returns a 404 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 show information about an existing CDN endpoint, send a GET request to /v2/cdn/endpoints/$ENDPOINT_ID.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | WithCdn_GetResponse>

      error when the service returns a 401 status code

      error when the service returns a 404 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 update the TTL, certificate ID, or the FQDN of the custom subdomain foran existing CDN endpoint, send a PUT request to/v2/cdn/endpoints/$ENDPOINT_ID.

      Parameters

      • body: Update_endpoint

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | WithCdn_PutResponse>

      error when the service returns a 401 status code

      error when the service returns a 404 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 delete a specific CDN endpoint, send a DELETE request to/v2/cdn/endpoints/$ENDPOINT_ID.A status of 204 will be given. This indicates that the request was processedsuccessfully, but that no response body is needed.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • To show information about an existing CDN endpoint, send a GET request to /v2/cdn/endpoints/$ENDPOINT_ID.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • To update the TTL, certificate ID, or the FQDN of the custom subdomain foran existing CDN endpoint, send a PUT request to/v2/cdn/endpoints/$ENDPOINT_ID.

      Parameters

      • body: Update_endpoint

        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

    Accessors
    Methods