Preview the first page a register configuration would import
const url = 'https://api.adversarial.com/api/v1/integrations/example/connections/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/instances/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/preview';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://api.adversarial.com/api/v1/integrations/example/connections/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/instances/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/previewFetches items from the provider without writing anything. Exactly one of the response lists is present, matching the configuration’s capability.
Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Provider slug
Connection identifier
Configuration identifier
Responses
Section titled “Responses”Items the configuration would import
A sample of provider items a register configuration would import.
Exactly one list is present, matching the configuration’s capability.
object
Provider records the scan passed over because a sync has already imported them. An empty sample with none of these means nothing matched the configuration.
Incident entries, present for an incident-register configuration.
Relationship, core incident information
object
A User as returned by the API.
Profile images are not embedded — clients fetch them from
GET /api/v1/{icon} when icon is Some.
object
Relative path to the user’s avatar endpoint, e.g.
"users/{id}/avatar?v={hash}". None when the user has no avatar.
A User as returned by the API.
Profile images are not embedded — clients fetch them from
GET /api/v1/{icon} when icon is Some.
object
Relative path to the user’s avatar endpoint, e.g.
"users/{id}/avatar?v={hash}". None when the user has no avatar.
When set, this incident is linked under the named parent incident.
Where the incident was reported from (e.g. “Employee Reported”). Always present.
The status of an incident
A User as returned by the API.
Profile images are not embedded — clients fetch them from
GET /api/v1/{icon} when icon is Some.
object
Relative path to the user’s avatar endpoint, e.g.
"users/{id}/avatar?v={hash}". None when the user has no avatar.
Risk entries, present for a risk-register configuration.
The core view of an Organization Risk (RSK).
Relational data — threat objectives, comments, incident associations, and tags —
is exposed on RiskRegisterEntry, not here.
object
A User as returned by the API.
Profile images are not embedded — clients fetch them from
GET /api/v1/{icon} when icon is Some.
object
Relative path to the user’s avatar endpoint, e.g.
"users/{id}/avatar?v={hash}". None when the user has no avatar.
A User as returned by the API.
Profile images are not embedded — clients fetch them from
GET /api/v1/{icon} when icon is Some.
object
Relative path to the user’s avatar endpoint, e.g.
"users/{id}/avatar?v={hash}". None when the user has no avatar.
When set, this risk is linked under the named parent risk.
The status of a risk
The class of a risk. When a new risk leaves it out, it is Control Deficiency.
Code: A security defect in source code the organization writes and maintainsConfiguration: A risk that is related to configuration of a systemControl Deficiency: A control that is not implemented or is not effectivePolicy: A weakness or gap in policy, or non-compliance with policy — including an exception granted by the organizationProcedural: A gap in process or human practice — how work is actually carried outVulnerability: A known, published vulnerability (typically a CVE) identified externally, usually in a third-party or open-source dependencyThird-party: Risk arising from a vendor or external service itself — its security practices, its access to your systems, or its posture
A User as returned by the API.
Profile images are not embedded — clients fetch them from
GET /api/v1/{icon} when icon is Some.
object
Relative path to the user’s avatar endpoint, e.g.
"users/{id}/avatar?v={hash}". None when the user has no avatar.
Whether the page or time limit stopped the scan before the sample was filled. More records may be available; run a sync to import all available records.
Example
{ "incidents": [ { "id": "INC-00001", "parent_id": "INC-00001", "severity": "SEV-5", "status": "New" } ], "risks": [ { "id": "RSK-00001", "impact": "Very Low", "initially_reported_urgency": "Critical", "likelihood": "Remote", "parent_id": "RSK-00001", "status": "New", "type": "Code", "urgency": "Info" } ]}Configuration has no register capability or the connection is not connected
Missing the read permission of the configuration’s register
Unknown provider, connection, or configuration