CyCognito Export Data API
The Export Data API from CyCognito — 6 operation(s) for export data.
OpenAPI Specification
openapi: 3.0.3
info:
version: 0.0.1
title: CyCognito API V1 Reference Assets Export Data 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. You can also manage the scope of your attack surface, attribute assets to organizations, and verify the identity of IP scans on your assets. Our legacy API (V0) documentation is available for download [here](https://platform.cycognito.com/CyCognito-API-V0-Reference.pdf). While V0 is still being supported, please note that this API is undergoing deprecation.
| Code | Name | Description |
|------|------|-------------|
| 200 | OK | Success |
| 400 | Bad Request | The request is malformed—e.g., the body cannot be properly parsed, expected fields are not included in the body, or unsupported request header values. |
| 403 | Access Restricted | There are insufficient permissions or a valid API key was not provided. |
| 404 | Not Found | The provided resource was not found. |
| 405 | Method Not Allowed | The HTTP method is not allowed for the given resource. |
| 415 | Unsupported Media Type | The request content type is not supported. |
| 5XX | | Server failure | |
'
tags:
- name: Export Data
paths:
/v1/export/request/{type}:
post:
description: Select a desired asset type to initiate a data export. The resulting *report_ID* can be subsequently used with the **Fetch export link** method (below) to fetch a download link for the complete asset data in CSV format.
security:
- apiAuth: []
summary: Initiate export
tags:
- Export Data
parameters:
- name: type
in: path
schema:
type: string
enum:
- ip
- domain
- cert
- webapp
- iprange
- issue
- org
required: true
description: The type of the entity whose data you want to export.
- name: truncate-fields
in: query
schema:
default: true
type: boolean
required: false
description: Caps the number of returned fields to a maximum of 32000 characters.
responses:
'200':
content:
application/json:
schema:
type: object
properties:
report-id:
description: Unique identifier for the export.
type: string
example: a123456b-cd78-910e-1f2g-34h56i789j10
required:
- report-id
/v1/export/get/{report_id}:
get:
description: Use the *report_ID* obtained from the **Initiate export** method (above) to generate a download link. Once acquired, this link enables you to access and download a CSV file containing detailed data of the assets by the initially chosen asset type.
security:
- apiAuth: []
summary: Fetch export link
tags:
- Export Data
parameters:
- name: report_id
in: path
schema:
type: string
required: true
description: Unique identifier for the export.
responses:
'200':
description: Returns the download link of the export (if any) and the export status.
content:
application/json:
schema:
type: object
properties:
export-status:
description: Indicates the status of the export task. When the response status is 200, it reflects the current task status, which can be *done* or other applicable values. When the response status is 400, the export status is *bad-request*.
anyOf:
- type: string
- type: 'null'
example: done
export-date:
description: The date and time at which the export and subsequent download link were generated.
anyOf:
- type: string
format: date-time
- type: 'null'
example: '2024-05-18T12:24:34.990Z'
download-link:
description: A generated link that enables you to access and download a CSV file containing detailed asset data.
anyOf:
- type: string
- type: 'null'
example: https://link-to-download-export/1234
required:
- export-status
- export-date
/v1/export/issue-to-pdf/request:
post:
description: 'Initiate the generation of a PDF report for a specified issue. This endpoint triggers the creation process and returns a unique report identifier for status tracking and retrieval. The `truncate_long_fields` parameter (default: true) controls whether long field values are truncated in the PDF for improved readability.'
security:
- apiAuth: []
summary: Initiate issue PDF export
tags:
- Export Data
requestBody:
content:
application/json:
schema:
type: object
properties:
id:
description: The unique identifier for the issue you wish to export to PDF. This is the `id` value from the "Search issues" endpoint response, including the `issue/` prefix.
allOf:
- type: string
example: issue/1.1.1.1-cve-2023-12345
team:
description: A team name, a request without this field will yield result of the team registered to the API key
type: string
example: Example Team
truncate-long-fields:
description: When set to true (default), long field values will be truncated in the PDF report to improve readability. When set to false, full field values will be included.
type: boolean
example: true
required:
- id
responses:
'200':
content:
application/json:
schema:
type: object
properties:
report-id:
description: Unique identifier for the export.
type: string
example: a123456b-cd78-910e-1f2g-34h56i789j10
required:
- report-id
/v1/export/issue-to-pdf/get/{report_id}:
get:
description: Check the status of your issue PDF export and retrieve the download link once available. This endpoint provides the status of the PDF generation process and, upon completion, the link to download the generated PDF report.
security:
- apiAuth: []
summary: Fetch issue PDF export link
tags:
- Export Data
parameters:
- name: report_id
in: path
schema:
type: string
required: true
description: Unique identifier for the export.
responses:
'200':
description: Returns the generated link that enables you to access and download the PDF file containing the detailed issue data, as well as the status of the export task.
content:
application/json:
schema:
type: object
properties:
export-status:
description: Indicates the status of the export task. When the response status is 200, it reflects the current task status, which can be *done* or other applicable values. When the response status is 400, the export status is *bad-request*.
anyOf:
- type: string
- type: 'null'
example: done
export-date:
description: The date and time at which the export and subsequent download link were generated.
anyOf:
- type: string
format: date-time
- type: 'null'
example: '2024-05-18T12:24:34.990Z'
download-link:
description: A generated link that enables you to access and download a CSV file containing detailed asset data.
anyOf:
- type: string
- type: 'null'
example: https://link-to-download-export/1234
required:
- export-status
- export-date
/v1/export/assets-to-pdf/request:
post:
description: 'Initiate the generation of a PDF report for a list of assets. This endpoint triggers the creation process and returns a unique report identifier for status tracking and retrieval. The `truncate_long_fields` parameter (default: true) controls whether long field values are truncated in the PDF for improved readability.'
security:
- apiAuth: []
summary: Initiate asset PDF export
tags:
- Export Data
requestBody:
content:
application/json:
schema:
type: object
properties:
asset-ids:
description: "A comma-separated list in which each item contains the unique ID for the assets you want to export. The unique ID corresponds to the `id` field (from the *Retrieve assets* response) and should be in the format `<asset_type>/<asset_id>`.\n \n*Examples:* `ip/1.1.1.1`, `domain/acme.com`"
type: array
items:
type: string
example:
- ip/1.2.3.4
- ip/127.0.0.1
- domain/example.com
truncate-long-fields:
description: When set to true (default), long field values will be truncated in the PDF report to improve readability. When set to false, full field values will be included.
type: boolean
example: true
required:
- asset-ids
responses:
'200':
content:
application/json:
schema:
type: object
properties:
report-id:
description: Unique identifier for the export.
type: string
example: a123456b-cd78-910e-1f2g-34h56i789j10
required:
- report-id
/v1/export/assets-to-pdf/get/{report_id}:
get:
description: Check the status of your asset PDF export and retrieve the download link once available. This endpoint provides the status of the PDF generation process and, upon completion, the link to download the generated PDF report.
security:
- apiAuth: []
summary: Fetch asset PDF export link
tags:
- Export Data
parameters:
- name: report_id
in: path
schema:
type: string
required: true
description: Unique identifier for the export.
responses:
'200':
description: Returns the generated link that enables you to access and download the PDF file containing the detailed asset data, as well as the status of the export task.
content:
application/json:
schema:
type: object
properties:
export-status:
description: Indicates the status of the export task. When the response status is 200, it reflects the current task status, which can be *done* or other applicable values. When the response status is 400, the export status is *bad-request*.
anyOf:
- type: string
- type: 'null'
example: done
export-date:
description: The date and time at which the export and subsequent download link were generated.
anyOf:
- type: string
format: date-time
- type: 'null'
example: '2024-05-18T12:24:34.990Z'
download-link:
description: A generated link that enables you to access and download a CSV file containing detailed asset data.
anyOf:
- type: string
- type: 'null'
example: https://link-to-download-export/1234
required:
- export-status
- export-date
components:
securitySchemes:
apiAuth:
type: apiKey
name: Authorization
in: header