API Reference
Open Cloudsmith
DocumentationGuidesAPI Reference
  • General
    • Introduction
    • Rate Limits
    • Error Handling
  • API
    • Collapse icon
      Audit Log
      • Namespace List
        get
      • Repo List
        get
    • Collapse icon
      Broadcasts
      • Create Broadcast Token
        post
    • Collapse icon
      Deny Policy
      • Create
        post
      • Delete
        delete
      • List
        get
      • Partial Update
        patch
      • Read
        get
      • Update
        put
    • Collapse icon
      Distros
      • List
        get
      • Read
        get
    • Collapse icon
      Entitlements
      • Create
        post
      • Delete
        delete
      • Disable
        post
      • Enable
        post
      • List
        get
      • Partial Update
        patch
      • Read
        get
      • Refresh
        post
      • Reset
        post
      • Sync
        post
    • Collapse icon
      Files
      • Abort
        post
      • Complete
        post
      • Create
        post
      • Info
        get
      • Validate
        post
    • Collapse icon
      Formats
      • List
        get
      • Read
        get
    • Collapse icon
      Invites
      • Create
        post
      • Delete
        delete
      • Extend
        post
      • List
        get
      • Partial Update
        patch
      • Resend
        post
    • Collapse icon
      License Policy
      • Collapse icon
        Evaluation
        • Create
          post
        • List
          get
        • Read
          get
      • Create
        post
      • Delete
        delete
      • List
        get
      • Partial Update
        patch
      • Read
        get
      • Update
        put
    • Collapse icon
      Members
      • Collapse icon
        Update
        • Role
          patch
        • Visibility
          patch
      • Delete
        delete
      • List
        get
      • Partial Update
        patch
      • Read
        get
      • Refresh
        post
      • Remove
        get
    • Collapse icon
      Metrics
      • Collapse icon
        Entitlements
        • Account List
          get
        • Repo List
          get
      • Packages List
        get
    • Collapse icon
      Namespaces
      • List
        get
      • Read
        get
    • Collapse icon
      Openid Connect
      • Collapse icon
        Dynamic Mappings
        • List
          get
        • Read
          get
      • Create
        post
      • Delete
        delete
      • List
        get
      • Partial Update
        patch
      • Read
        get
      • Update
        put
    • Collapse icon
      Orgs
      • Delete
        delete
      • List
        get
      • Read
        get
    • Collapse icon
      Packages
      • Collapse icon
        Upload
        • Alpine
          post
        • Cargo
          post
        • Cocoapods
          post
        • Composer
          post
        • Conan
          post
        • Conda
          post
        • Cran
          post
        • Dart
          post
        • Deb
          post
        • Docker
          post
        • Go
          post
        • Helm
          post
        • Hex
          post
        • Huggingface
          post
        • Luarocks
          post
        • Maven
          post
        • Npm
          post
        • Nuget
          post
        • P2
          post
        • Python
          post
        • Raw
          post
        • Rpm
          post
        • Ruby
          post
        • Swift
          post
        • Terraform
          post
        • Vagrant
          post
      • Collapse icon
        Validate Upload
        • Alpine
          post
        • Cargo
          post
        • Cocoapods
          post
        • Composer
          post
        • Conan
          post
        • Conda
          post
        • Cran
          post
        • Dart
          post
        • Deb
          post
        • Docker
          post
        • Go
          post
        • Helm
          post
        • Hex
          post
        • Huggingface
          post
        • Luarocks
          post
        • Maven
          post
        • Npm
          post
        • Nuget
          post
        • P2
          post
        • Python
          post
        • Raw
          post
        • Rpm
          post
        • Ruby
          post
        • Swift
          post
        • Terraform
          post
        • Vagrant
          post
      • Copy
        post
      • Delete
        delete
      • Dependencies
        get
      • Groups List
        get
      • List
        get
      • Move
        post
      • Quarantine
        post
      • Read
        get
      • Resync
        post
      • Scan
        post
      • Status
        get
      • Tag
        post
      • Update License
        patch
      • Vulnerabilities Osv List
        get
    • Collapse icon
      Quota
      • Collapse icon
        Oss
        • History Read
          get
        • Read
          get
      • History Read
        get
      • Read
        get
    • Collapse icon
      Repo Retention
      • Partial Update
        patch
      • Read
        get
    • Collapse icon
      Repos
      • Collapse icon
        Ecdsa
        • Create
          post
        • List
          get
        • Regenerate
          post
      • Collapse icon
        Geoip
        • Disable
          post
        • Enable
          post
        • Partial Update
          patch
        • Read
          get
        • Test
          post
        • Update
          put
      • Collapse icon
        Gpg
        • Create
          post
        • List
          get
        • Regenerate
          post
      • Collapse icon
        Privileges
        • List
          get
        • Partial Update
          patch
        • Update
          put
      • Collapse icon
        Rsa
        • Create
          post
        • List
          get
        • Regenerate
          post
      • Upstream
        • Collapse icon
          Cargo
          • Create
            post
          • Delete
            delete
          • List
            get
          • Partial Update
            patch
          • Read
            get
          • Update
            put
        • Collapse icon
          Composer
          • Create
            post
          • Delete
            delete
          • List
            get
          • Partial Update
            patch
          • Read
            get
          • Update
            put
        • Collapse icon
          Conda
          • Create
            post
          • Delete
            delete
          • List
            get
          • Partial Update
            patch
          • Read
            get
          • Update
            put
        • Collapse icon
          Cran
          • Create
            post
          • Delete
            delete
          • List
            get
          • Partial Update
            patch
          • Read
            get
          • Update
            put
        • Collapse icon
          Dart
          • Create
            post
          • Delete
            delete
          • List
            get
          • Partial Update
            patch
          • Read
            get
          • Update
            put
        • Collapse icon
          Deb
          • Create
            post
          • Delete
            delete
          • List
            get
          • Partial Update
            patch
          • Read
            get
          • Update
            put
        • Collapse icon
          Docker
          • Create
            post
          • Delete
            delete
          • List
            get
          • Partial Update
            patch
          • Read
            get
          • Update
            put
        • Collapse icon
          Go
          • Create
            post
          • Delete
            delete
          • List
            get
          • Partial Update
            patch
          • Read
            get
          • Update
            put
        • Collapse icon
          Helm
          • Create
            post
          • Delete
            delete
          • List
            get
          • Partial Update
            patch
          • Read
            get
          • Update
            put
        • Collapse icon
          Hex
          • Create
            post
          • Delete
            delete
          • List
            get
          • Partial Update
            patch
          • Read
            get
          • Update
            put
        • Collapse icon
          Huggingface
          • Create
            post
          • Delete
            delete
          • List
            get
          • Partial Update
            patch
          • Read
            get
          • Update
            put
        • Collapse icon
          Maven
          • Create
            post
          • Delete
            delete
          • List
            get
          • Partial Update
            patch
          • Read
            get
          • Update
            put
        • Collapse icon
          Npm
          • Create
            post
          • Delete
            delete
          • List
            get
          • Partial Update
            patch
          • Read
            get
          • Update
            put
        • Collapse icon
          Nuget
          • Create
            post
          • Delete
            delete
          • List
            get
          • Partial Update
            patch
          • Read
            get
          • Update
            put
        • Collapse icon
          Python
          • Create
            post
          • Delete
            delete
          • List
            get
          • Partial Update
            patch
          • Read
            get
          • Update
            put
        • Collapse icon
          Rpm
          • Create
            post
          • Delete
            delete
          • List
            get
          • Partial Update
            patch
          • Read
            get
          • Update
            put
        • Collapse icon
          Ruby
          • Create
            post
          • Delete
            delete
          • List
            get
          • Partial Update
            patch
          • Read
            get
          • Update
            put
        • Collapse icon
          Swift
          • Create
            post
          • Delete
            delete
          • List
            get
          • Partial Update
            patch
          • Read
            get
          • Update
            put
      • Collapse icon
        X509
        • Ecdsa List
          get
        • Rsa List
          get
      • Create
        post
      • Delete
        delete
      • Namespace List
        get
      • Partial Update
        patch
      • Read
        get
      • Transfer Region
        post
      • User List
        get
    • Collapse icon
      Saml Authentication
      • Partial Update
        patch
      • Read
        get
    • Collapse icon
      Saml Group Sync
      • Create
        post
      • Delete
        delete
      • Disable
        post
      • Enable
        post
      • List
        get
      • Status
        get
    • Collapse icon
      Services
      • Create
        post
      • Delete
        delete
      • List
        get
      • Partial Update
        patch
      • Read
        get
      • Refresh
        post
    • Collapse icon
      Storage Regions
      • List
        get
      • Read
        get
    • Collapse icon
      Teams
      • Collapse icon
        Members
        • Create
          post
        • List
          get
        • Update
          put
      • Create
        post
      • Delete
        delete
      • List
        get
      • Partial Update
        patch
      • Read
        get
    • Collapse icon
      User
      • Collapse icon
        Tokens
        • Create
          post
        • List
          get
        • Refresh
          put
      • Self
        get
      • Token Create
        post
    • Collapse icon
      Vulnerabilities
      • Namespace List
        get
      • Package List
        get
      • Read
        get
      • Repo List
        get
    • Collapse icon
      Vulnerability Policy
      • Collapse icon
        Evaluation
        • Create
          post
        • List
          get
        • Read
          get
      • Create
        post
      • Delete
        delete
      • List
        get
      • Partial Update
        patch
      • Read
        get
      • Update
        put
    • Collapse icon
      Webhooks
      • Create
        post
      • Delete
        delete
      • List
        get
      • Partial Update
        patch
      • Read
        get
    • Expand icon
      Workspaces Policies
      • Collapse icon
        Actions
        • Create
          post
        • Destroy
          delete
        • List
          get
        • Partial Update
          patch
        • Retrieve
          get
        • Update
          put
      • Create
        post
      • Decision Logs List
        get
      • Destroy
        delete
      • List
        get
      • Partial Update
        patch
      • Retrieve
        get
      • Simulate List
        get
      • Update
        put
    • Api Repos Geoip Status
      get
    • Badges Version List
      get
    • License Policy Violation List
      get
    • Rates Limits List
      get
    • Status Check Basic
      get
    • Users Profile Read
      get
    • Vulnerability Policy Violation List
      get

