Guarita · Schema

ScanCreateRequest

Corpo de `POST /scans`. Só `target` é obrigatório; o resto são as opções da tela, com os mesmos padrões. Booleanos aceitam `true`/`false` e as strings `"true"`/`"false"`.

Company

Properties

Name Type Description
target string URL completa do alvo, começando com `http://` ou `https://`.
ai boolean Análise com IA: explica cada achado e entrega o conserto pronto. Consome 1 análise da cota do mês e exige app verificado.
infra boolean Descoberta e sondagem da infraestrutura por trás do app (Supabase, Firebase, clouds). Só leitura.
authenticated boolean Testes autenticados: a Guarita cria um usuário de teste no seu app e checa, por dentro, se dá pra ver dados de outras pessoas. Exige plano com o recurso (Pro+) e app verificado. Pode disparar o e-mail
aggressive boolean Modo agressivo: confirma as brechas explorando de verdade — cria, altera e apaga dados de teste (e limpa depois). Liga sozinho `authenticated` e `infra`. Exige plano com o recurso (Pro+), app verifica
authorized_intrusive boolean Só é lido com `aggressive: true`: a sua confirmação, POR RONDA, de que tem autorização expressa pra testes intrusivos neste alvo — os Termos (§2) exigem. Sem ela, `400 intrusive_unauthorized`.
lgpd boolean Pré-diagnóstico LGPD: consentimento de cookies, rastreadores, política de privacidade, dado pessoal exposto e dados saindo do país. Exige plano com o recurso (Pro+). São sinais técnicos — não é parece
infra_scope array Outros endereços SEUS que o app usa (`api.`, `cdn.`…), pra entrarem na sondagem de infra. Array de hostnames ou uma string separada por vírgula. Só o que é seu ou que você tem permissão de testar.
additional_instructions string Instruções adicionais para a análise com IA: rotas, fluxos e hipóteses de teste, até 4.000 caracteres. Usadas com `ai: true`. Não incluem novos hosts no escopo; para isso, use `infra_scope`.
View JSON Schema on GitHub

JSON Schema

guarita-dev-scan-create-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/guarita-dev/json-schema/guarita-dev-scan-create-request-schema.json",
  "title": "ScanCreateRequest",
  "description": "Corpo de `POST /scans`. Só `target` é obrigatório; o resto são as opções da tela, com os mesmos padrões. Booleanos aceitam `true`/`false` e as strings `\"true\"`/`\"false\"`.",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/guarita-dev-openapi.json#/components/schemas/ScanCreateRequest",
  "type": "object",
  "properties": {
    "target": {
      "type": "string",
      "format": "uri",
      "description": "URL completa do alvo, começando com `http://` ou `https://`."
    },
    "ai": {
      "type": "boolean",
      "description": "Análise com IA: explica cada achado e entrega o conserto pronto. Consome 1 análise da cota do mês e exige app verificado.",
      "default": true
    },
    "infra": {
      "type": "boolean",
      "description": "Descoberta e sondagem da infraestrutura por trás do app (Supabase, Firebase, clouds). Só leitura.",
      "default": true
    },
    "authenticated": {
      "type": "boolean",
      "description": "Testes autenticados: a Guarita cria um usuário de teste no seu app e checa, por dentro, se dá pra ver dados de outras pessoas. Exige plano com o recurso (Pro+) e app verificado. Pode disparar o e-mail de boas-vindas do seu app. Pedir esta bateria já autoriza a criação da conta de teste naquela ronda; pra bloquear, marque \"Nunca\" em /settings/agent (daí vira `403 test_accounts_disabled`).",
      "default": false
    },
    "aggressive": {
      "type": "boolean",
      "description": "Modo agressivo: confirma as brechas explorando de verdade — cria, altera e apaga dados de teste (e limpa depois). Liga sozinho `authenticated` e `infra`. Exige plano com o recurso (Pro+), app verificado e `authorized_intrusive: true`. Prefira um ambiente de teste.",
      "default": false
    },
    "authorized_intrusive": {
      "type": "boolean",
      "description": "Só é lido com `aggressive: true`: a sua confirmação, POR RONDA, de que tem autorização expressa pra testes intrusivos neste alvo — os Termos (§2) exigem. Sem ela, `400 intrusive_unauthorized`.",
      "default": false
    },
    "lgpd": {
      "type": "boolean",
      "description": "Pré-diagnóstico LGPD: consentimento de cookies, rastreadores, política de privacidade, dado pessoal exposto e dados saindo do país. Exige plano com o recurso (Pro+). São sinais técnicos — não é parecer jurídico.",
      "default": false
    },
    "infra_scope": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "hostname"
      },
      "description": "Outros endereços SEUS que o app usa (`api.`, `cdn.`…), pra entrarem na sondagem de infra. Array de hostnames ou uma string separada por vírgula. Só o que é seu ou que você tem permissão de testar."
    },
    "additional_instructions": {
      "type": "string",
      "description": "Instruções adicionais para a análise com IA: rotas, fluxos e hipóteses de teste, até 4.000 caracteres. Usadas com `ai: true`. Não incluem novos hosts no escopo; para isso, use `infra_scope`."
    }
  },
  "required": [
    "target"
  ]
}

Work with this as data

Every JSON Schema 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 schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • 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 JSON Schema
curl "https://apis.io/api/v1/json-schemas/guarita-dev-scan-create-request"
All schemas
curl "https://apis.io/api/v1/json-schemas?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.