Preview the first page a register configuration would import

GET

/v1/integrations/{provider}/{installation_id}/configs/{config_id}/preview

const url = 'https://api.adversarial.com/api/v1/integrations/example/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/configs/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/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/configs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/preview

Fetches items from the provider without writing anything. Exactly one of the response lists is present, matching the configuration’s capability.

Parameters

Path Parameters

provider

required

string

Provider slug

installation_id

required

string format: uuid

Installation identifier

config_id

required

string format: uuid

Configuration identifier

Responses

200

Items the configuration would import

application/json

A sample of provider items a register configuration would import.

Exactly one list is present, matching the configuration’s capability.

object

incidents

Incident entries, present for an incident-register configuration.

Array<object> | null

Relationship, core incident information

object

assigned_to

One of:

object
null

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

email

required

string

first_name

required

string

icon

Relative path to the user’s avatar endpoint, e.g. "users/{id}/avatar?v={hash}". None when the user has no avatar.

string | null

required

string format: uuid

last_name

required

string

contained_date

string | null format: date-time

created_date

required

string format: date-time

description

required

string

detected_date

required

string format: date-time

required

string

occurred_date

string | null format: date-time

opened_by

required

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

email

required

string

first_name

required

string

icon

Relative path to the user’s avatar endpoint, e.g. "users/{id}/avatar?v={hash}". None when the user has no avatar.

string | null

required

string format: uuid

last_name

required

string

parent_id

When set, this incident is linked under the named parent incident.

string | null

responded_date

string | null format: date-time

severity

One of:

string
null

string

Allowed values: SEV-5 SEV-4 SEV-3 SEV-2 SEV-1

severity_reasoning

string | null

source

required

Where the incident was reported from (e.g. “Employee Reported”). Always present.

string

status

required

The status of an incident

string

Allowed values: New In Progress Review Closed

title

required

string

updated_by

required

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

email

required

string

first_name

required

string

icon

Relative path to the user’s avatar endpoint, e.g. "users/{id}/avatar?v={hash}". None when the user has no avatar.

string | null

required

string format: uuid

last_name

required

string

updated_date

required

string format: date-time

risks

Risk entries, present for a risk-register configuration.

Array<object> | null

The core view of an Organization Risk (RSK).

Relational data — threat objectives, comments, incident associations, and tags — is exposed on RiskRegisterEntry, not here.

object

assigned_to

One of:

object
null

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

email

required

string

first_name

required

string

icon

Relative path to the user’s avatar endpoint, e.g. "users/{id}/avatar?v={hash}". None when the user has no avatar.

string | null

required

string format: uuid

last_name

required

string

closed_date

string | null format: date-time

control_statement

string | null

created_date

required

string format: date-time

deleted_date

string | null format: date-time

description

required

string

discovered_date

required

string format: date-time

due_date

string | null format: date-time

expected_date

string | null format: date-time

required

string

impact

One of:

string
null

string

Allowed values: Very Low Low Medium High Severe

impact_reasoning

string | null

initially_reported_urgency

One of:

string
null

string

Allowed values: Critical High Medium Low Info

likelihood

One of:

string
null

string

Allowed values: Remote Unlikely Possible Probable Imminent

likelihood_reasoning

string | null

opened_by

required

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

email

required

string

first_name

required

string

icon

Relative path to the user’s avatar endpoint, e.g. "users/{id}/avatar?v={hash}". None when the user has no avatar.

string | null

required

string format: uuid

last_name

required

string

parent_id

When set, this risk is linked under the named parent risk.

string | null

remediation_task

string | null

source

string | null

status

required

The status of a risk

string

Allowed values: New Urgency Proposed Remediation Closure Proposed Closed

title

required

string

type

required

string

Allowed values: Code Configuration Control Deficiency Policy Procedural Vulnerability Third-party

updated_by

required

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

email

required

string

first_name

required

string

icon

Relative path to the user’s avatar endpoint, e.g. "users/{id}/avatar?v={hash}". None when the user has no avatar.

string | null

required

string format: uuid

last_name

required

string

updated_date

required

string format: date-time

urgency

One of:

string
null

Derived from likelihood and impact. Null when either is missing.

string

Allowed values: Info Low Medium High Critical

truncated

required

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.

boolean

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"
    }
  ]
}

400

Configuration has no register capability or the installation is not connected

403

Missing the read permission of the configuration’s register

404

Unknown provider, installation, or configuration