Discovery needs no key. Ratings and market analysis are Pro.
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.
openapi: 3.2.0
info:
version: 0.0.1
title: CyCognito API V1 Reference Realm API
description: The CyCognito API V1 is a REST API that allows you to post and get data from our main data entities—assets and issues.
tags:
- name: Realm
paths:
/v1/realm:
get:
description: Retrieve the date of the last data update, as well as the data update cadence (weekly, bi-weekly, monthly, or daily).
security:
- apiAuth: []
summary: Last data update
tags:
- Realm
responses:
'200':
content:
application/json:
schema:
type: object
properties:
id:
description: A unique identifier for the realm.
type: string
example: 12312-3213-12341
full-scan-cadence:
description: Indicates the frequency at which realm data is being updated.
type: string
enum:
- bi-weekly
- weekly
- monthly
- daily
- N/A
example: bi-weekly
last-full-update:
description: Indicates the date and time at which the realm received a data update.
type: string
example: Jun 21, 2024
last-daily-update:
description: Indicates the date and time at which the realm received the last data update.
type: string
example: Jun 21, 2024
assets-added-in-latest-baseline-update:
description: Indicates assets added in the latest baseline update. This data available for realms with Daily ports and services and without continuous updates
type: integer
example: '300'
ips-with-new-ports-in-last-day:
description: Indicates ips with new ports in last day. This data available for realms with Daily ports and services and without continuous updates
type: integer
example: '100'
assets-discovered-in-last-day:
description: Indicates assets discovered in the last day. This data available only for realms with continuous updates
type: integer
example: '200'
issues-detected-in-last-day:
description: Indicates on issues detected in the last day. This data available only for realms with continuous updates
type: integer
example: '100'
required:
- id
- full-scan-cadence
- last-full-update
- last-daily-update
operationId: getV1Realm
x-operation-id-source: derived
/v1/realm/asset-summary:
get:
description: Returns asset summary data for the current realm, including ASM package asset count, AST & EI active asset count, and number of performed rescans.
security:
- apiAuth: []
summary: Get asset summary for the realm (customer entitlements)
tags:
- Realm
responses:
'200':
content:
application/json:
schema:
type: object
properties:
realm-id:
description: The unique identifier of the realm.
type: string
asm-package-asset-count:
description: Total number of assets in the ASM package (IPs, Domains, Certificates, Web Applications).
type: integer
ast-ei-active-asset-count:
description: Total number of active assets in the AST & EI package (Active IPs and Active Web Applications).
type: integer
revalidations-count:
description: Number of performed revalidations for this realm.
type: integer
required:
- realm-id
- asm-package-asset-count
- ast-ei-active-asset-count
- revalidations-count
operationId: getV1RealmAssetSummary
x-operation-id-source: derived
components:
securitySchemes:
apiAuth:
type: apiKey
name: Authorization
in: header