---
title: "Status: API da plataforma"
description: "API da plataforma APIBrasil (Monitoramento de status). Os endpoints abaixo são os da conta e da operação do gateway."
lang: pt-BR
canonical: https://doc.apibrasil.io/apis/plataforma/status
markdown: https://doc.apibrasil.io/apis/plataforma/status.md
source: apibrasil-documentation
---

# Status: API da plataforma

> API da plataforma APIBrasil (Monitoramento de status). Os endpoints abaixo são os da conta e da operação do gateway.

- **Especificação OpenAPI:** https://doc.apibrasil.io/apis/plataforma/status/openapi.json

## Como chamar

**Endereço base:** `https://gateway.apibrasil.io/api/v2`

## Endpoints (3 endpoints)

### 1. GET https://app.apibrasil.io/status

Com esse endpoint é possivel obter o status da Plataforma

- **Método:** `GET`
- **Endereço:** `https://app.apibrasil.io/status`
- **Versão da rota:** v2

**Cabeçalhos**

| Cabeçalho | Valor |
| --- | --- |
| `Content-Type` | `application/json` |
| `Authorization` | `Bearer $APIBRASIL_TOKEN` |

**Em cURL**

```bash
curl -X GET "https://app.apibrasil.io/status" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $APIBRASIL_TOKEN"
```

**Resposta de exemplo, do catálogo**

```json
{
  "message": "API is up and running",
  "error": false
}
```

### 2. GET https://gateway.apibrasil.io/api/status

Com esse endpoint é possivel obter o status do Gateway

- **Método:** `GET`
- **Endereço:** `https://gateway.apibrasil.io/api/status`
- **Versão da rota:** v2

**Cabeçalhos**

| Cabeçalho | Valor |
| --- | --- |
| `Content-Type` | `application/json` |
| `Authorization` | `Bearer $APIBRASIL_TOKEN` |

**Em cURL**

```bash
curl -X GET "https://gateway.apibrasil.io/api/status" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $APIBRASIL_TOKEN"
```

**Resposta de exemplo, do catálogo**

```json
{
  "message": "API is up and running",
  "error": false
}
```

### 3. GET https://webhook.apibrasil.cloud/api/v1/status

Com esse endpoint é possivel obter o status do Webhook

- **Método:** `GET`
- **Endereço:** `https://webhook.apibrasil.cloud/api/v1/status`
- **Versão da rota:** v1

**Cabeçalhos**

| Cabeçalho | Valor |
| --- | --- |
| `Content-Type` | `application/json` |
| `Authorization` | `Bearer $APIBRASIL_TOKEN` |

**Em cURL**

```bash
curl -X GET "https://webhook.apibrasil.cloud/api/v1/status" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $APIBRASIL_TOKEN"
```

**Resposta de exemplo, do catálogo**

```json
{
  "message": "Webhook is working!",
  "error": false,
  "check": 14719
}
```

## Ver também

- Especificação OpenAPI: https://doc.apibrasil.io/apis/plataforma/status/openapi.json
- Catálogo de APIs: [Catálogo de APIs](https://doc.apibrasil.io/apis.md)
- SDKs oficiais: [SDKs oficiais](https://doc.apibrasil.io/sdks.md)
- Índice da documentação: https://doc.apibrasil.io/llms.txt
- Versão HTML desta página: https://doc.apibrasil.io/apis/plataforma/status