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

    Interface WithDomain_nameItemRequestBuilder

    Builds and executes requests for operations under /v2/domains/{domain_name}

    interface WithDomain_nameItemRequestBuilder {
        get records(): RecordsRequestBuilder;
        delete(requestConfiguration?: RequestConfiguration<object>): Promise<void>;
        get(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | WithDomain_nameGetResponse>;
        toDeleteRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): WithDomain_nameItemRequestBuilder;
    }

    Hierarchy

    Index

    Accessors

    records

    Methods

    delete get toDeleteRequestInformation toGetRequestInformation withUrl

    Accessors

    Methods

    • To delete a domain, send a DELETE request to /v2/domains/$DOMAIN_NAME.

      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 get details about a specific domain, send a GET request to /v2/domains/$DOMAIN_NAME.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | WithDomain_nameGetResponse>

      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 domain, send a DELETE request to /v2/domains/$DOMAIN_NAME.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • To get details about a specific domain, send a GET request to /v2/domains/$DOMAIN_NAME.

      Parameters

      • 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