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

    Interface SubscriptionRequestBuilder

    Builds and executes requests for operations under /v2/registry/subscription

    interface SubscriptionRequestBuilder {
        get(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | SubscriptionGetResponse>;
        post(
            body: SubscriptionPostRequestBody,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | SubscriptionPostResponse>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toPostRequestInformation(
            body: SubscriptionPostRequestBody,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): SubscriptionRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    get post toGetRequestInformation toPostRequestInformation withUrl

    Methods

    • A subscription is automatically created when you configure your container registry. To get information about your subscription, send a GET request to /v2/registry/subscription.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | SubscriptionGetResponse>

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

      After creating your registry, you can switch to a different subscription tier to better suit your needs. To do this, send a POST request to /v2/registry/subscription.

      Parameters

      • body: SubscriptionPostRequestBody

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | SubscriptionPostResponse>

      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

    • A subscription is automatically created when you configure your container registry. To get information about your subscription, send a GET request to /v2/registry/subscription.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • After creating your registry, you can switch to a different subscription tier to better suit your needs. To do this, send a POST request to /v2/registry/subscription.

      Parameters

      • body: SubscriptionPostRequestBody

        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