---
title: "Status: platform API"
description: "APIBrasil platform API (Status monitoring). The endpoints below are the account and operation routes of the gateway."
lang: en
canonical: https://doc.apibrasil.io/apis/plataforma/status
markdown: https://doc.apibrasil.io/apis/plataforma/status.md
source: apibrasil-documentation
---

# Status: platform API

> APIBrasil platform API (Status monitoring). The endpoints below are the account and operation routes of the gateway.

- **OpenAPI specification:** https://doc.apibrasil.io/apis/plataforma/status/openapi.json

## How to call

**Base address:** `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

- **Method:** `GET`
- **Address:** `https://app.apibrasil.io/status`
- **Route version:** v2

**Headers**

| Header | Value |
| --- | --- |
| `Content-Type` | `application/json` |
| `Authorization` | `Bearer $APIBRASIL_TOKEN` |

**In cURL**

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

**Sample response, from the catalog**

```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

- **Method:** `GET`
- **Address:** `https://gateway.apibrasil.io/api/status`
- **Route version:** v2

**Headers**

| Header | Value |
| --- | --- |
| `Content-Type` | `application/json` |
| `Authorization` | `Bearer $APIBRASIL_TOKEN` |

**In cURL**

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

**Sample response, from the catalog**

```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

- **Method:** `GET`
- **Address:** `https://webhook.apibrasil.cloud/api/v1/status`
- **Route version:** v1

**Headers**

| Header | Value |
| --- | --- |
| `Content-Type` | `application/json` |
| `Authorization` | `Bearer $APIBRASIL_TOKEN` |

**In cURL**

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

**Sample response, from the catalog**

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

## See also

- OpenAPI specification: https://doc.apibrasil.io/apis/plataforma/status/openapi.json
- API catalog: [API catalog](https://doc.apibrasil.io/apis.md)
- Official SDKs: [Official SDKs](https://doc.apibrasil.io/sdks.md)
- Documentation index: https://doc.apibrasil.io/llms.txt
- HTML version of this page: https://doc.apibrasil.io/apis/plataforma/status