Skip to content

Get Component

Request

Get Component by id.

Security
bearerAuth
Path
componentIdinteger, (int64)required

ID of the Component

Example:1
Query
includeVersionsboolean

If true, display version details(Default is true)

Default:true
vulnerabilitySummaryboolean

If true , display vulnerability summary details and hide vulnerability list

Default:false
cvssVersionstring

CVSS Version : This field is required only if vulnerabilitySummary is set to true

Enum:"V2""V3""ANY"
curl -i -X GET \
  'https://codeinsightapi.redocly.app/_mock/swagger/components/1?includeVersions=true&vulnerabilitySummary=false&cvssVersion=V2' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
namestring, [ 0 .. 127 ] characters^[a-zA-Z0-9\.\_\-]+$required

name

Example:"Comp1"
titlestring, [ 0 .. 255 ] charactersrequired

title

Example:"Component1"
urlstring, [ 0 .. 2400 ] characters(NA|^https?:\/\/(www\.)?[-a-zA-Z0-9@:%._\+~#=...required

url

Example:"http://abc@xyz.com | NA"
descriptionstring, [ 0 .. 65535 ] characters

description

Example:"This is a custom component."
encryptionstringYES|NO

encryption

Enum:"YES""NO"
Example:"E.g. YES | default: NO"
forgeIdinteger, (int32), >= 1

forgeId

purlstring, [ 0 .. 2400 ] characters(^$|^(?i:NA|N/A)$|^pkg:[a-zA-Z0-9\+\-\.]+\/.*)

purl

Example:"pkg:maven/org.apache/commons-lang3 | N/A | NA"
idinteger, (int64)
forgestring
versionListArray of objects(VersionModel)
licenseListArray of objects(ComponentLicenseModel)
componentCPEListArray of objects(ComponentCPEModel)
createdBystring
createdOnstring
updatedBystring
updatedOnstring
Response
{
  "name": "Comp1",
  "title": "Component1",
  "url": "http://abc@xyz.com | NA",
  "description": "This is a custom component.",
  "encryption": "E.g. YES | default: NO",
  "forgeId": 1,
  "purl": "pkg:maven/org.apache/commons-lang3 | N/A | NA",
  "id": 0,
  "forge": "string",
  "versionList": [
    { … }
  ],
  "licenseList": [
    { … }
  ],
  "componentCPEList": [
    { … }
  ],
  "createdBy": "string",
  "createdOn": "string",
  "updatedBy": "string",
  "updatedOn": "string"
}