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

# Obter status da aplicação

> Coletar informações de status sobre sua aplicação.

<ParamField header="Authorization" type="string" placeholder="Chave da API" required>
  A chave da API para sua conta. Você pode encontrá-la nas [configurações da conta](https://squarecloud.app/pt-br/account/security).
</ParamField>

### Parâmetros

<ParamField path="app_id" type="string" placeholder="ID da Aplicação" required>
  O ID da aplicação. Você pode encontrá-lo na URL do painel da sua aplicação.
</ParamField>

<ParamField path="rawData" type="boolean" placeholder="true ou false">
  Retornar dados não-formatados. Verdadeiro, retorna os valores em bytes.
</ParamField>

### Resposta

<ResponseField name="status" type="string">
  Indica se a chamada foi bem-sucedida. `success` se bem-sucedida, `error` se não.
</ResponseField>

<ResponseField name="code" type="string">
  O código de status da resposta.
</ResponseField>

<ResponseField name="response" type="object">
  O conteúdo da resposta.

  <Expandable title="Alternar objeto">
    <ResponseField name="cpu" type="string">
      O uso de CPU da aplicação.
    </ResponseField>

    <ResponseField name="ram" type="string">
      O uso de RAM da aplicação.
    </ResponseField>

    <ResponseField name="status" type="string">
      O status da aplicação.
    </ResponseField>

    <ResponseField name="running" type="boolean">
      Indica se a aplicação está atualmente em execução.
    </ResponseField>

    <ResponseField name="storage" type="string">
      O armazenamento usado pela aplicação.
    </ResponseField>

    <ResponseField name="network" type="object">
      <Expandable title="Alternar objeto">
        <ResponseField name="total" type="string">
          O uso total de rede da aplicação.
        </ResponseField>

        <ResponseField name="now" type="string">
          O uso de rede atual da aplicação.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="uptime" type="number">
      O tempo de atividade (uptime) da aplicação em milissegundos.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseExample>
  ```json theme={null}
  {
      "status": "success",
      "response": {
          "cpu": "0.01%",
          "ram": "31.79",
          "status": "running",
          "running": true,
          "storage": "2.72MB",
          "network": {
              "total": "602 KB ↑ 134 KB ↓",
              "now": "14 KB ↑ 3.3 KB ↓"
          },
          "uptime": 1662927833666
      }
  }
  ```
</ResponseExample>