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 Revalidation 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: Revalidation
paths:
/v1/revalidate:
post:
description: Trigger a revalidation on selected assets or asset groups (and by association, on their related issues).
security:
- apiAuth: []
summary: Initiate revalidation
tags:
- Revalidation
requestBody:
content:
application/json:
schema:
type: object
properties:
entity-ids:
description: A comma-separated list in which each item contains the unique ID for the assets and issues that you would like to revalidate. The unique ID corresponds to the `id` field (from the *Retrieve assets* and *Search issues* responses) and should be in the format `<asset_type>/<asset_id>` (for assets), or `issue/<affected_asset>-<issue_id>` (for issues).
type: array
items:
type: string
example:
- ip/1.1.1.1
- domain/example.com
- webapp/example.com
- issue/CVE-1234-56789
responses:
'200':
content:
application/json:
schema:
type: object
properties:
result:
description: Indicates the outcome of the revalidation request. When the response status is 200, displays *success*. When the response status is 400, displays *failed*.
type: string
example: success
revalidations-for-request:
description: The number of entity IDs included in the revalidation request.
type: integer
example: '123'
revalidations-left:
description: The remaining number of revalidations available for the realm. When the response status is 200, this number is updated post-action. When the response status is 400, it shows the initial count.
type: integer
example: '4567'
required:
- result
- revalidations-for-request
- revalidations-left
operationId: postV1Revalidate
x-operation-id-source: derived
components:
securitySchemes:
apiAuth:
type: apiKey
name: Authorization
in: header