Logs

Workspaces Policies Decision Logs List

List policy decision logs.

Request

gethttps://api.cloudsmith.io/v2/workspaces/{workspace}/policies/decision_logs
Path params
workspace
string
required
Query params
correlation_id
string
Filter by `correlation_id`.
ended_after
string
Filter by `ended_at`. This operates as an inclusive lower bound (greater than or equal to).
ended_before
string
Filter by `ended_at`. This operates as an exclusive upper bound (less than).
match
boolean
Filter by whether the policy matched the package.
package
string
Filter by package identifier (`slug_perm`).
package_format
string
Filter by package format.
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
policy
string
Filter by policy identifier (`slug_perm`).
repository
string
Filter by repository identifier (`slug_perm`).
sort
string
A comma-separated string of fields to sort by. Legal fields are: `started_at`, `ended_at`. Descending order can be expressed by prepending `-` to a field name.
started_after
string
Filter by `started_at`. This operates as an inclusive lower bound (greater than or equal to).
started_before
string
Filter by `started_at`. This operates as an exclusive upper bound (less than).

Response

Responses

Response body

object

object

results
array of objects
required

array of objects

object

correlation_id
uuid
required
policy
object
required

object

object

created_at
date-time
required

The date and time the policy was created.

description
string | null
optional
length ≤ 250

