Listar amenazas
List threats for an organization using API key authentication
Inicio rápido
Autenticación
Incluye tu clave de API en el encabezadoX-API-KEY:
Solicitud de ejemplo
Esquema de la solicitud
Cuerpo de la solicitud
Bloqueos pendientes
Si la protección no está activa para tu organización, ChainPatrol igual revisa lo que encuentra, pero las amenazas confirmadas quedan en espera como Pending Blocked en lugar de aplicarse en la Blocklist (lista de bloqueo). De forma predeterminada se excluyen, porque este endpoint alimenta a los consumidores de la Blocklist. EstableceincludePending: true para incluirlas. Se devuelven con
pendingStatus: "BLOCKED", y su blockedAt indica cuándo se confirmó el bloqueo.
Configuración de ordenamiento
Cada objeto de ordenamiento debe tener la siguiente estructura:Campos de ordenamiento disponibles
"id"- Ordena por ID de la amenaza"blockedAt"- Ordena por el momento en que se bloqueó el asset"content"- Ordena por contenido de la amenaza"type"- Ordena por tipo de asset
Filtro por tipo de asset
El parámetroassetType acepta un arreglo de tipos de asset por los que filtrar:
Valores de tipo de asset disponibles
Valores de tipo de asset disponibles
"URL"- URL de sitios web"PAGE"- Páginas web"ADDRESS"- Direcciones de blockchain"LINKEDIN"- Perfiles de LinkedIn"TWITTER"- Perfiles/publicaciones de Twitter"FACEBOOK"- Perfiles/páginas de Facebook"YOUTUBE"- Canales/videos de YouTube"REDDIT"- Publicaciones/subreddits de Reddit"TELEGRAM"- Canales/grupos de Telegram"GOOGLE_APP_STORE"- Apps de Google Play Store"APPLE_APP_STORE"- Apps de Apple App Store"AMAZON_APP_STORE"- Apps de Amazon App Store"MICROSOFT_APP_STORE"- Apps de Microsoft Store"TIKTOK"- Perfiles de TikTok"INSTAGRAM"- Perfiles de Instagram"THREADS"- Perfiles de Threads"MEDIUM"- Artículos/perfiles de Medium"CHROME_WEB_STORE"- Extensiones de Chrome"MOZILLA_ADDONS"- Complementos de Firefox"OPERA_ADDONS"- Complementos de Opera"EMAIL"- Direcciones de correo electrónico"PATREON"- Perfiles de Patreon"OPENSEA"- Colecciones/perfiles de OpenSea"FARCASTER"- Perfiles de Farcaster"IPFS"- Hashes de IPFS"GOOGLE_FORM"- Formularios de Google Forms"WHATSAPP"- Contactos de WhatsApp"DISCORD_USER"- Usuarios de Discord"QUORA"- Perfiles/publicaciones de Quora"GITHUB"- Repositorios/perfiles de GitHub"TEACHABLE"- Cursos de Teachable"SUBSTACK"- Publicaciones de Substack"DEBANK"- Perfiles de DeBank"TAWK_TO"- Widgets de chat de Tawk.to"JOTFORM"- Formularios de JotForm"PRIMAL"- Perfiles de Primal"BLUESKY"- Perfiles de Bluesky"SNAPCHAT"- Perfiles de Snapchat"DESO"- Perfiles de DeSo"PINTEREST"- Perfiles/pines de Pinterest
Esquema de la respuesta
Cuerpo de la respuesta
Objeto de resultado de amenaza
Cada elemento del arreglothreats tiene la siguiente estructura:
Ejemplo de respuesta completa
Control de acceso
La API aplica un control de acceso estricto según tu clave de API:-
Claves de API de organización:
- Solo pueden acceder a las amenazas de su organización asociada
- Devuelven solo las amenazas que fueron bloqueadas por la organización
- Ejemplo: una clave de API de “acme-org” solo puede consultar las amenazas bloqueadas por “acme-org”
-
Claves de API de usuario:
- Pueden acceder a las amenazas de cualquier organización de la que el usuario sea miembro
- Requieren que el usuario sea un miembro activo de la organización consultada
Comportamiento predeterminado
- Rango de fechas: Si no se proporciona
startDateniendDate, la API devuelve de forma predeterminada las amenazas del último día. Si solo se envíastartDate,endDatetoma como valor predeterminado el momento actual; si solo se envíaendDate,startDatetoma como valor predeterminado un día antes de esa fecha - Bloqueos pendientes: Se excluyen a menos que
includePendingseatrue - Paginación: Si no se proporciona
next_page, devuelve la primera página de resultados - Ordenamiento: De forma predeterminada ordena por
iden orden ascendente - Tamaño de página: De forma predeterminada son 10 resultados por página (máx. 100)
Implementación de ejemplo
Autorizaciones
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.
Cuerpo
List threats request body
Defaults to getting all threats in the last 1 day.
You can also choose a startDate and endDate for the range of threat updates, most
timestamp formats should work, we use Luxon
for parsing the dates.
Filter by asset types
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 Also return threats confirmed malicious but not yet enforced because protection is not active for your organization (shown as "Pending Blocked" in the ChainPatrol app). These carry pendingStatus: BLOCKED. Defaults to false, which returns only assets on the blocklist.