Guarita Apps API

Os apps (hostnames) monitorados.

GitHub OpenAPI

Operations 1

GET /apps Lista os apps monitorados #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/guarita-dev:guarita-dev-apps-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

guarita-dev-apps-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Guarita Apps API
  version: '1.20261023'
  summary: Dispare rondas de segurança, leia relatórios e receba webhooks assinados.
  description: 'API pública da Guarita. Autenticada por chave (`gsk_…`) no header `Authorization: Bearer`, disponível nos planos Pro e Business.


    Documentação completa: https://www.guarita.dev/docs/api · Changelog: https://www.guarita.dev/docs/api/changelog'
  termsOfService: https://www.guarita.dev/legal/terms-of-use
  contact:
    name: Suporte Guarita
    email: help@guarita.dev
    url: https://www.guarita.dev/support
  x-updated-at: '2026-10-23'
servers:
- url: https://api.guarita.dev/v1/public
  description: Produção
security:
- apiKey: []
tags:
- name: Apps
  description: Os apps (hostnames) monitorados.
paths:
  /apps:
    get:
      operationId: listApps
      tags:
      - Apps
      summary: Lista os apps monitorados
      description: 'Os apps da conta. Um app entra aqui de duas formas: cadastrado no painel (nasce com `last_scan_at: null`) ou automaticamente na primeira ronda contra o hostname — pelo painel ou por `POST /scans`. Nos dois casos ocupa uma vaga do limite do plano.


        A lista não é paginada: o número de apps é limitado pelo plano (Pro: 10 · Business: sem limite), então cabe numa resposta.'
      security:
      - apiKey:
        - apps:read
      x-scope: apps:read
      responses:
        '200':
          description: Apps da conta.
          headers:
            x-request-id:
              description: Id da requisição — mande pro suporte ao reportar um problema.
              schema:
                type: string
                format: uuid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppList'
              example:
                data:
                - hostname: app.exemplo.com.br
                  created_at: '2026-05-14T09:21:44.108Z'
                  last_scan_at: '2026-08-27T14:09:24.106Z'
                  verified: true
                - hostname: staging.exemplo.com.br
                  created_at: '2026-07-02T18:40:02.771Z'
                  last_scan_at: null
                  verified: false
        '400':
          description: '`bad_request` — Corpo malformado (JSON inválido). O status acompanha o motivo: `413` com corpo acima de 1 MB, `415` com `Content-Type` que não seja JSON — o código `error` continua `bad_request`.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                bad_request:
                  summary: 'Corpo malformado (JSON inválido). O status acompanha o motivo: `413` com corpo acima de 1 MB, `415` com `Content-Type` que não seja JSON — o código `error` continua `bad_request`.'
                  value:
                    error: bad_request
                    message: Unexpected token i in JSON at position 2
        '401':
          description: '`unauthorized` — Chave ausente, fora do formato `Bearer gsk_…`, inexistente, revogada — ou o plano da conta deixou de incluir a API. O corpo é o MESMO em todos os casos, de propósito. Vem com o header `WWW-Authenticate`.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                unauthorized:
                  summary: Chave ausente, fora do formato `Bearer gsk_…`, inexistente, revogada — ou o plano da conta deixou de incluir a API. O corpo é o MESMO em todos os casos, de propósito. Vem com o header `WWW-Authenticate`.
                  value:
                    error: unauthorized
                    message: 'Chave de API ausente ou inválida. Envie `Authorization: Bearer gsk_...` — crie a sua em Configurações > Desenvolvedores.'
          headers:
            WWW-Authenticate:
              description: Sempre `Bearer realm="guarita", error="invalid_token"`.
              schema:
                type: string
        '403':
          description: '`insufficient_scope` — A chave é válida, mas não tem o escopo da rota.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                insufficient_scope:
                  summary: A chave é válida, mas não tem o escopo da rota.
                  value:
                    error: insufficient_scope
                    message: Esta chave não tem a permissão "scans:write".
                    required: scans:write
        '500':
          description: '`internal` — Erro nosso.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                internal:
                  summary: Erro nosso.
                  value:
                    error: internal
                    message: Erro interno.
components:
  schemas:
    AppList:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/App'
          description: Apps da conta, na ordem de cadastro.
      description: 'Lista de apps. Não é paginada: o número de apps é limitado pelo plano.'
      required:
      - data
    App:
      type: object
      properties:
        hostname:
          type: string
          format: hostname
          example: app.exemplo.com.br
          description: 'Hostname normalizado: minúsculo, sem `www` e sem porta.'
        created_at:
          type: string
          format: date-time
          description: Quando o app entrou na conta — string ISO 8601 em UTC (`2026-08-27T14:09:24.106Z`).
        last_scan_at:
          type:
          - string
          - 'null'
          format: date-time
          description: Última ronda contra este app. `null` = nunca escaneado.
        verified:
          type: boolean
          description: A propriedade do domínio já foi comprovada alguma vez (DNS TXT, arquivo, meta tag ou atestação de provedor). Não reconfere a validade de uma atestação — veja `domain_unverified`.
      description: Um app (hostname) monitorado pela conta.
      required:
      - hostname
      - created_at
      - last_scan_at
      - verified
      example:
        hostname: app.exemplo.com.br
        created_at: '2026-05-14T09:21:44.108Z'
        last_scan_at: '2026-08-27T14:09:24.106Z'
        verified: true
    Error:
      type: object
      properties:
        error:
          type: string
          enum:
          - bad_request
          - invalid_target
          - invalid_scan_instructions
          - intrusive_unauthorized
          - invalid_cursor
          - unauthorized
          - quota_exceeded
          - domain_limit
          - insufficient_scope
          - feature_locked
          - target_blocked
          - domain_unverified
          - test_accounts_disabled
          - not_found
          - domain_provider_conflict
          - rate_limited
          - internal
          example: unauthorized
          description: Código estável, feito pro seu código ler.
        message:
          type: string
          description: Texto em português, feito pra uma pessoa ler no log.
      description: Todo erro tem a mesma forma. Trate pelo `error`; mostre a `message`.
      required:
      - error
      - message
      example:
        error: unauthorized
        message: 'Chave de API ausente ou inválida. Envie `Authorization: Bearer gsk_...` — crie a sua em Configurações > Desenvolvedores.'
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      bearerFormat: gsk_<43 caracteres base64url>
      description: Chave de API criada em Configurações → Desenvolvedores. Cada operação exige o escopo indicado em `x-scope` (`scans:read`, `scans:write` ou `apps:read`).
externalDocs:
  description: Documentação da API
  url: https://www.guarita.dev/docs/api