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

    Interface WithRegistry_nameItemRequestBuilder

    Builds and executes requests for operations under /v2/registries/{registry_name}

    interface WithRegistry_nameItemRequestBuilder {
        get dockerCredentials(): DockerCredentialsRequestBuilder;
        get garbageCollection(): GarbageCollectionRequestBuilder;
        get garbageCollections(): GarbageCollectionsRequestBuilder;
        get repositories(): RepositoriesRequestBuilder;
        get repositoriesV2(): RepositoriesV2RequestBuilder;
        delete(requestConfiguration?: RequestConfiguration<object>): Promise<void>;
        get(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | WithRegistry_nameGetResponse>;
        toDeleteRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): WithRegistry_nameItemRequestBuilder;
    }

    Hierarchy

    Index

    Accessors

    dockerCredentials garbageCollection garbageCollections repositories repositoriesV2

    Methods

    delete get toDeleteRequestInformation toGetRequestInformation withUrl

    Accessors

    Methods

    • To delete your container registry, destroying all container image data stored in it, send a DELETE request to /v2/registries/{registry_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 information about any container registry in your account, send a GET request to /v2/registries/{registry_name}.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | WithRegistry_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 your container registry, destroying all container image data stored in it, send a DELETE request to /v2/registries/{registry_name}.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

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