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

    Interface RegistriesRequestBuilder

    Builds and executes requests for operations under /v2/registries

    interface RegistriesRequestBuilder {
        get optionsPath(): OptionsRequestBuilder;
        get subscription(): SubscriptionRequestBuilder;
        get validateName(): ValidateNameRequestBuilder;
        byRegistry_name(registry_name: string): WithRegistry_nameItemRequestBuilder;
        get(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | RegistriesGetResponse>;
        post(
            body: Multiregistry_create,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | RegistriesPostResponse>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toPostRequestInformation(
            body: Multiregistry_create,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): RegistriesRequestBuilder;
    }

    Hierarchy

    Index

    Accessors

    optionsPath subscription validateName

    Methods

    byRegistry_name get post toGetRequestInformation toPostRequestInformation withUrl

    Accessors

    Methods

    • To get information about any container registry in your account, send a GET request to /v2/registries/.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | RegistriesGetResponse>

      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: Multiregistry_create,
          requestConfiguration?: RequestConfiguration<object>,
      ): Promise<undefined | RegistriesPostResponse>

      To create your container registry, send a POST request to /v2/registries.The name becomes part of the URL for images stored in the registry. Forexample, if your registry is called example, an image in it will have theURL registry.digitalocean.com/example/image:tag.

      Parameters

      • body: Multiregistry_create

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | RegistriesPostResponse>

      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 information about any container registry in your account, send a GET request to /v2/registries/.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • To create your container registry, send a POST request to /v2/registries.The name becomes part of the URL for images stored in the registry. Forexample, if your registry is called example, an image in it will have theURL registry.digitalocean.com/example/image:tag.

      Parameters

      • body: Multiregistry_create

        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