> ## 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. # Turn an app on or off > Turns the app off (`scale: 0`) or on (`scale: 1`). Team permission: `manage`. ## OpenAPI ````yaml /spec/paas.yaml post /v1/projects/{project_id}/actions/scale 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=&project_id=&cmd= ``` - `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/projects/{project_id}/actions/scale: post: tags: - Configuration summary: Turn an app on or off description: >- Turns the app off (`scale: 0`) or on (`scale: 1`). Team permission: `manage`. operationId: scaleApp parameters: - $ref: '#/components/parameters/TeamID' - $ref: '#/components/parameters/AppName' requestBody: required: true content: application/json: schema: type: object required: - scale properties: scale: type: integer enum: - 0 - 1 example: scale: 0 responses: '200': description: Done. The response body is empty. '400': $ref: '#/components/responses/ValidationOrTeamIDError' '401': $ref: '#/components/responses/Unauthorized' '403': description: >- The app is on a free plan (`PLAN_UPGRADE_REQUIRED`), 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: >- Free plans are no longer available. Upgrade to a paid plan to continue. data: code: PLAN_UPGRADE_REQUIRED '404': description: The app doesn't exist, or is frozen or suspended. content: application/json: schema: $ref: '#/components/schemas/Error' 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' AppName: name: project_id in: path required: true description: The app's name. schema: type: string example: my-app responses: ValidationOrTeamIDError: description: >- The body or a parameter is invalid (`message` says which), or `teamID` isn't a valid ID. content: application/json: schema: $ref: '#/components/schemas/Error' examples: validation: summary: Invalid parameter value: statusCode: 400 error: Bad Request message: '"since" is required' invalidTeamID: summary: Invalid team ID value: statusCode: 400 error: Bad Request message: Invalid team ID. data: null Unauthorized: description: The API token is missing, invalid or expired. content: application/json: schema: $ref: '#/components/schemas/AuthError' example: error: Unauthorized. 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 securitySchemes: bearerAuth: type: http scheme: bearer description: 'Send your API token as `Authorization: Bearer `.' ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.