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

    Interface ValidateNameRequestBuilder

    Builds and executes requests for operations under /v2/registry/validate-name

    interface ValidateNameRequestBuilder {
        post(
            body: Validate_registry,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<void>;
        toPostRequestInformation(
            body: Validate_registry,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): ValidateNameRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    post toPostRequestInformation withUrl

    Methods

    post

    • post(
          body: Validate_registry,
          requestConfiguration?: RequestConfiguration<object>,
      ): Promise<void>

      To validate that a container registry name is available for use, send a POSTrequest to /v2/registry/validate-name.If the name is both formatted correctly and available, the response code willbe 204 and contain no body. If the name is already in use, the response willbe a 409 Conflict.

      Parameters

      • body: Validate_registry

        The request body

      • 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 409 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 validate that a container registry name is available for use, send a POSTrequest to /v2/registry/validate-name.If the name is both formatted correctly and available, the response code willbe 204 and contain no body. If the name is already in use, the response willbe a 409 Conflict.

      Parameters

      • body: Validate_registry

        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