The description of the Policy.

name
string
required
length ≤ 100

The name of the Policy.

rego
string
required

The rego code which constitutes the Policy logic.

enabled
boolean
optional

If true, the policy is enabled.

is_terminal
boolean
optional

If true and the policy matches, no further policies are evaluated.

slug_perm
string
required
^[-a-zA-Z0-9_]+$

The Policy identifier.

updated_at
date-time
required

The date and time the policy was updated.

version
integer
required

The version of the rego code.

precedence
integer
optional
length ≤ 32767

The order in which this policy is evaluated relative to other policies.

started_at
date-time
required
ended_at
date-time
required
policy_input
object
required

Serializer for policy input.

object

v0
object
required

Serializer for V0 policy input.

object

package
required
Must match exactly one schema
repository
object
required

The details of the package repository for policy purposes.

object

created_at
date-time
optional
description
string
optional
length ≤ 1000

A description of the repository's purpose/contents.

ecdsa_keys
array of objects
required

array of objects

object

active
boolean
optional

If selected this is the active key for this repository.

created_at
date-time
optional
default
boolean
optional

If selected this is the default key for this repository.

fingerprint_short
string
required
fingerprint
string
required
length ≤ 32

The long identifier used by ECDSA for this key.

public_key
string
required

The public key given to repository users.

