Guarita Conta API

A chave e a conta dona dela.

GitHub OpenAPI

Operations 1

GET /me Confirma que a chave funciona #

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-conta-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-conta-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Guarita Conta 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: Conta
  description: A chave e a conta dona dela.
paths:
  /me:
    get:
      operationId: getMe
      tags:
      - Conta
      summary: Confirma que a chave funciona
      description: 'Ping autenticado: devolve a conta dona da chave, os escopos que ela carrega e o plano em vigor. É o primeiro request de toda integração nova — e o primeiro a rodar quando algo para de funcionar.


        Repare que exige `scans:read`: uma chave criada só com `apps:read` recebe `403` aqui, mesmo sendo válida. Nesse caso, teste com `GET /apps`.'
      security:
      - apiKey:
        - scans:read
      x-scope: scans:read
      responses:
        '200':
          description: A chave é válida.
          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/Me'
              example:
                account_id: acc_9f2c1b7e
                key_id: key_3a8d41c6
                scopes:
                - scans:read
                - scans:write
                - apps:read
                plan: pro
        '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:
    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.'
    Me:
      type: object
      properties:
        account_id:
          type: string
          example: acc_9f2c1b7e
          description: Id da conta dona da chave.
        key_id:
          type: string
          example: key_3a8d41c6
          description: Id da chave — o mesmo que aparece em Configurações → Desenvolvedores. Use no log da integração pra saber qual chave está rodando sem imprimir o segredo.
        scopes:
          type: array
          items:
            type: string
            enum:
            - scans:read
            - scans:write
            - apps:read
          description: Escopos da chave, fixados na criação.
        plan:
          type: string
          enum:
          - free
          - starter
          - pro
          - business
          example: pro
          description: 'Plano EFETIVO da conta agora — o mesmo que decide cota e recursos. Na prática vem `pro` ou `business`: sem API no plano, a chave nem autentica.'
      description: 'Identidade da chave: a conta, a chave, o que ela pode e o plano em vigor.'
      required:
      - account_id
      - key_id
      - scopes
      - plan
      example:
        account_id: acc_9f2c1b7e
        key_id: key_3a8d41c6
        scopes:
        - scans:read
        - scans:write
        - apps:read
        plan: pro
  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