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

    Interface DomainsRequestBuilder

    Builds and executes requests for operations under /v2/domains

    interface DomainsRequestBuilder {
        byDomain_name(domain_name: string): WithDomain_nameItemRequestBuilder;
        get(
            requestConfiguration?: RequestConfiguration<
                DomainsRequestBuilderGetQueryParameters,
            >,
        ): Promise<undefined | DomainsGetResponse>;
        post(
            body: Domain,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | DomainsPostResponse>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<
                DomainsRequestBuilderGetQueryParameters,
            >,
        ): RequestInformation;
        toPostRequestInformation(
            body: Domain,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): DomainsRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    byDomain_name get post toGetRequestInformation toPostRequestInformation withUrl

    Methods

    • To retrieve a list of all of the domains in your account, send a GET request to /v2/domains.

      Parameters

      Returns Promise<undefined | DomainsGetResponse>

      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

    post

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

      To create a new domain, send a POST request to /v2/domains. Set the "name"attribute to the domain name you are adding. Optionally, you may set the"ip_address" attribute, and an A record will be automatically created pointingto the apex domain.

      Parameters

      • body: Domain

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | DomainsPostResponse>

      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 domain, send a POST request to /v2/domains. Set the "name"attribute to the domain name you are adding. Optionally, you may set the"ip_address" attribute, and an A record will be automatically created pointingto the apex domain.

      Parameters

      • body: Domain

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • Parameters

      • rawUrl: string

      Returns DomainsRequestBuilder

    Settings

    Member Visibility

    On This Page

    Methods