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

    Interface AppsRequestBuilder

    Builds and executes requests for operations under /v2/apps

    interface AppsRequestBuilder {
        get metrics(): MetricsRequestBuilder;
        get propose(): ProposeRequestBuilder;
        get regions(): RegionsRequestBuilder;
        get tiers(): TiersRequestBuilder;
        byApp_Id(app_Id: string): App_ItemRequestBuilder;
        get(
            requestConfiguration?: RequestConfiguration<
                AppsRequestBuilderGetQueryParameters,
            >,
        ): Promise<undefined | Apps_response>;
        post(
            body: Apps_create_app_request,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | App_response>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<
                AppsRequestBuilderGetQueryParameters,
            >,
        ): RequestInformation;
        toPostRequestInformation(
            body: Apps_create_app_request,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): AppsRequestBuilder;
    }

    Hierarchy

    Index

    Accessors

    metrics propose regions tiers

    Methods

    byApp_Id get post toGetRequestInformation toPostRequestInformation withUrl

    Accessors

    Methods

    • List all apps on your account. Information about the current active deployment as well as any in progress ones will also be included for each app.

      Parameters

      Returns Promise<undefined | Apps_response>

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

      Create a new app by submitting an app specification. For documentation on app specifications (AppSpec objects), please refer to the product documentation.

      Parameters

      • body: Apps_create_app_request

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | App_response>

      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

    • List all apps on your account. Information about the current active deployment as well as any in progress ones will also be included for each app.

      Parameters

      Returns RequestInformation

    • Create a new app by submitting an app specification. For documentation on app specifications (AppSpec objects), please refer to the product documentation.

      Parameters

      • body: Apps_create_app_request

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • Parameters

      • rawUrl: string

      Returns AppsRequestBuilder

    Settings

    Member Visibility

    On This Page

    Accessors
    Methods