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

    Interface RollbackRequestBuilder

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

    interface RollbackRequestBuilder {
        get commit(): CommitRequestBuilder;
        get revert(): RevertRequestBuilder;
        get validate(): ValidateRequestBuilder;
        post(
            body: Apps_rollback_app_request,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | Apps_deployment_response>;
        toPostRequestInformation(
            body: Apps_rollback_app_request,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): RollbackRequestBuilder;
    }

    Hierarchy

    Index

    Accessors

    commit revert validate

    Methods

    post toPostRequestInformation withUrl

    Accessors

    Methods

    post

    • post(
          body: Apps_rollback_app_request,
          requestConfiguration?: RequestConfiguration<object>,
      ): Promise<undefined | Apps_deployment_response>

      Rollback an app to a previous deployment. A new deployment will be created to perform the rollback.The app will be pinned to the rollback deployment preventing any new deployments from being created,either manually or through Auto Deploy on Push webhooks. To resume deployments, the rollback must beeither committed or reverted.It is recommended to use the Validate App Rollback endpoint to double check if the rollback isvalid and if there are any warnings.

      Parameters

      • body: Apps_rollback_app_request

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | Apps_deployment_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

    • Rollback an app to a previous deployment. A new deployment will be created to perform the rollback.The app will be pinned to the rollback deployment preventing any new deployments from being created,either manually or through Auto Deploy on Push webhooks. To resume deployments, the rollback must beeither committed or reverted.It is recommended to use the Validate App Rollback endpoint to double check if the rollback isvalid and if there are any warnings.

      Parameters

      • body: Apps_rollback_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 RollbackRequestBuilder

    Settings

    Member Visibility

    On This Page

    Accessors
    Methods