> ## Documentation Index
> Fetch the complete documentation index at: https://developers.liara.ir/llms.txt
> Use this file to discover all available pages before exploring further.

# Roll back to a release

> Redeploys an earlier successful release from the last 6 months, with the environment variables it had. The app must be active and your bundle plan must support rollback. Team permission: `deploy`, `operate` or `manage`.



## OpenAPI

````yaml /spec/paas.yaml post /v1/releases/{releaseID}/rollback
openapi: 3.0.1
info:
  title: Apps & Deployments
  version: 1.0.0
  description: >
    Create apps, deploy them, change their plans and settings, and read

    their logs, metrics and events.


    ## Identifying an app


    Most endpoints identify an app by its **name** (`project_id`, for

    example `my-app`). Some use its **ID** instead (`projectID`, the
    24-character

    `_id` returned when you create or list apps). Each endpoint says which one

    it expects.


    ## Deploying


    1. Upload your source code as a `.tar.gz` or `.zip` archive with
       `POST /v2/projects/{project_id}/sources`. You get a `sourceID`.
    2. Create a release with `POST /v2/projects/{project_id}/releases`, passing
       the `sourceID`. For `docker` apps you can pass a ready-made `image`
       instead.
    3. Follow the build with `GET /v2/releases/{releaseID}/build-logs` and
       check the release `state` with `GET /v1/releases/{releaseID}` until it's
       `READY` (or `FAILED`, `CANCELED`, `TIMEDOUT` or `UNHEALTHY`).

    ## Interactive shell (WebSocket)


    Open a shell in a running app over WebSocket:


    ```text

    wss://api.liara.ir/v1/exec?token=<api-token>&project_id=<app-name>&cmd=<command>

    ```


    - `token`: your API token.

    - `project_id`: the app's name.

    - `cmd`: the command to run, for example `/bin/bash`. URL-encode it.

    - `teamID` (optional): the team that owns the app. You need the `operate`
      or `manage` permission on the app.

    Everything you send is passed to the command's input, and its output is

    sent back to you. If the app has never been deployed successfully, you get

    the message `Service does not exist yet. You should have at least one

    successful release.` and the connection closes. The handshake fails with

    `401` for a missing or invalid token, `400` if `project_id` or `cmd` is

    missing or `teamID` is invalid, `403` without access to the team or app,

    and `404` if the app doesn't exist.


    ## Team permissions


    With `teamID`, each endpoint needs one of the project permissions it lists

    (`view`, `deploy`, `operate` or `manage`). A permission from your role or

    a resource permission on that app both count.
servers:
  - url: https://api.liara.ir
security:
  - bearerAuth: []
tags:
  - name: Apps
    description: Create, list, inspect and delete apps.
  - name: Configuration
    description: Environment variables, port, DNS servers, plans and scaling.
  - name: Settings
    description: >-
      Read-only filesystem, default subdomain, zero-downtime deployment and
      fixed outbound IP.
  - name: Deployments
    description: Upload source code, create releases, follow builds and roll back.
  - name: Logs, Metrics & Events
    description: Runtime logs, resource usage and lifecycle events.
  - name: Networks
    description: Private networks that apps and databases are created in.
paths:
  /v1/releases/{releaseID}/rollback:
    post:
      tags:
        - Deployments
      summary: Roll back to a release
      description: >-
        Redeploys an earlier successful release from the last 6 months, with the
        environment variables it had. The app must be active and your bundle
        plan must support rollback. Team permission: `deploy`, `operate` or
        `manage`.
      operationId: rollbackRelease
      parameters:
        - $ref: '#/components/parameters/TeamID'
        - $ref: '#/components/parameters/ReleaseID'
      responses:
        '200':
          description: The rollback started. The response body is empty.
        '400':
          description: '`teamID` is invalid, or the release isn''t a successful deployment.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: >-
            The app isn't active, or, with `teamID`, you aren't a member
            (`team_not_found`) or lack the permission (`no_permission`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                statusCode: 403
                error: Forbidden
                message: The project must be active.
                data: null
        '404':
          description: No release with this ID from the last 6 months.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: The release is already running.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                statusCode: 409
                error: Conflict
                message: You can not rollback to the current active release.
                data: null
        '428':
          description: Your bundle plan doesn't support rollback.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                statusCode: 428
                error: Precondition Required
                message: The project does not support rollback.
                data:
                  code: rollback_not_supported
components:
  parameters:
    TeamID:
      name: teamID
      in: query
      required: false
      description: >-
        Run the request in the context of a team you belong to, instead of your
        personal account.
      schema:
        $ref: '#/components/schemas/ObjectID'
      example: '000000000000000000000002'
    ReleaseID:
      name: releaseID
      in: path
      required: true
      schema:
        $ref: '#/components/schemas/ObjectID'
      example: '000000000000000000000170'
  schemas:
    Error:
      type: object
      description: Standard error body.
      properties:
        statusCode:
          type: integer
        error:
          type: string
          description: HTTP status text.
        message:
          type: string
          description: What went wrong.
        data:
          type: object
          nullable: true
          description: >-
            Extra details. When present, `code` is a stable, machine-readable
            error code.
          properties:
            code:
              type: string
    ObjectID:
      type: string
      pattern: ^[0-9a-fA-F]{24}$
      description: 24-character hexadecimal ID.
    AuthError:
      type: object
      description: Error body returned when the API token is rejected.
      properties:
        error:
          type: string
  responses:
    Unauthorized:
      description: The API token is missing, invalid or expired.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AuthError'
          example:
            error: Unauthorized.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Send your API token as `Authorization: Bearer <api-token>`.'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.