> ## 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. # Get resource usage over time > Returns one resource metric over time, per instance. The longer the range, the further apart the data points. How far back you can go depends on your bundle plan. Team permission: any project permission. ## OpenAPI ````yaml /spec/paas.yaml get /v1/projects/{project_id}/metrics/{stat} 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}/metrics/{stat}: get: tags: - Logs, Metrics & Events summary: Get resource usage over time description: >- Returns one resource metric over time, per instance. The longer the range, the further apart the data points. How far back you can go depends on your bundle plan. Team permission: any project permission. operationId: getMetrics parameters: - $ref: '#/components/parameters/TeamID' - $ref: '#/components/parameters/AppName' - name: stat in: path required: true description: >- `cpu`: fraction of the app's CPU limit. `memory`: bytes. `network-receive` and `network-transmit`: bytes per second. schema: type: string enum: - cpu - memory - network-receive - network-transmit - name: since in: query required: true description: Start of the range, in Unix seconds. schema: type: integer example: 1767168000 responses: '200': description: The metric over time. content: application/json: schema: type: object properties: end: type: integer description: End of the range (now), in Unix seconds. result: type: array items: type: object properties: applet: type: string description: The instance the values belong to. values: type: array description: >- `[timestamp, value]` pairs. The timestamp is in Unix seconds; the value is a string. items: type: array items: {} example: end: 1767254400 result: - applet: values: - - 1767254370 - '0.11' - - 1767254400 - '0.12' '400': $ref: '#/components/responses/ValidationOrTeamIDError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/TeamForbidden' '404': $ref: '#/components/responses/AppNotFound' '428': description: '`since` is further back than your bundle plan allows.' content: application/json: schema: $ref: '#/components/schemas/Error' example: statusCode: 428 error: Precondition Required message: The maximum allowed value for since is 30 days. data: null '503': $ref: '#/components/responses/TemporarilyUnavailable' 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. TeamForbidden: description: >- With `teamID`: you aren't a member of the team (`team_not_found`), or you don't have the required permission on this app (`no_permission`). content: application/json: schema: $ref: '#/components/schemas/Error' examples: teamNotFound: summary: Not a team member value: statusCode: 403 error: Forbidden message: Team not found data: code: team_not_found noPermission: summary: Missing permission value: statusCode: 403 error: Forbidden message: You do not have permission to access this resource. data: code: no_permission AppNotFound: description: The app doesn't exist. content: application/json: schema: $ref: '#/components/schemas/Error' example: statusCode: 404 error: Not Found message: Not Found data: null TemporarilyUnavailable: description: The data is temporarily unavailable. Try again later. content: application/json: schema: $ref: '#/components/schemas/Error' example: statusCode: 503 error: Service Unavailable message: Service Unavailable data: null 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.