ssh_fingerprint
string | null
optional
length ≤ 128

The SSH fingerprint used by ECDSA for this key.

gpg_keys
array of objects
required

array of objects

object

active
boolean
optional

If selected this is the active key for this repository.

comment
string
required
created_at
date-time
optional
default
boolean
optional

If selected this is the default key for this repository.

fingerprint_short
string
required
fingerprint
string
required
length ≤ 40

The long identifier used by GPG for this key.

public_key
string
required

The public key given to repository users.

name
string
required
^\w[\w \-'\.\/()]+$
length ≤ 50

A descriptive name for the repository.

open_source_license
string | null
required
repository_type
string
required
Allowed values: PUBLIC, PRIVATE, OPEN_SOURCE

* `PUBLIC` - Public * `PRIVATE` - Private * `OPEN_SOURCE` - Open-Source

slug
string
optional
length ≤ 50
^[-a-zA-Z0-9_]+$

The slug identifies the repository in URIs.

slug_perm
string
optional
length ≤ 16
^[-a-zA-Z0-9_]+$

The slug_perm immutably identifies the repository. It will never change once a repository has been created.

storage_region
string
required
workspace
object
required

Representation of a Workspace used in Policy input.

object

created_at
date-time
optional
country
| null
optional
Must match exactly one schema

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

location
string | null
optional
length ≤ 60

The city/town/area your workspace is based in.

name
string
required
^\w[\w \-'\.\/()]+$
length ≤ 50

A descriptive name for your workspace.

slug
string
required
slug_perm
string
required
tagline
string | null
optional
length ≤ 80

A short public descriptive for your workspace.

osv
array of objects
required

array of objects

object

affected
array of objects | null
required

array of objects

object

database_specific
| null
optional

a JSON object holding additional information about the vulnerability as defined by the database from which the record was obtained. The meaning of the values within the object is entirely defined by the database. In general, the canonical database for a particular ecosystem should record its information in ecosystem_specific, allowing other aggregator databases to put their own summaries in database_specific. For example, databases that add additional information such as computed CVSS scores for ecosystems that do not provide them could add that information here. Note that this is a single field with key “database_specific”, which itself contains a JSON object with unspecified fields.

ecosystem_specific
| null
optional

A JSON object holding additional information about the vulnerability as defined by the ecosystem for which the record applies. The meaning of the values within the object is entirely defined by the ecosystem. For example, the Go ecosystem includes here information about the affected functions and which modules the packages were found in, along with severity in the Go project-specific severity scale. Note that this is a single field with key “ecosystem_specific”, which itself contains a JSON object with unspecified fields.

package
| null
required
Must match all schemas
ranges
| null
optional

The affected object’s ranges field is a JSON array of objects describing the affected ranges of versions. In the range object, the type property is required. It specifies the type of version range being recorded and defines the interpretation of the events object’s introduced, fixed, and any type-specific fields. The ranges object’s events field is a JSON array of objects. Each object describes a single version that either introduces a vulnerability, fixes a vulnerability, describes the last known affected version, or sets an upper limit on the range being described.

severity
array of objects | null
required

array of objects

object

type
required
Must match all schemas

The type of severity being described. The type indicates how the associated score should be interpreted. * `Ubuntu` - An "Ubuntu" severity type indicates that the associated score is a lowercased string representing the Ubuntu priority. If a severity has this type, the associated "score" will be one of "negligible", "low", "medium", "high", or "critical". See https://ubuntu.com/security/cves/about#priority for more information. * `CVSS_V2` - A "CVSS_V2" severity type indicates that the associated score is a CVSS vector string using a version of the Common Vulnerability Scoring System notation that is == 2.0 (e.g."AV:L/AC:M/Au:N/C:N/I:P/A:C"). * `CVSS_V3` - A "CVSS_V3" severity type indicates that the associated score is a CVSS vector string using a version of the Common Vulnerability Scoring System notation that is >= 3.0 and < 4.0 (e.g."CVSS:3.1/AV:N/AC:H/PR:N/UI:N/S:C/C:H/I:N/A:N"). * `CVSS_V4` - A "CVSS_V4" severity type indicates that the associated score is a CVSS vector string using a version of the Common Vulnerability Scoring System notation that is >= 4.0 and < 5.0 (e.g. "CVSS:4.0/AV:N/AC:L/AT:N/PR:H/UI:N/VC:L/VI:L/VA:N/SC:N/SI:N/SA:N").

score
string
required

The score of the vulnerability. This should be interpreted differently depending on the severity type.

numerical_score
double | null
required

A pre-calculated numerical score (added as a convenience by Cloudsmith) for CVSS severity types, based on the CVSS vector provided by OSV. For the UBUNTU severity type, this field is null.

versions
array of strings | null
optional

array of strings

string

aliases
array of strings | null
optional

A list of IDs of the same vulnerability in other databases. This allows one database to claim that its own entry describes the same vulnerability as one or more entries in other databases. Note that the vulnerability IDs referenced here may or may not exist in the overall data set. Aliases should be considered symmetric (if A is an alias of B, then B is an alias of A) and transitive (If A aliases B and B aliases C, then A aliases C).

string

credits
| null
optional

A JSON array providing a way to give credit for the discovery, confirmation, patch, or other events in the life cycle of a vulnerability. Each of the objects in the credits array must contain at minimum a name field specifying the name of the individual or entity being credited, using whatever notation they prefer. It can also optionally include a contact JSON array.

database_specific
| null
optional

Additional information about the vulnerability as defined by the database from which the record was obtained. This is a JSON object with unspecified fields, and the meaning of the values within the object is entirely defined by the database.

details
string | null
optional

Additional English textual details about the vulnerability. This field contains CommonMark markdown (a subset of GitHub-Flavored Markdown).

id
string
required
modified
date-time
required

The time the osv.dev vulnerability entry was last modified.

published
date-time | null
optional

The time the entry should be considered to have been published

references
| null
optional

a list of JSON objects describing references. Each object has a string field type specifying the type of reference, and a string field url. The url is the fully-qualified URL (including the scheme, typically “https://”) linking to additional information, advisories, issue tracker entries, and so on about the vulnerability itself. The type specifies what kind of reference the URL is.

related
array of strings | null
optional

A list of closely related vulnerabilities, such as a similar but completely different vulnerability or cases that do not satisfy the strict definition of aliases or upstream. Related vulnerabilities are symmetric but not transitive.

string

schema_version
string | null
optional
length ≤ 128

The version of the OSV schema a particular vulnerability was exported with. The value should be a string matching the OSV Schema version, which follows the SemVer 2.0.0 format, with no leading “v” prefix. If no value is specified, it should be assumed to be 1.0.0, matching version 1.0 of the OSV Schema.

severity
array of objects | null
required

array of objects

object

type
required
Must match all schemas

The type of severity being described. The type indicates how the associated score should be interpreted. * `Ubuntu` - An "Ubuntu" severity type indicates that the associated score is a lowercased string representing the Ubuntu priority. If a severity has this type, the associated "score" will be one of "negligible", "low", "medium", "high", or "critical". See https://ubuntu.com/security/cves/about#priority for more information. * `CVSS_V2` - A "CVSS_V2" severity type indicates that the associated score is a CVSS vector string using a version of the Common Vulnerability Scoring System notation that is == 2.0 (e.g."AV:L/AC:M/Au:N/C:N/I:P/A:C"). * `CVSS_V3` - A "CVSS_V3" severity type indicates that the associated score is a CVSS vector string using a version of the Common Vulnerability Scoring System notation that is >= 3.0 and < 4.0 (e.g."CVSS:3.1/AV:N/AC:H/PR:N/UI:N/S:C/C:H/I:N/A:N"). * `CVSS_V4` - A "CVSS_V4" severity type indicates that the associated score is a CVSS vector string using a version of the Common Vulnerability Scoring System notation that is >= 4.0 and < 5.0 (e.g. "CVSS:4.0/AV:N/AC:L/AT:N/PR:H/UI:N/VC:L/VI:L/VA:N/SC:N/SI:N/SA:N").

score
string
required

The score of the vulnerability. This should be interpreted differently depending on the severity type.

numerical_score
double | null
required

A pre-calculated numerical score (added as a convenience by Cloudsmith) for CVSS severity types, based on the CVSS vector provided by OSV. For the UBUNTU severity type, this field is null.

summary
string | null
optional

A one-line, English textual summary of the vulnerability. It is recommended that this field be kept short, on the order of no more than 120 characters.

upstream
array of strings | null
optional

A list of IDs of upstream vulnerabilities that are referred to by the vulnerability entry. For example, a downstream package ecosystem (such as a Linux distribution) may issue its own advisories that include (possibly multiple) upstream vulnerabilities. Upstream should be considered transitive but not symmetric.

string

security_scan
required
vulnerabilities
array of objects
required

array of objects

object

cvss
object | null
required

The CVSS score details.

object

epss
| null
required
Must match all schemas

The EPSS details. Null if not available.

format
string
required

The format of the vulnerable package.

identifier
string
required

The vulnerability identifier. E.g. CVE-2021-1234.

package_name
string
required

The name of the vulnerable package.

patched_versions
array of strings
required

List of patched versions, if available.

string

published_date
date-time
required

The published date of vulnerability.

severity
required
Must match all schemas

The severity level of the vulnerability. * `LOW` - LOW * `MEDIUM` - MEDIUM * `HIGH` - HIGH * `CRITICAL` - CRITICAL

source
required
Must match all schemas

The advisory source details.

title
string
required

The title of the advisory.

vulnerable_versions
array of strings
required

List of known vulnerable versions.

string

model_security
object
optional

object

object

availability
required
Must match all schemas

Whether security data is available for this Huggingface package. * `UNAVAILABLE` - Unavailable * `PARTIAL` - Partially complete * `COMPLETE` - Complete

scan_summary
optional
Must match all schemas

If data is available, the overall summary of the scan results. Result precedence from highest to lowest is: UNSAFE > UNKNOWN > QUEUED > SAFE. * `UNSAFE` - Unsafe * `UNKNOWN` - Unknown * `QUEUED` - Queued * `SAFE` - Safe

scan_details
array of objects
optional

The scan details for any file that is NOT reported as SAFE will be included in this list.

object

path
string
required
status
string
required
Allowed values: UNSAFE, UNKNOWN, QUEUED, SAFE

* `UNSAFE` - Unsafe * `UNKNOWN` - Unknown * `QUEUED` - Queued * `SAFE` - Safe

updated_at
date-time
required
clamav
object | null
required

The Clam anti-virus scan information from Huggingface Hub.

object

jfrog
object | null
required

The Jfrog model-scan information from Huggingface Hub.

object

protect_ai
object | null
required

The Protect AI model-scan information from Huggingface Hub.

object

pickle
object | null
required

The Pickle Import scan information from Huggingface Hub.

object

source
string
optional
Allowed values: HUGGINGFACE_HUB

* `HUGGINGFACE_HUB` - Hugging Face Hub

sbom
optional

Raw SBOM data in CycloneDX format, generated by Cloudsmith. Only available for supported Docker/OCI images.

policy_output
required
actions
array of undefineds
required

array of undefineds