Simulates the execution of a Policy to verify its behavior without taking any actions. This endpoint evaluates all packages in the workspace, generating a "decision log" for each evaluation. Each log contains: - Package metadata provided to the policy engine at runtime. - Output from the user-defined Rego policy. No actions associated with the policy are executed. Instead, the endpoint reports what would happen to each package if the policy were active.
Response body
object
object
array of objects
object
object
object
The date and time the policy was created.
The description of the Policy.
The name of the Policy.
The rego code which constitutes the Policy logic.
If true, the policy is enabled.
If true and the policy matches, no further policies are evaluated.
The Policy identifier.
The date and time the policy was updated.
The version of the rego code.
The order in which this policy is evaluated relative to other policies.
Serializer for policy input.
object
Serializer for V0 policy input.
object
Serializer for packages for policy purposes.
object
array of objects
object
A textual description of this package.
Serializer for a distribution for policy purposes.
object
Serializer for a distribution version for policy purposes.
object
The textual name for this version.
The epoch of the package version (if any).
array of objects
object
The calculated size of the file.
Freeform descriptor that describes what the file is.
The license of this package.
The name of this package.
* `BINARY` - Binary * `SOURCE` - Source * `COMBINED` - Combined * `OTHER` - Other
The release of the package version (if any).
* `AWAITING_SCAN` - Awaiting Security Scan * `SCANNING` - Security Scanning in Progress * `VULNERABLE` - Scan Detected Vulnerabilities * `NOT_VULNERABLE` - Scan Detected No Vulnerabilities * `DISABLED` - Security Scanning Disabled * `FAILED` - Security Scanning Failed * `SKIPPED` - Security Scanning Skipped * `UNSUPPORTED_PACKAGE` - Security Scanning Not Supported * `UNSUPPORTED_FORMAT` - Security Scanning Not Supported
The datetime the security scanning status was updated.
The datetime the security scanning was started.
The datetime the security scanning was completed.
The calculated size of the package.
The public unique identifier for the package.
A one-liner synopsis of this package.
array of objects
object
The date this tag was created.
If true, the tag is immutable and cannot be (normally) removed.
The name for the tag.
* `AUTOMATIC` - Automatic * `MANUAL` - Manual
* `INFO` - Info * `SOME_VERSION` - Some Version * `LATEST_VERSION` - Latest Version * `ANNOTATION` - Annotation
The date this package was uploaded.
Serializer for packager uploader for policy puposes.
object
Your email address that we use to contact you. This is only visible to you.
The raw version for this package.
Serializer for the Repository model for policy purposes.
object
A description of the repository's purpose/contents.
array of objects
object
If selected this is the active key for this repository.
If selected this is the default key for this repository.
The long identifier used by ECDSA for this key.
The public key given to repository users.
The SSH fingerprint used by ECDSA for this key.
array of objects
object
If selected this is the active key for this repository.
If selected this is the default key for this repository.
The long identifier used by GPG for this key.
The public key given to repository users.
A descriptive name for the repository.
* `PUBLIC` - Public * `PRIVATE` - Private * `OPEN_SOURCE` - Open-Source
The slug identifies the repository in URIs.
The slug_perm immutably identifies the repository. It will never change once a repository has been created.
Representation of a Workspace used in Policy input.
object
The country your workspace is based in. * `AF` - Afghanistan * `AX` - Åland Islands * `AL` - Albania * `DZ` - Algeria * `AS` - American Samoa * `AD` - Andorra * `AO` - Angola * `AI` - Anguilla * `AQ` - Antarctica * `AG` - Antigua and Barbuda * `AR` - Argentina * `AM` - Armenia * `AW` - Aruba * `AU` - Australia * `AT` - Austria * `AZ` - Azerbaijan * `BS` - Bahamas * `BH` - Bahrain * `BD` - Bangladesh * `BB` - Barbados * `BY` - Belarus * `BE` - Belgium * `BZ` - Belize * `BJ` - Benin * `BM` - Bermuda * `BT` - Bhutan * `BO` - Bolivia * `BQ` - Bonaire, Sint Eustatius and Saba * `BA` - Bosnia and Herzegovina * `BW` - Botswana * `BV` - Bouvet Island * `BR` - Brazil * `IO` - British Indian Ocean Territory * `BN` - Brunei * `BG` - Bulgaria * `BF` - Burkina Faso * `BI` - Burundi * `CV` - Cabo Verde * `KH` - Cambodia * `CM` - Cameroon * `CA` - Canada * `KY` - Cayman Islands * `CF` - Central African Republic * `TD` - Chad * `CL` - Chile * `CN` - China * `CX` - Christmas Island * `CC` - Cocos (Keeling) Islands * `CO` - Colombia * `KM` - Comoros * `CG` - Congo * `CD` - Congo (the Democratic Republic of the) * `CK` - Cook Islands * `CR` - Costa Rica * `CI` - Côte d'Ivoire * `HR` - Croatia * `CU` - Cuba * `CW` - Curaçao * `CY` - Cyprus * `CZ` - Czechia * `DK` - Denmark * `DJ` - Djibouti * `DM` - Dominica * `DO` - Dominican Republic * `EC` - Ecuador * `EG` - Egypt * `SV` - El Salvador * `GQ` - Equatorial Guinea * `ER` - Eritrea * `EE` - Estonia * `SZ` - Eswatini * `ET` - Ethiopia * `FK` - Falkland Islands (Malvinas) * `FO` - Faroe Islands * `FJ` - Fiji * `FI` - Finland * `FR` - France * `GF` - French Guiana * `PF` - French Polynesia * `TF` - French Southern Territories * `GA` - Gabon * `GM` - Gambia * `GE` - Georgia * `DE` - Germany * `GH` - Ghana * `GI` - Gibraltar * `GR` - Greece * `GL` - Greenland * `GD` - Grenada * `GP` - Guadeloupe * `GU` - Guam * `GT` - Guatemala * `GG` - Guernsey * `GN` - Guinea * `GW` - Guinea-Bissau * `GY` - Guyana * `HT` - Haiti * `HM` - Heard Island and McDonald Islands * `VA` - Holy See * `HN` - Honduras * `HK` - Hong Kong * `HU` - Hungary * `IS` - Iceland * `IN` - India * `ID` - Indonesia * `IR` - Iran * `IQ` - Iraq * `IE` - Ireland * `IM` - Isle of Man * `IL` - Israel * `IT` - Italy * `JM` - Jamaica * `JP` - Japan * `JE` - Jersey * `JO` - Jordan * `KZ` - Kazakhstan * `KE` - Kenya * `KI` - Kiribati * `KW` - Kuwait * `KG` - Kyrgyzstan * `LA` - Laos * `LV` - Latvia * `LB` - Lebanon * `LS` - Lesotho * `LR` - Liberia * `LY` - Libya * `LI` - Liechtenstein * `LT` - Lithuania * `LU` - Luxembourg * `MO` - Macao * `MG` - Madagascar * `MW` - Malawi * `MY` - Malaysia * `MV` - Maldives * `ML` - Mali * `MT` - Malta * `MH` - Marshall Islands * `MQ` - Martinique * `MR` - Mauritania * `MU` - Mauritius * `YT` - Mayotte * `MX` - Mexico * `FM` - Micronesia * `MD` - Moldova * `MC` - Monaco * `MN` - Mongolia * `ME` - Montenegro * `MS` - Montserrat * `MA` - Morocco * `MZ` - Mozambique * `MM` - Myanmar * `NA` - Namibia * `NR` - Nauru * `NP` - Nepal * `NL` - Netherlands * `NC` - New Caledonia * `NZ` - New Zealand * `NI` - Nicaragua * `NE` - Niger * `NG` - Nigeria * `NU` - Niue * `NF` - Norfolk Island * `KP` - North Korea * `MK` - North Macedonia * `MP` - Northern Mariana Islands * `NO` - Norway * `OM` - Oman * `PK` - Pakistan * `PW` - Palau * `PS` - Palestine, State of * `PA` - Panama * `PG` - Papua New Guinea * `PY` - Paraguay * `PE` - Peru * `PH` - Philippines * `PN` - Pitcairn * `PL` - Poland * `PT` - Portugal * `PR` - Puerto Rico * `QA` - Qatar * `RE` - Réunion * `RO` - Romania * `RU` - Russia * `RW` - Rwanda * `BL` - Saint Barthélemy * `SH` - Saint Helena, Ascension and Tristan da Cunha * `KN` - Saint Kitts and Nevis * `LC` - Saint Lucia * `MF` - Saint Martin (French part) * `PM` - Saint Pierre and Miquelon * `VC` - Saint Vincent and the Grenadines * `WS` - Samoa * `SM` - San Marino * `ST` - Sao Tome and Principe * `SA` - Saudi Arabia * `SN` - Senegal * `RS` - Serbia * `SC` - Seychelles * `SL` - Sierra Leone * `SG` - Singapore * `SX` - Sint Maarten (Dutch part) * `SK` - Slovakia * `SI` - Slovenia * `SB` - Solomon Islands * `SO` - Somalia * `ZA` - South Africa * `GS` - South Georgia and the South Sandwich Islands * `KR` - South Korea * `SS` - South Sudan * `ES` - Spain * `LK` - Sri Lanka * `SD` - Sudan * `SR` - Suriname * `SJ` - Svalbard and Jan Mayen * `SE` - Sweden * `CH` - Switzerland * `SY` - Syria * `TW` - Taiwan * `TJ` - Tajikistan * `TZ` - Tanzania * `TH` - Thailand * `TL` - Timor-Leste * `TG` - Togo * `TK` - Tokelau * `TO` - Tonga * `TT` - Trinidad and Tobago * `TN` - Tunisia * `TR` - Türkiye * `TM` - Turkmenistan * `TC` - Turks and Caicos Islands * `TV` - Tuvalu * `UG` - Uganda * `UA` - Ukraine * `AE` - United Arab Emirates * `GB` - United Kingdom * `UM` - United States Minor Outlying Islands * `US` - United States of America * `UY` - Uruguay * `UZ` - Uzbekistan * `VU` - Vanuatu * `VE` - Venezuela * `VN` - Vietnam * `VG` - Virgin Islands (British) * `VI` - Virgin Islands (U.S.) * `WF` - Wallis and Futuna * `EH` - Western Sahara * `YE` - Yemen * `ZM` - Zambia * `ZW` - Zimbabwe
The city/town/area your workspace is based in.
A descriptive name for your workspace.
A short public descriptive for your workspace.
array of objects
object
The CVSS score details.
object
The EPSS details. Null if not available.
The format of the vulnerable package.
The vulnerability identifier. E.g. CVE-2021-1234.
The name of the vulnerable package.
List of patched versions, if available.
string
The published date of vulnerability.
The severity level of the vulnerability. * `LOW` - LOW * `MEDIUM` - MEDIUM * `HIGH` - HIGH * `CRITICAL` - CRITICAL
The advisory source details.
The title of the advisory.
List of known vulnerable versions.
string
array of undefineds