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

    Interface RegistryRequestBuilder

    Builds and executes requests for operations under /v2/registry

    interface RegistryRequestBuilder {
        get dockerCredentials(): DockerCredentialsRequestBuilder;
        get optionsPath(): OptionsRequestBuilder;
        get subscription(): SubscriptionRequestBuilder;
        get validateName(): ValidateNameRequestBuilder;
        byRegistry_name(registry_name: string): WithRegistry_nameItemRequestBuilder;
        delete(requestConfiguration?: RequestConfiguration<object>): Promise<void>;
        get(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | RegistryGetResponse>;
        post(
            body: Registry_create,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | RegistryPostResponse>;
        toDeleteRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toPostRequestInformation(
            body: Registry_create,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): RegistryRequestBuilder;
    }

    Hierarchy

    Index

    Accessors

    dockerCredentials optionsPath subscription validateName

    Methods

    byRegistry_name delete get post toDeleteRequestInformation toGetRequestInformation toPostRequestInformation withUrl

    Accessors

    Methods

    • To delete your container registry, destroying all container image data stored in it, send a DELETE request to /v2/registry.This operation is not compatible with multiple registries in a DO account. You should use /v2/registries/{registry_name} instead.

      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 412 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 your container registry, send a GET request to /v2/registry.This operation is not compatible with multiple registries in a DO account. You should use /v2/registries/{registry_name} instead.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | RegistryGetResponse>

      error when the service returns a 401 status code

      error when the service returns a 412 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: Registry_create,
          requestConfiguration?: RequestConfiguration<object>,
      ): Promise<undefined | RegistryPostResponse>

      To create your container registry, send a POST request to /v2/registry.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: Registry_create

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | RegistryPostResponse>

      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 delete your container registry, destroying all container image data stored in it, send a DELETE request to /v2/registry.This operation is not compatible with multiple registries in a DO account. You should use /v2/registries/{registry_name} instead.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • To get information about your container registry, send a GET request to /v2/registry.This operation is not compatible with multiple registries in a DO account. You should use /v2/registries/{registry_name} instead.

      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/registry.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: Registry_create

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • Parameters

      • rawUrl: string

      Returns RegistryRequestBuilder

    Settings

    Member Visibility

    On This Page

    Accessors
    Methods