Saltar al contenido principal
GET
List organization threats

Descripción general

Lista todos los assets (activos digitales: URL, direcciones, perfiles, apps, etc.) reportados para tu organización, ya sea por tu equipo o por ChainPatrol, junto con el estado en que se encuentra cada uno: todavía en investigación, escalado a ti, bloqueado o permitido, y qué tan avanzado va su takedown (solicitud de baja de contenido fraudulento). Úsalo para mantener una plataforma de inteligencia de amenazas, un SIEM o un sistema de tickets sincronizado con ChainPatrol. Recórrelo página por página una vez para hacer la carga inicial (backfill); después consulta periódicamente con updatedSince y haz un upsert de cada fila usando id. Para listar solo las amenazas confirmadas que se bloquearon en un rango de fechas, usa /threats/list. Para listar las detecciones sin confirmar, usa /detection/list.

Inicio rápido

Autenticación

Incluye tu clave de API en el encabezado X-API-KEY. Las claves de API de organización determinan la organización a partir de la clave, así que slug es opcional para ellas.

Solicitud de ejemplo

Parámetros de consulta

Estados del ciclo de vida

state resume los reportes de cada asset y la decisión que se tomó sobre él: Una decisión sobre el asset prevalece sobre los reportes abiertos: una vez que está bloqueado o permitido, state se queda ahí aunque alguien lo vuelva a reportar. Un asset que fue escalado, decidido y luego reportado otra vez vuelve a investigating. Las marcas de tiempo de cada amenaza:
  • firstReportedAt: el primer reporte para tu organización.
  • escalatedAt: la primera vez que el asset se escaló a tu organización, o null si nunca se escaló.
  • blockedAt: cuándo se bloqueó el asset, o null.
  • takedown: null hasta que se abre un takedown. submittedAt es la primera vez que se presentó ante un proveedor, y completedAt la primera vez que se completó. Si el sitio vuelve a aparecer, el takedown se reabre: status vuelve a IN_PROGRESS mientras que completedAt conserva la primera finalización. Vigila status para detectar reapariciones.
  • updatedAt: el cambio más reciente en el asset, sus reportes o su takedown. Este es el valor contra el que se compara updatedSince.

Consultar cambios periódicamente

  1. Carga inicial (backfill). Llama sin updatedSince y sigue next_page hasta que sea null. Anota la hora en que empezaste.
  2. Consulta periódica (polling). Envía updatedSince con un valor unos minutos anterior al inicio de tu última sincronización exitosa, y sigue next_page hasta que sea null, manteniendo el mismo updatedSince en cada página. Haz un upsert de cada amenaza usando id.
  3. Avanza. Usa la hora de inicio de esta sincronización como marca de referencia (watermark) para la siguiente.
Superpón tus ventanas de tiempo por unos minutos. De lo contrario, un cambio escrito mientras se ejecuta una solicitud puede quedar entre dos consultas. La superposición vuelve a enviar algunas amenazas que ya tienes, algo que un upsert absorbe.
Las páginas se ordenan por el id del asset, de forma ascendente, y el cursor es el último id devuelto, así que los assets reportados a mitad de la sincronización quedan en páginas posteriores en lugar de desplazar las anteriores. Una página puede contener menos amenazas que per_page mientras next_page todavía tiene un valor; continúa hasta que next_page sea null.

Autorizaciones

X-API-KEY
string
header
requerido

Your API key. This is required by most endpoints to access our API programatically. Reach out to us at support@chainpatrol.io to get an API key for your use.

Parámetros de consulta

slug
string
updatedSince
string
assetType
enum<string>
Opciones disponibles:
URL,
PAGE,
ADDRESS,
DISCORD,
LINKEDIN,
TWITTER,
FACEBOOK,
YOUTUBE,
REDDIT,
TELEGRAM,
GOOGLE_APP_STORE,
APPLE_APP_STORE,
AMAZON_APP_STORE,
MICROSOFT_APP_STORE,
TIKTOK,
INSTAGRAM,
THREADS,
MEDIUM,
CHROME_WEB_STORE,
MOZILLA_ADDONS,
OPERA_ADDONS,
EMAIL,
PATREON,
OPENSEA,
FARCASTER,
IPFS,
GOOGLE_FORM,
WHATSAPP,
DISCORD_USER,
QUORA,
GITHUB,
TEACHABLE,
SUBSTACK,
DEBANK,
TAWK_TO,
JOTFORM,
PRIMAL,
BLUESKY,
SNAPCHAT,
DESO,
PINTEREST,
FLICKR,
GALXE,
VELOG,
NPM,
PYPI,
HEX,
DOCKER_HUB,
VOCAL_MEDIA,
TECKFINE,
TENDERLY,
HACKMD,
ETSY,
ZAZZLE,
BASENAME,
BILIBILI_TV,
VIMEO,
DAILYMOTION,
PHONE_NUMBER,
SLACK,
CALENDLY,
NGROK,
RARIBLE,
RUST_PACKAGE,
FLATHUB,
VIDLII,
VEVIOZ,
ISSUU,
SOUNDCLOUD,
ZAPPER,
REDNOTE,
SAMSUNG_APP_STORE,
HUAWEI_APP_STORE,
XIAOMI_APP_STORE,
TENCENT_APP_STORE,
OPPO_APP_STORE,
VIVO_APP_STORE,
F_DROID,
GOOGLE_AD,
BING_AD,
TWITCH,
BEHANCE,
ZORA,
META_AD,
SIGNAL,
DEVIANTART,
BANDCAMP,
ARCHIVE_ORG,
FIVE_HUNDRED_PX,
LUMA,
SMARTMONEYMATCH,
APK_GOLD,
GLASSDOOR,
PUMP_FUN,
TUMBLR,
MASTODON
per_page
integer
predeterminado:100

The number of threats to return per page (max 1000)

Rango requerido: 1 <= x <= 1000
next_page
string | null

Cursor for fetching the next page of results

Respuesta

Successful response

Successful operation

threats
object[]
requerido
next_page
string | null

Cursor for fetching the next page of results, or null on the last page. Drain it to null before advancing your updatedSince watermark — see updatedAt.