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

    Interface App_ItemRequestBuilder

    Builds and executes requests for operations under /v2/apps/{app_-id}

    interface App_ItemRequestBuilder {
        get alerts(): AlertsRequestBuilder;
        get components(): ComponentsRequestBuilder;
        get deployments(): DeploymentsRequestBuilder;
        get health(): HealthRequestBuilder;
        get instances(): InstancesRequestBuilder;
        get logs(): LogsRequestBuilder;
        get metrics(): MetricsRequestBuilder;
        get restart(): RestartRequestBuilder;
        get rollback(): RollbackRequestBuilder;
        delete(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | Apps_delete_app_response>;
        get(
            requestConfiguration?: RequestConfiguration<
                App_ItemRequestBuilderGetQueryParameters,
            >,
        ): Promise<undefined | App_response>;
        put(
            body: Apps_update_app_request,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | App_response>;
        toDeleteRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<
                App_ItemRequestBuilderGetQueryParameters,
            >,
        ): RequestInformation;
        toPutRequestInformation(
            body: Apps_update_app_request,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): App_ItemRequestBuilder;
    }

    Hierarchy

    Index

    Accessors

    alerts components deployments health instances logs metrics restart rollback

    Methods

    delete get put toDeleteRequestInformation toGetRequestInformation toPutRequestInformation withUrl

    Accessors

    Methods

    • Delete an existing app. Once deleted, all active deployments will be permanently shut down and the app deleted. If needed, be sure to back up your app specification so that you may re-create it at a later time.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | Apps_delete_app_response>

      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

    • Retrieve details about an existing app by either its ID or name. To retrieve an app by its name, do not include an ID in the request path. Information about the current active deployment as well as any in progress ones will also be included in the response.

      Parameters

      Returns Promise<undefined | App_response>

      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

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

      Parameters

      • body: Apps_update_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 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

    • Delete an existing app. Once deleted, all active deployments will be permanently shut down and the app deleted. If needed, be sure to back up your app specification so that you may re-create it at a later time.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • Retrieve details about an existing app by either its ID or name. To retrieve an app by its name, do not include an ID in the request path. Information about the current active deployment as well as any in progress ones will also be included in the response.

      Parameters

      Returns RequestInformation

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

      Parameters

      • body: Apps_update_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 App_ItemRequestBuilder

    Settings

    Member Visibility

    On This Page

    Accessors
    Methods