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

    Interface WithDomain_record_ItemRequestBuilder

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

    interface WithDomain_record_ItemRequestBuilder {
        delete(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<void>;
        get(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | WithDomain_record_GetResponse>;
        patch(
            body: Domain_record,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | WithDomain_record_PatchResponse>;
        put(
            body: Domain_record,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | WithDomain_record_PutResponse>;
        toDeleteRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toPatchRequestInformation(
            body: Domain_record,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toPutRequestInformation(
            body: Domain_record,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): WithDomain_record_ItemRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    delete get patch put toDeleteRequestInformation toGetRequestInformation toPatchRequestInformation toPutRequestInformation withUrl

    Methods

    • To delete a record for a domain, send a DELETE request to/v2/domains/$DOMAIN_NAME/records/$DOMAIN_RECORD_ID.The record will be deleted and the response status will be a 204. Thisindicates a successful request with no body returned.

      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 retrieve a specific domain record, send a GET request to /v2/domains/$DOMAIN_NAME/records/$RECORD_ID.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | WithDomain_record_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 an existing record, send a PATCH request to/v2/domains/$DOMAIN_NAME/records/$DOMAIN_RECORD_ID. Any attribute valid forthe record type can be set to a new value for the record.See the attribute table for details regarding recordtypes and their respective attributes.

      Parameters

      • body: Domain_record

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | WithDomain_record_PatchResponse>

      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 an existing record, send a PUT request to/v2/domains/$DOMAIN_NAME/records/$DOMAIN_RECORD_ID. Any attribute valid forthe record type can be set to a new value for the record.See the attribute table for details regarding recordtypes and their respective attributes.

      Parameters

      • body: Domain_record

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | WithDomain_record_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 record for a domain, send a DELETE request to/v2/domains/$DOMAIN_NAME/records/$DOMAIN_RECORD_ID.The record will be deleted and the response status will be a 204. Thisindicates a successful request with no body returned.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • To retrieve a specific domain record, send a GET request to /v2/domains/$DOMAIN_NAME/records/$RECORD_ID.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • To update an existing record, send a PATCH request to/v2/domains/$DOMAIN_NAME/records/$DOMAIN_RECORD_ID. Any attribute valid forthe record type can be set to a new value for the record.See the attribute table for details regarding recordtypes and their respective attributes.

      Parameters

      • body: Domain_record

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • To update an existing record, send a PUT request to/v2/domains/$DOMAIN_NAME/records/$DOMAIN_RECORD_ID. Any attribute valid forthe record type can be set to a new value for the record.See the attribute table for details regarding recordtypes and their respective attributes.

      Parameters

      • body: Domain_record

        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