NAV
Java Python JavaScript

Sonatype Lifecycle Public REST API v1.177.0-01

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

The Sonatype Lifecycle API provides programmatic access to a comprehensive set of features for managing software components, security vulnerabilities, licenses, and policy evaluations. Integrate with Lifecycle to automate tasks, retrieve data, and customize your software development lifecycle.

Advanced Search

Use the Advanced Search REST API to perform searches on Lifecycle application scan reports.

createSearchIndexAsync

Code samples

URL obj = new URL("/api/v2/search/advanced/index");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests

r = requests.post('/api/v2/search/advanced/index')

print(r.json())



fetch('/api/v2/search/advanced/index',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /api/v2/search/advanced/index

Use this method to create or rebuild the index for Advanced Search. This is a resource intensive operation. Avoid creating indexes during peak usage hours.

Permissions required: System Administrator

Responses

Status Meaning Description Schema
200 OK Index created successfully. None

getExportResults

Code samples

URL obj = new URL("/api/v2/search/advanced/export/csv?query=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests

r = requests.get('/api/v2/search/advanced/export/csv', params={
  'query': 'string'
})

print(r.json())



fetch('/api/v2/search/advanced/export/csv?query=string',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/search/advanced/export/csv

Use this method to generate a csv file containing your search results. The default delimiter in the generated file is comma. Use the advancedSearchCSVExportDelimiter property of the Configuration REST API to change the delimiter in the generated file.

Parameters

Name In Type Required Description
query query string true A well-formed search query.
allComponents query boolean false Set to true to retrieve results that include components with no violations.
mode query string false none

Enumerated Values

Parameter Value
mode sbomManager

Responses

Status Meaning Description Schema
200 OK Downloadable csv file generated successfully. None
409 Conflict Search index does not exist or is unreadable. None

searchIndex

Code samples

URL obj = new URL("/api/v2/search/advanced");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/search/advanced', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/search/advanced',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/search/advanced

Use this method to perform an Advanced Search.

Parameters

Name In Type Required Description
query query string false Enter your search query here
pageSize query integer(int32) false Enter the no. of results that should be visible per page
page query integer(int32) false Enter the page no. for the page containing results
allComponents query boolean false Set to true to retrieve results that include components with no violations
mode query string false none

Enumerated Values

Parameter Value
mode sbomManager

Example responses

200 Response

{
  "searchQuery": "string",
  "page": 0,
  "pageSize": 0,
  "totalNumberOfHits": 0,
  "isExactTotalNumberOfHits": true,
  "groupingByDTOS": [
    {
      "groupIdentifier": "itemType",
      "groupBy": "string",
      "additionalInfo": "string",
      "searchResultItemDTOS": [
        {
          "itemType": "string",
          "organizationId": "string",
          "organizationName": "string",
          "applicationId": "string",
          "applicationPublicId": "string",
          "applicationName": "string",
          "applicationVersion": "string",
          "sbomSpecification": "string",
          "policyEvaluationStage": "string",
          "reportId": "string",
          "componentHash": "string",
          "componentIdentifier": {
            "format": "string",
            "coordinates": {
              "property1": "string",
              "property2": "string"
            }
          },
          "componentName": "string",
          "vulnerabilityId": "string",
          "vulnerabilityDescription": "string",
          "vulnerabilityStatus": "string",
          "applicationCategoryId": "string",
          "applicationCategoryName": "string",
          "applicationCategoryColor": "string",
          "applicationCategoryDescription": "string",
          "componentLabelId": "string",
          "componentLabelName": "string",
          "componentLabelColor": "string",
          "componentLabelDescription": "string",
          "policyId": "string",
          "policyName": "string",
          "policyThreatCategory": "string",
          "policyThreatLevel": 0,
          "resultIndex": 0
        }
      ]
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Response JSON containing the search query sent in the API call, and other response fields as follows:
  1. searchQuery: search query sent in the request
  2. page: page number of search results requested
  3. pageSize: requested number of results per page
  4. totalNumberOfHits: total number of results returned
  5. isExactTotalNumberOfHits
    • true indicates that the search results in the JSON is the same no. of search results that logically match the search query.
    • false indicates that the search results in the JSON are lower bound because fetching all results is too expensive to compute.
  6. groupingByDTOS: array of search results grouped on a field name
  7. groupIdentifier: field name that the search results have been grouped by
  8. groupBy: field value that the search results have been grouped by
  9. additionalInfo: shared information between groups, e.g. info if grouped by a security vulnerability
  10. searchResultItemDTOS: array of search results with each element containing an itemType, field names and values
  11. resultIndex: indicating the relevance of the search result w.r.t. the query|SearchResultDTO| |409|Conflict|Search index does not exist or is unreadable.|None|

Components

Use this REST API to retrieve a component's security vulnerability data, license data, age and popularity.

getComponentDetails

Code samples

URL obj = new URL("/api/v2/components/details");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('/api/v2/components/details', headers = headers)

print(r.json())


const inputBody = '{
  "components": [
    {
      "packageUrl": "string",
      "hash": "string",
      "sha256": "string",
      "componentIdentifier": {
        "format": "string",
        "coordinates": {
          "property1": "string",
          "property2": "string"
        }
      },
      "displayName": "string",
      "proprietary": true,
      "thirdParty": true
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/api/v2/components/details',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /api/v2/components/details

Use this method to retrieve data related to a component.

Body parameter

{
  "components": [
    {
      "packageUrl": "string",
      "hash": "string",
      "sha256": "string",
      "componentIdentifier": {
        "format": "string",
        "coordinates": {
          "property1": "string",
          "property2": "string"
        }
      },
      "displayName": "string",
      "proprietary": true,
      "thirdParty": true
    }
  ]
}

Parameters

Name In Type Required Description
body body ApiComponentDetailsRequestDTOV2 true You can retrieve component data in any one of the 3 ways via:

Detailed descriptions

body: You can retrieve component data in any one of the 3 ways via: 1. Component identifier 2. Package URL 3. Hash

Example responses

200 Response

{
  "componentDetails": [
    {
      "component": {
        "packageUrl": "string",
        "hash": "string",
        "sha256": "string",
        "componentIdentifier": {
          "format": "string",
          "coordinates": {
            "property1": "string",
            "property2": "string"
          }
        },
        "displayName": "string",
        "proprietary": true,
        "thirdParty": true
      },
      "matchState": "string",
      "catalogDate": "2019-08-24T14:15:22Z",
      "relativePopularity": 0,
      "licenseData": {
        "declaredLicenses": [
          {
            "licenseId": "string",
            "licenseName": "string"
          }
        ],
        "observedLicenses": [
          {
            "licenseId": "string",
            "licenseName": "string"
          }
        ],
        "effectiveLicenses": [
          {
            "licenseId": "string",
            "licenseName": "string"
          }
        ],
        "overriddenLicenses": [
          {
            "licenseId": "string",
            "licenseName": "string"
          }
        ],
        "status": "string"
      },
      "integrityRating": "string",
      "hygieneRating": "string",
      "securityData": {
        "securityIssues": [
          {
            "source": "string",
            "reference": "string",
            "severity": 0.1,
            "status": "string",
            "url": "string",
            "threatCategory": "string",
            "cwe": "string",
            "cvssVector": "string",
            "cvssVectorSource": "string",
            "analysis": {
              "state": "string",
              "justification": "string",
              "response": "string",
              "detail": "string"
            }
          }
        ]
      },
      "policyData": {
        "policyViolations": [
          {
            "policyId": "string",
            "policyName": "string",
            "policyViolationId": "string",
            "threatLevel": 0,
            "constraintViolations": [
              {
                "constraintId": "string",
                "constraintName": "string",
                "reasons": [
                  {
                    "reason": "string",
                    "reference": {}
                  }
                ]
              }
            ]
          }
        ]
      },
      "projectData": {
        "firstReleaseDate": "2019-08-24T14:15:22Z",
        "lastReleaseDate": "2019-08-24T14:15:22Z",
        "projectMetadata": {
          "description": "string",
          "organization": "string"
        },
        "sourceControlManagement": {
          "scmUrl": "string",
          "scmMetadata": {
            "stars": 0,
            "forks": 0
          },
          "scmDetails": {
            "commitsPerMonth": 0,
            "uniqueDevsPerMonth": 0
          }
        }
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK The response contains a detailed description of the component. The hash value returned here is truncated and not intended to be used as a checksum. It can be used as an identifier to pass to other REST API calls. ApiComponentDetailsResultDTOV2

setComponentLabel

Code samples

URL obj = new URL("/api/v2/components/{componentHash}/labels/{labelName}/{ownerType}s/{internalOwnerId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests

r = requests.post('/api/v2/components/{componentHash}/labels/{labelName}/{ownerType}s/{internalOwnerId}')

print(r.json())



fetch('/api/v2/components/{componentHash}/labels/{labelName}/{ownerType}s/{internalOwnerId}',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /api/v2/components/{componentHash}/labels/{labelName}/{ownerType}s/{internalOwnerId}

Use this method to assign an existing label to a component.

Parameters

Name In Type Required Description
ownerType path string true Possible values: application or organization
internalOwnerId path string true Possible values : applicationId or organizationId
componentHash path string true Enter the SHA1 hash of the component.
labelName path string true Enter the label name to assign to this component.

Enumerated Values

Parameter Value
ownerType application
ownerType organization
ownerType repository_container
ownerType repository_manager
ownerType repository
ownerType global

Responses

Status Meaning Description Schema
204 No Content Component label assigned successfully. None

deleteComponentLabel

Code samples

URL obj = new URL("/api/v2/components/{componentHash}/labels/{labelName}/{ownerType}s/{internalOwnerId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests

r = requests.delete('/api/v2/components/{componentHash}/labels/{labelName}/{ownerType}s/{internalOwnerId}')

print(r.json())



fetch('/api/v2/components/{componentHash}/labels/{labelName}/{ownerType}s/{internalOwnerId}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /api/v2/components/{componentHash}/labels/{labelName}/{ownerType}s/{internalOwnerId}

Use this method to un-assign a label from a component.

Parameters

Name In Type Required Description
ownerType path string true Possible values: application or organization
internalOwnerId path string true Possible values : applicationId or organizationId
componentHash path string true Enter the SHA1 hash of the component.
labelName path string true Enter the label name to un-assign from this component.

Enumerated Values

Parameter Value
ownerType application
ownerType organization
ownerType repository_container
ownerType repository_manager
ownerType repository
ownerType global

Responses

Status Meaning Description Schema
204 No Content Label un-assigned from component successfully. None

getSuggestedRemediationForComponent

Code samples

URL obj = new URL("/api/v2/components/remediation/{ownerType}/{ownerId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('/api/v2/components/remediation/{ownerType}/{ownerId}', headers = headers)

print(r.json())


const inputBody = '{
  "packageUrl": "string",
  "hash": "string",
  "sha256": "string",
  "componentIdentifier": {
    "format": "string",
    "coordinates": {
      "property1": "string",
      "property2": "string"
    }
  },
  "displayName": "string",
  "proprietary": true,
  "thirdParty": true
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('/api/v2/components/remediation/{ownerType}/{ownerId}',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /api/v2/components/remediation/{ownerType}/{ownerId}

Use this method to obtain remediation suggestions for policy violations on a component basis. Remediations obtained from this method are same as those appearing on the Component Details Page in the UI.

Body parameter

{
  "packageUrl": "string",
  "hash": "string",
  "sha256": "string",
  "componentIdentifier": {
    "format": "string",
    "coordinates": {
      "property1": "string",
      "property2": "string"
    }
  },
  "displayName": "string",
  "proprietary": true,
  "thirdParty": true
}

Parameters

Name In Type Required Description
ownerType path string true Possible values: application, organization, repository.
ownerId path string true Possible values: applicationId, organizationId or repositoryId.
stageId query string false Enter the stageId to obtain next-non-failing and next-non-failing-with-dependencies remediation types in the response. Possible values are develop, build, stage-release, release and operate.
identificationSource query string false Enter the identification source if you want the remediation result based on third-party scan information (non-Sonatype). The identification source can be obtained from the Component Details Page in the UI.
scanId query string false Enter the scanId (reportId) if you want the remediation result based on third-party scan information (non-Sonatype).
body body ApiComponentDTOV2 false none

Enumerated Values

Parameter Value
ownerType application
ownerType organization
ownerType repository_container
ownerType repository_manager
ownerType repository
ownerType global

Responses

Status Meaning Description Schema
200 OK The response returns details for components that can be used for remediation. Details for the recommended component are grouped under type in the response.
  • Type next-no-violations indicates that the component version has no violations.
  • Type next-non-failing indicates that the component version does not fail policy violations. The response will contain this type only if stageId is provided in the method call.
  • Type next-no-violations-with-dependencies indicates that the component, along-with its dependencies does not any violate any policies.
  • Type next-non-failing-with-dependencies indicates that the component and its dependencies will not fail a build for the stageId provided.

Hash values returned here are truncated and are not intended to be used as checksums. They can be used as identifiers to pass to other REST API calls.

 None

getComponentVersions

Code samples

URL obj = new URL("/api/v2/components/versions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('/api/v2/components/versions', headers = headers)

print(r.json())


const inputBody = '{
  "format": "string",
  "coordinates": {
    "property1": "string",
    "property2": "string"
  },
  "packageUrl": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/api/v2/components/versions',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /api/v2/components/versions

Use this method to retrieve all known versions of a component.

Body parameter

{
  "format": "string",
  "coordinates": {
    "property1": "string",
    "property2": "string"
  },
  "packageUrl": "string"
}

Parameters

Name In Type Required Description
body body ApiComponentOrPurlIdentifierDTOV2 false Possible values: Component identifier or packageURL (pURL) identifier in the correct format. Use a-name for JavaScript components.

Example responses

200 Response

[
  "string"
]

Responses

Status Meaning Description Schema
200 OK Known versions of the component are returned in a string array of ascending order. Inline

Response Schema

CycloneDX

Use the CycloneDX REST API to generate CycloneDX SBOMs in XML or JSON formats, containing coordinates and licenses for components found in a scan report.

getByReportId

Code samples

URL obj = new URL("/api/v2/cycloneDx/{cdxVersion}/{applicationId}/reports/{reportId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/cycloneDx/{cdxVersion}/{applicationId}/reports/{reportId}', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/cycloneDx/{cdxVersion}/{applicationId}/reports/{reportId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/cycloneDx/{cdxVersion}/{applicationId}/reports/{reportId}

Use this method to generate a CycloneDX SBOM for an application.

Permissions Required: View IQ Elements

Parameters

Name In Type Required Description
applicationId path string true Enter the internal applicationId for the application you want to generate the SBOM. You can also retrieve the applicationId using the Application REST API.
reportId path string true Enter the reportId to generate the SBOM for the application for a specific scan report.
cdxVersion path string true Possible values are 1.1

Example responses

Responses

Status Meaning Description Schema
200 OK A downloadable file will be generated. None

Response Schema

getLatest

Code samples

URL obj = new URL("/api/v2/cycloneDx/{cdxVersion}/{applicationId}/stages/{stageId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/cycloneDx/{cdxVersion}/{applicationId}/stages/{stageId}', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/cycloneDx/{cdxVersion}/{applicationId}/stages/{stageId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/cycloneDx/{cdxVersion}/{applicationId}/stages/{stageId}

Use this method to generate a CycloneDX SBOM for an application.

Permissions Required: View IQ Elements

Parameters

Name In Type Required Description
applicationId path string true Enter the internal applicationId for the application you want to generate the SBOM. You can also retrieve the applicationId using the Application REST API.
stageId path string true Enter the stageId to generate the SBOM based on the latest application policy evaluation at that stage. Allowed values for stageId are 'develop', 'source', 'build', 'stage-release', 'release', and, 'operate'.
cdxVersion path string true Possible values are 1.1

Example responses

Responses

Status Meaning Description Schema
200 OK A downloadable file will be generated. None

Response Schema

Data Retention Policies

Set policies for automatic purging of obsolete application and Success Metrics reports.

Note that IQ Server has a preset limit of purging 5000 reports in one execution of its report purging job.

getDataRetentionPolicies

Code samples

URL obj = new URL("/api/v2/dataRetentionPolicies/organizations/{organizationId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/dataRetentionPolicies/organizations/{organizationId}', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/dataRetentionPolicies/organizations/{organizationId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/dataRetentionPolicies/organizations/{organizationId}

Data retention policies help to limit the disk space consumption by removing obsolete data. Use this method to inspect the retention policies that are in effect for an organization. Application reports created by continuous monitoring are not affected by the stage retention policy. They appear separately under the key continuous-monitoring in the response JSON

Permissions required: View IQ Elements

Parameters

Name In Type Required Description
organizationId path string true The organizationId assigned by IQ Server. Use the organization REST API to retrieve the organizationId.

Example responses

200 Response

{
  "applicationReports": {
    "stages": {
      "property1": {
        "inheritPolicy": true,
        "enablePurging": true,
        "maxCount": 0,
        "maxAge": "string"
      },
      "property2": {
        "inheritPolicy": true,
        "enablePurging": true,
        "maxCount": 0,
        "maxAge": "string"
      }
    }
  },
  "successMetrics": {
    "inheritPolicy": true,
    "enablePurging": true,
    "maxAge": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK The response JSON contains the policy settings for both applicationReports and successMetrics. Policy settings for application reports are shown for each stage of development.
  • inheritPolicy IS a boolean flag indicating whether the policy is inherited from a parent organization.
  • enablePurging IS a boolean flag indicating if automatic purging is enabled or disabled.
  • maxCount IS the maximum no. of reports to retain.
  • maxAge IS the maximum age that a report is allowed to reach before it is purged. Possible values are days, weeks, months, years.
The latest application report is always retained, regardless of its age.		 ApiDataRetentionPoliciesDTO

setDataRetentionPolicies

Code samples

URL obj = new URL("/api/v2/dataRetentionPolicies/organizations/{organizationId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.put('/api/v2/dataRetentionPolicies/organizations/{organizationId}', headers = headers)

print(r.json())


const inputBody = '{
  "applicationReports": {
    "stages": {
      "property1": {
        "inheritPolicy": true,
        "enablePurging": true,
        "maxCount": 0,
        "maxAge": "string"
      },
      "property2": {
        "inheritPolicy": true,
        "enablePurging": true,
        "maxCount": 0,
        "maxAge": "string"
      }
    }
  },
  "successMetrics": {
    "inheritPolicy": true,
    "enablePurging": true,
    "maxAge": "string"
  }
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('/api/v2/dataRetentionPolicies/organizations/{organizationId}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /api/v2/dataRetentionPolicies/organizations/{organizationId}

Data retention policies help to limit the disk space consumption by removing obsolete data. Use this method to set the retention policies for an organization. Application reports created by continuous monitoring are not affected by the stage retention policy. They appear separately under the key continuous-monitoring.

Permissions required: Edit IQ Elements

Body parameter

{
  "applicationReports": {
    "stages": {
      "property1": {
        "inheritPolicy": true,
        "enablePurging": true,
        "maxCount": 0,
        "maxAge": "string"
      },
      "property2": {
        "inheritPolicy": true,
        "enablePurging": true,
        "maxCount": 0,
        "maxAge": "string"
      }
    }
  },
  "successMetrics": {
    "inheritPolicy": true,
    "enablePurging": true,
    "maxAge": "string"
  }
}

Parameters

Name In Type Required Description
organizationId path string true The organizationId for the organization you want to set the data retention policy. Use the organization REST API to retrieve the organizationId.
body body ApiDataRetentionPoliciesDTO true The request JSON should include the retention policy settings for both application reports and success metrics.

Detailed descriptions

body: The request JSON should include the retention policy settings for both application reports and success metrics.

Policy settings for application reports can be specified for each stage of development represented in the example below by additionalProp1. Example values for additionalProp1 are develop, build, stage-release, release, operate & continuous monitoring. For application reports created during continuous monitoring use the key continuous-monitoring instead of the stage name.

Responses

Status Meaning Description Schema
200 OK The data retention policy has been set successfully. None

getParentDataRetentionPolicies

Code samples

URL obj = new URL("/api/v2/dataRetentionPolicies/organizations/{organizationId}/parent");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/dataRetentionPolicies/organizations/{organizationId}/parent', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/dataRetentionPolicies/organizations/{organizationId}/parent',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/dataRetentionPolicies/organizations/{organizationId}/parent

Data retention policies help to limit the disk space consumption by removing obsolete data. Use this method to inspect the retention policies that are in effect for the parent organization of the given organization. Application reports created by continuous monitoring are not affected by the stage retention policy. They appear separately under the key continuous-monitoring.

Permissions required: View IQ Elements

Parameters

Name In Type Required Description
organizationId path string true The organizationId assigned by IQ Server. Use the organization REST API to retrieve the parent organizationId

Example responses

200 Response

{
  "applicationReports": {
    "stages": {
      "property1": {
        "inheritPolicy": true,
        "enablePurging": true,
        "maxCount": 0,
        "maxAge": "string"
      },
      "property2": {
        "inheritPolicy": true,
        "enablePurging": true,
        "maxCount": 0,
        "maxAge": "string"
      }
    }
  },
  "successMetrics": {
    "inheritPolicy": true,
    "enablePurging": true,
    "maxAge": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK The response JSON contains the policy settings for both applicationReports and successMetrics. Policy settings for application reports are shown for each stage of development.
  • inheritPolicy IS a boolean flag indicating whether the policy is inherited from a parent organization.
  • enablePurging IS a boolean flag indicating if automatic purging is enabled or disabled.
  • maxCount IS the maximum no. of reports to retain.
  • maxAge IS the maximum age that a report is allowed to reach before it is purged. Possible values are days, weeks, months, years.
The latest application report is always retained, regardless of its age.		 ApiDataRetentionPoliciesDTO

Policy Evaluation

Use this REST API to perform an application policy evaluation. Policy evaluations are executed asynchronously.

This is a 2-step process that involves: 1. Requesting a policy evaluation (POST) 2. Checking the status and response of the evaluation request (GET)

evaluateComponents

Code samples

URL obj = new URL("/api/v2/evaluation/applications/{applicationId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('/api/v2/evaluation/applications/{applicationId}', headers = headers)

print(r.json())


const inputBody = '{
  "components": [
    {
      "packageUrl": "string",
      "hash": "string",
      "sha256": "string",
      "componentIdentifier": {
        "format": "string",
        "coordinates": {
          "property1": "string",
          "property2": "string"
        }
      },
      "displayName": "string",
      "proprietary": true,
      "thirdParty": true
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/api/v2/evaluation/applications/{applicationId}',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /api/v2/evaluation/applications/{applicationId}

Use this method to request a component evaluation. This is step 1 of the 2 step policy evaluation for components process.

Permissions Required: Evaluate Components

Body parameter

{
  "components": [
    {
      "packageUrl": "string",
      "hash": "string",
      "sha256": "string",
      "componentIdentifier": {
        "format": "string",
        "coordinates": {
          "property1": "string",
          "property2": "string"
        }
      },
      "displayName": "string",
      "proprietary": true,
      "thirdParty": true
    }
  ]
}

Parameters

Name In Type Required Description
applicationId path string true Enter the internal applicationId. Use the Applications REST API to retrieve the internal applicationId.
body body ApiComponentEvaluationRequestDTOV2 false The request JSON should contain component coordinates or the hash (SHA1) for each component. You can provide the packageURL instead of component information or hash.

Example responses

200 Response

{
  "resultId": "string",
  "submittedDate": "2019-08-24T14:15:22Z",
  "applicationId": "string",
  "resultsUrl": "string"
}

Responses

Status Meaning Description Schema
200 OK The JSON response contains resultId that will be assigned to the evaluation results, timestamp when the component evaluation was requested, the applicationId of the component and the results URL. The resultId obtained from here can be used to retrieve the evaluation result using the REST API or the result URL can be used in cURL. ApiComponentEvaluationTicketDTOV2

evaluateSourceControl

Code samples

URL obj = new URL("/api/v2/evaluation/applications/{applicationId}/sourceControlEvaluation");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('/api/v2/evaluation/applications/{applicationId}/sourceControlEvaluation', headers = headers)

print(r.json())


const inputBody = '{
  "stageId": "string",
  "branchName": "string",
  "scanTargets": [
    "string"
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/api/v2/evaluation/applications/{applicationId}/sourceControlEvaluation',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /api/v2/evaluation/applications/{applicationId}/sourceControlEvaluation

Use this method to request a source control evaluation for a specific application. This is step 1 of the 2 step source control evaluation process.

Permissions Required: Evaluate Applications

Body parameter

{
  "stageId": "string",
  "branchName": "string",
  "scanTargets": [
    "string"
  ]
}

Parameters

Name In Type Required Description
applicationId path string true Enter the internal applicationId. Use the Applications REST API to retrieve the internal applicationId.
body body ApiSourceControlEvaluationRequestDTO false The request JSON should include the 1. branch name (name of the target branch in the source control repository, 2. stageId (recommended values are 'develop' for feature branches, and 'source' for default branches. Other stageIds that can be used are 'build', 'stage-release', 'release', 'operate' but are not recommended), 3. scanTargets (optional, specify one or more paths inside the repository. If not specified, the entire repository will be evaluated by default). Ensure that the repository paths are not relative and do not contain '../' or '..\'.

Example responses

200 Response

{
  "statusUrl": "string"
}

Responses

Status Meaning Description Schema
200 OK The response contains statusUrl. Use this statusUrl to check the evaluation status using the GET method (step 2 of the evaluation process). ApiApplicationEvaluationStatusDTOV2

getApplicationEvaluationStatus

Code samples

URL obj = new URL("/api/v2/evaluation/applications/{applicationId}/status/{statusId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/evaluation/applications/{applicationId}/status/{statusId}', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/evaluation/applications/{applicationId}/status/{statusId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/evaluation/applications/{applicationId}/status/{statusId}

This is step 2 of the policy evaluation process. Use the statusUrl obtained from the POST response for the corresponding applicationId.

Permissions Required: Evaluate Applications

Parameters

Name In Type Required Description
applicationId path string true Enter the applicationId, for the which policy evaluation was requested.
statusId path string true Enter the statusId value obtained as response of the POST call in step 1.

Example responses

200 Response

{
  "status": "string",
  "reason": "string",
  "reportHtmlUrl": "string",
  "embeddableReportHtmlUrl": "string",
  "reportPdfUrl": "string",
  "reportDataUrl": "string"
}

Responses

Status Meaning Description Schema
200 OK The response will include one of the 3 possible status values: PENDING (indicates that the evaluation is still in progress), FAILED or COMPLETED. For completed evaluations, the response will contain the URLs for evaluation report to view the evaluation results. ApiApplicationEvaluationResultDTOV2

getComponentEvaluation

Code samples

URL obj = new URL("/api/v2/evaluation/applications/{applicationId}/results/{resultId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/evaluation/applications/{applicationId}/results/{resultId}', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/evaluation/applications/{applicationId}/results/{resultId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/evaluation/applications/{applicationId}/results/{resultId}

This is step 2 of the policy evaluation process for components. Use the resultId obtained from the POST response for the corresponding applicationId.

Permissions Required: Evaluate Components

Parameters

Name In Type Required Description
applicationId path string true Enter the internal applicationId (same as that sent in the POST request (step 1))
resultId path string true Enter the resultId obtained from the POST response (step 1) used for component evaluation.

Example responses

200 Response

{
  "submittedDate": "2019-08-24T14:15:22Z",
  "evaluationDate": "2019-08-24T14:15:22Z",
  "applicationId": "string",
  "results": [
    {
      "component": {
        "packageUrl": "string",
        "hash": "string",
        "sha256": "string",
        "componentIdentifier": {
          "format": "string",
          "coordinates": {
            "property1": "string",
            "property2": "string"
          }
        },
        "displayName": "string",
        "proprietary": true,
        "thirdParty": true
      },
      "matchState": "string",
      "catalogDate": "2019-08-24T14:15:22Z",
      "relativePopularity": 0,
      "licenseData": {
        "declaredLicenses": [
          {
            "licenseId": "string",
            "licenseName": "string"
          }
        ],
        "observedLicenses": [
          {
            "licenseId": "string",
            "licenseName": "string"
          }
        ],
        "effectiveLicenses": [
          {
            "licenseId": "string",
            "licenseName": "string"
          }
        ],
        "overriddenLicenses": [
          {
            "licenseId": "string",
            "licenseName": "string"
          }
        ],
        "status": "string"
      },
      "integrityRating": "string",
      "hygieneRating": "string",
      "securityData": {
        "securityIssues": [
          {
            "source": "string",
            "reference": "string",
            "severity": 0.1,
            "status": "string",
            "url": "string",
            "threatCategory": "string",
            "cwe": "string",
            "cvssVector": "string",
            "cvssVectorSource": "string",
            "analysis": {
              "state": "string",
              "justification": "string",
              "response": "string",
              "detail": "string"
            }
          }
        ]
      },
      "policyData": {
        "policyViolations": [
          {
            "policyId": "string",
            "policyName": "string",
            "policyViolationId": "string",
            "threatLevel": 0,
            "constraintViolations": [
              {
                "constraintId": "string",
                "constraintName": "string",
                "reasons": [
                  {
                    "reason": "string",
                    "reference": {}
                  }
                ]
              }
            ]
          }
        ]
      },
      "projectData": {
        "firstReleaseDate": "2019-08-24T14:15:22Z",
        "lastReleaseDate": "2019-08-24T14:15:22Z",
        "projectMetadata": {
          "description": "string",
          "organization": "string"
        },
        "sourceControlManagement": {
          "scmUrl": "string",
          "scmMetadata": {
            "stars": 0,
            "forks": 0
          },
          "scmDetails": {
            "commitsPerMonth": 0,
            "uniqueDevsPerMonth": 0
          }
        }
      }
    }
  ],
  "isError": true,
  "errorMessage": "string"
}

Responses

Status Meaning Description Schema
200 OK The response contains details for the policy evaluation request including submitted date, evaluation date, applicationId and the results of the evaluation for the component(s). ApiComponentEvaluationResultDTOV2
404 Not Found Response not ready None

promoteScan

Code samples

URL obj = new URL("/api/v2/evaluation/applications/{applicationId}/promoteScan");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('/api/v2/evaluation/applications/{applicationId}/promoteScan', headers = headers)

print(r.json())


const inputBody = '{
  "scanId": "string",
  "sourceStageId": "string",
  "targetStageId": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/api/v2/evaluation/applications/{applicationId}/promoteScan',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /api/v2/evaluation/applications/{applicationId}/promoteScan

Use this method to rescan older scans. This is done when the binaries of a previous build are now moving to a new stage in the production pipeline. Using this method, you can avoid rebuilding the application and reuse the scan metadata at the newer stage. This new evaluation will evaluate the most recent security and license data against your current policies.

Permissions Required: Evaluate Applications

Body parameter

{
  "scanId": "string",
  "sourceStageId": "string",
  "targetStageId": "string"
}

Parameters

Name In Type Required Description
applicationId path string true Enter the internal applicationId. Use the Applications REST API to retrieve the internal applicationId.
body body ApiPromoteScanRequestDTOV2 false You can provide either the scanId (reportId) of the previous scan OR the source stageId (possible values are 'build', 'stage-release', 'release' or 'operate'). When using the stageId, the latest scanId for the application will be used. Enter the targetStageId for the new stage you want your scan to be promoted to (possible values are 'build', 'stage-release', 'release' or 'operate'). Using the same value for source and target stage will resubmit the latest scan report.

Example responses

200 Response

{
  "statusUrl": "string"
}

Responses

Status Meaning Description Schema
200 OK The response will contain the statusUrl to view the evaluation result using the GET method (step 2) ApiApplicationEvaluationStatusDTOV2

Application Categories

getTags

Code samples

URL obj = new URL("/api/v2/applicationCategories/organization/{organizationId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/applicationCategories/organization/{organizationId}', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/applicationCategories/organization/{organizationId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/applicationCategories/organization/{organizationId}

Parameters

Name In Type Required Description
organizationId path string true none

Example responses

default Response

[
  {
    "id": "string",
    "name": "string",
    "description": "string",
    "organizationId": "string",
    "color": "string"
  }
]

Responses

Status Meaning Description Schema
default Default default response Inline

Response Schema

Status Code default

Name Type Required Restrictions Description
anonymous [ApiApplicationCategoryDTO] false none none
» id string false none none
» name string false none none
» description string false none none
» organizationId string false none none
» color string false none none

updateTag

Code samples

URL obj = new URL("/api/v2/applicationCategories/organization/{organizationId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('/api/v2/applicationCategories/organization/{organizationId}', headers = headers)

print(r.json())


const inputBody = '{
  "id": "string",
  "name": "string",
  "description": "string",
  "organizationId": "string",
  "color": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/api/v2/applicationCategories/organization/{organizationId}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /api/v2/applicationCategories/organization/{organizationId}

Body parameter

{
  "id": "string",
  "name": "string",
  "description": "string",
  "organizationId": "string",
  "color": "string"
}

Parameters

Name In Type Required Description
organizationId path string true none
body body ApiApplicationCategoryDTO false none

Example responses

default Response

{
  "id": "string",
  "name": "string",
  "description": "string",
  "organizationId": "string",
  "color": "string"
}

Responses

Status Meaning Description Schema
default Default default response ApiApplicationCategoryDTO

addTag

Code samples

URL obj = new URL("/api/v2/applicationCategories/organization/{organizationId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('/api/v2/applicationCategories/organization/{organizationId}', headers = headers)

print(r.json())


const inputBody = '{
  "id": "string",
  "name": "string",
  "description": "string",
  "organizationId": "string",
  "color": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/api/v2/applicationCategories/organization/{organizationId}',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /api/v2/applicationCategories/organization/{organizationId}

Body parameter

{
  "id": "string",
  "name": "string",
  "description": "string",
  "organizationId": "string",
  "color": "string"
}

Parameters

Name In Type Required Description
organizationId path string true none
body body ApiApplicationCategoryDTO false none

Example responses

default Response

{
  "id": "string",
  "name": "string",
  "description": "string",
  "organizationId": "string",
  "color": "string"
}

Responses

Status Meaning Description Schema
default Default default response ApiApplicationCategoryDTO

deleteTag

Code samples

URL obj = new URL("/api/v2/applicationCategories/organization/{organizationId}/{tagId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': '*/*'
}

r = requests.delete('/api/v2/applicationCategories/organization/{organizationId}/{tagId}', headers = headers)

print(r.json())



const headers = {
  'Accept':'*/*'
};

fetch('/api/v2/applicationCategories/organization/{organizationId}/{tagId}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /api/v2/applicationCategories/organization/{organizationId}/{tagId}

Parameters

Name In Type Required Description
organizationId path string true none
tagId path string true none

Example responses

Responses

Status Meaning Description Schema
default Default default response None

Response Schema

getApplicableTags

Code samples

URL obj = new URL("/api/v2/applicationCategories/organization/{organizationId}/applicable");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/applicationCategories/organization/{organizationId}/applicable', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/applicationCategories/organization/{organizationId}/applicable',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/applicationCategories/organization/{organizationId}/applicable

Parameters

Name In Type Required Description
organizationId path string true none

Example responses

default Response

{
  "applicationCategoriesByOwner": [
    {
      "ownerId": "string",
      "ownerName": "string",
      "ownerType": "application",
      "applicationCategories": [
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "organizationId": "string",
          "color": "string"
        }
      ]
    }
  ]
}

Responses

Status Meaning Description Schema
default Default default response ApplicableTagsDTO

getApplicableTagsByApplicationPublicId

Code samples

URL obj = new URL("/api/v2/applicationCategories/application/{applicationPublicId}/applicable");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/applicationCategories/application/{applicationPublicId}/applicable', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/applicationCategories/application/{applicationPublicId}/applicable',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/applicationCategories/application/{applicationPublicId}/applicable

Parameters

Name In Type Required Description
applicationPublicId path string true none

Example responses

default Response

[
  {
    "id": "string",
    "name": "string",
    "description": "string",
    "organizationId": "string",
    "color": "string"
  }
]

Responses

Status Meaning Description Schema
default Default default response Inline

Response Schema

Status Code default

Name Type Required Restrictions Description
anonymous [ApiApplicationCategoryDTO] false none none
» id string false none none
» name string false none none
» description string false none none
» organizationId string false none none
» color string false none none

getApplicationApplicableTags

Code samples

URL obj = new URL("/api/v2/applicationCategories/application/{applicationPublicId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/applicationCategories/application/{applicationPublicId}', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/applicationCategories/application/{applicationPublicId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/applicationCategories/application/{applicationPublicId}

Parameters

Name In Type Required Description
applicationPublicId path string true none

Example responses

default Response

{
  "applicationCategoriesByOwner": [
    {
      "ownerId": "string",
      "ownerName": "string",
      "ownerType": "application",
      "applicationCategories": [
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "organizationId": "string",
          "color": "string"
        }
      ]
    }
  ]
}

Responses

Status Meaning Description Schema
default Default default response ApplicableTagsDTO

getAppliedPolicyTags

Code samples

URL obj = new URL("/api/v2/applicationCategories/organization/{organizationId}/policy");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/applicationCategories/organization/{organizationId}/policy', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/applicationCategories/organization/{organizationId}/policy',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/applicationCategories/organization/{organizationId}/policy

Parameters

Name In Type Required Description
organizationId path string true none

Example responses

default Response

[
  {
    "id": "string",
    "policyId": "string",
    "tagId": "string"
  }
]

Responses

Status Meaning Description Schema
default Default default response Inline

Response Schema

Status Code default

Name Type Required Restrictions Description
anonymous [PolicyTag] false none none
» id string false none none
» policyId string false none none
» tagId string false none none

getAppliedTags

Code samples

URL obj = new URL("/api/v2/applicationCategories/organization/{organizationId}/applied");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/applicationCategories/organization/{organizationId}/applied', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/applicationCategories/organization/{organizationId}/applied',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/applicationCategories/organization/{organizationId}/applied

Parameters

Name In Type Required Description
organizationId path string true none

Example responses

default Response

{
  "applicationTagsByOwner": [
    {
      "ownerId": "string",
      "ownerName": "string",
      "ownerType": "application",
      "applicationTags": [
        {
          "id": "string",
          "applicationId": "string",
          "tagId": "string"
        }
      ]
    }
  ]
}

Responses

Status Meaning Description Schema
default Default default response AppliedTagsDTO

getTagsUsedByApplications

Code samples

URL obj = new URL("/api/v2/applicationCategories/application");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/applicationCategories/application', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/applicationCategories/application',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/applicationCategories/application

Example responses

default Response

[
  {
    "id": "string",
    "name": "string",
    "description": "string",
    "organizationId": "string",
    "color": "string"
  }
]

Responses

Status Meaning Description Schema
default Default default response Inline

Response Schema

Status Code default

Name Type Required Restrictions Description
anonymous [ApiApplicationCategoryDTO] false none none
» id string false none none
» name string false none none
» description string false none none
» organizationId string false none none
» color string false none none

Applications

getApplications

Code samples

URL obj = new URL("/api/v2/applications");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/applications', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/applications',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/applications

Parameters

Name In Type Required Description
publicId query array[string] false none
includeCategories query boolean false none

Example responses

Responses

Status Meaning Description Schema
default Default default response None

Response Schema

addApplication

Code samples

URL obj = new URL("/api/v2/applications");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('/api/v2/applications', headers = headers)

print(r.json())


const inputBody = '{
  "id": "string",
  "publicId": "string",
  "name": "string",
  "organizationId": "string",
  "contactUserName": "string",
  "applicationTags": [
    {
      "id": "string",
      "tagId": "string",
      "applicationId": "string"
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/api/v2/applications',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /api/v2/applications

Body parameter

{
  "id": "string",
  "publicId": "string",
  "name": "string",
  "organizationId": "string",
  "contactUserName": "string",
  "applicationTags": [
    {
      "id": "string",
      "tagId": "string",
      "applicationId": "string"
    }
  ]
}

Parameters

Name In Type Required Description
body body ApiApplicationDTO false none

Example responses

default Response

{
  "id": "string",
  "publicId": "string",
  "name": "string",
  "organizationId": "string",
  "contactUserName": "string",
  "applicationTags": [
    {
      "id": "string",
      "tagId": "string",
      "applicationId": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
default Default default response ApiApplicationDTO

cloneApplication

Code samples

URL obj = new URL("/api/v2/applications/{sourceApplicationId}/clone");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('/api/v2/applications/{sourceApplicationId}/clone', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/applications/{sourceApplicationId}/clone',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /api/v2/applications/{sourceApplicationId}/clone

Parameters

Name In Type Required Description
sourceApplicationId path string true none
clonedApplicationName query string false none
clonedApplicationPublicId query string false none

Example responses

default Response

{
  "id": "string",
  "publicId": "string",
  "name": "string",
  "organizationId": "string",
  "contactUserName": "string",
  "applicationTags": [
    {
      "id": "string",
      "tagId": "string",
      "applicationId": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
default Default default response ApiApplicationDTO

getApplication

Code samples

URL obj = new URL("/api/v2/applications/{applicationId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/applications/{applicationId}', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/applications/{applicationId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/applications/{applicationId}

Parameters

Name In Type Required Description
applicationId path string true none

Example responses

default Response

{
  "id": "string",
  "publicId": "string",
  "name": "string",
  "organizationId": "string",
  "contactUserName": "string",
  "applicationTags": [
    {
      "id": "string",
      "tagId": "string",
      "applicationId": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
default Default default response ApiApplicationDTO

updateApplication

Code samples

URL obj = new URL("/api/v2/applications/{applicationId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('/api/v2/applications/{applicationId}', headers = headers)

print(r.json())


const inputBody = '{
  "id": "string",
  "publicId": "string",
  "name": "string",
  "organizationId": "string",
  "contactUserName": "string",
  "applicationTags": [
    {
      "id": "string",
      "tagId": "string",
      "applicationId": "string"
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/api/v2/applications/{applicationId}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /api/v2/applications/{applicationId}

Body parameter

{
  "id": "string",
  "publicId": "string",
  "name": "string",
  "organizationId": "string",
  "contactUserName": "string",
  "applicationTags": [
    {
      "id": "string",
      "tagId": "string",
      "applicationId": "string"
    }
  ]
}

Parameters

Name In Type Required Description
applicationId path string true none
body body ApiApplicationDTO false none

Example responses

default Response

{
  "id": "string",
  "publicId": "string",
  "name": "string",
  "organizationId": "string",
  "contactUserName": "string",
  "applicationTags": [
    {
      "id": "string",
      "tagId": "string",
      "applicationId": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
default Default default response ApiApplicationDTO

deleteApplication

Code samples

URL obj = new URL("/api/v2/applications/{applicationId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': '*/*'
}

r = requests.delete('/api/v2/applications/{applicationId}', headers = headers)

print(r.json())



const headers = {
  'Accept':'*/*'
};

fetch('/api/v2/applications/{applicationId}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /api/v2/applications/{applicationId}

Parameters

Name In Type Required Description
applicationId path string true none

Example responses

Responses

Status Meaning Description Schema
default Default default response None

Response Schema

getApplicationsByOrganizationId

Code samples

URL obj = new URL("/api/v2/applications/organization/{organizationId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/applications/organization/{organizationId}', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/applications/organization/{organizationId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/applications/organization/{organizationId}

Parameters

Name In Type Required Description
organizationId path string true none

Example responses

default Response

{
  "applications": [
    {
      "id": "string",
      "publicId": "string",
      "name": "string",
      "organizationId": "string",
      "contactUserName": "string",
      "applicationTags": [
        {
          "id": "string",
          "tagId": "string",
          "applicationId": "string"
        }
      ]
    }
  ]
}

Responses

Status Meaning Description Schema
default Default default response ApiApplicationListDTO

moveApplication

Code samples

URL obj = new URL("/api/v2/applications/{applicationId}/move/organization/{organizationId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('/api/v2/applications/{applicationId}/move/organization/{organizationId}', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/applications/{applicationId}/move/organization/{organizationId}',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /api/v2/applications/{applicationId}/move/organization/{organizationId}

Parameters

Name In Type Required Description
applicationId path string true none
organizationId path string true none

Example responses

default Response

{
  "warnings": [
    "string"
  ],
  "errors": [
    "string"
  ]
}

Responses

Status Meaning Description Schema
default Default default response ApiMoveApplicationResponseDTOV2

getData

Code samples

URL obj = new URL("/api/v2/applications/{applicationPublicId}/reports/{scanId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': '*/*'
}

r = requests.get('/api/v2/applications/{applicationPublicId}/reports/{scanId}', headers = headers)

print(r.json())



const headers = {
  'Accept':'*/*'
};

fetch('/api/v2/applications/{applicationPublicId}/reports/{scanId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/applications/{applicationPublicId}/reports/{scanId}

Parameters

Name In Type Required Description
applicationPublicId path string true none
scanId path string true none

Example responses

Responses

Status Meaning Description Schema
default Default default response None

Response Schema

getDependencyTree

Code samples

URL obj = new URL("/api/v2/applications/{applicationPublicId}/reports/{scanId}/dependencyTree");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/applications/{applicationPublicId}/reports/{scanId}/dependencyTree', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/applications/{applicationPublicId}/reports/{scanId}/dependencyTree',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/applications/{applicationPublicId}/reports/{scanId}/dependencyTree

Parameters

Name In Type Required Description
applicationPublicId path string true none
scanId path string true none

Example responses

default Response

{
  "dependencyTree": {
    "packageUrl": "string",
    "componentIdentifier": {
      "format": "string",
      "coordinates": {
        "property1": "string",
        "property2": "string"
      }
    },
    "children": [
      {}
    ],
    "direct": true
  }
}

Responses

Status Meaning Description Schema
default Default default response ApiDependencyTreeResponseDTO

getPolicyViolationDiff

Code samples

URL obj = new URL("/api/v2/applications/{applicationPublicId}/reports/policyViolations/diff");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/applications/{applicationPublicId}/reports/policyViolations/diff', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/applications/{applicationPublicId}/reports/policyViolations/diff',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/applications/{applicationPublicId}/reports/policyViolations/diff

Parameters

Name In Type Required Description
applicationPublicId path string true none
fromCommit query string false none
toCommit query string false none
fromPolicyEvaluationId query string false none
toPolicyEvaluationId query string false none

Example responses

default Response

{
  "application": {
    "id": "string",
    "publicId": "string",
    "name": "string",
    "organizationId": "string",
    "contactUserName": "string",
    "applicationTags": [
      {
        "id": "string",
        "tagId": "string",
        "applicationId": "string"
      }
    ]
  },
  "fromCommit": {
    "commitHash": "string",
    "scanId": "string",
    "reportUrl": "string",
    "scanTime": "2019-08-24T14:15:22Z"
  },
  "toCommit": {
    "commitHash": "string",
    "scanId": "string",
    "reportUrl": "string",
    "scanTime": "2019-08-24T14:15:22Z"
  },
  "diffTime": "2019-08-24T14:15:22Z",
  "addedViolations": [
    {
      "policyId": "string",
      "policyName": "string",
      "policyViolationId": "string",
      "threatLevel": 0,
      "constraintViolations": [
        {
          "constraintId": "string",
          "constraintName": "string",
          "reasons": [
            {
              "reason": "string",
              "reference": {
                "value": "string",
                "type": "SECURITY_VULNERABILITY_REFID"
              }
            }
          ]
        }
      ],
      "component": {
        "packageUrl": "string",
        "hash": "string",
        "sha256": "string",
        "componentIdentifier": {
          "format": "string",
          "coordinates": {
            "property1": "string",
            "property2": "string"
          }
        },
        "displayName": "string",
        "proprietary": true,
        "thirdParty": true
      }
    }
  ],
  "sameViolations": [
    {
      "policyId": "string",
      "policyName": "string",
      "policyViolationId": "string",
      "threatLevel": 0,
      "constraintViolations": [
        {
          "constraintId": "string",
          "constraintName": "string",
          "reasons": [
            {
              "reason": "string",
              "reference": {
                "value": "string",
                "type": "SECURITY_VULNERABILITY_REFID"
              }
            }
          ]
        }
      ],
      "component": {
        "packageUrl": "string",
        "hash": "string",
        "sha256": "string",
        "componentIdentifier": {
          "format": "string",
          "coordinates": {
            "property1": "string",
            "property2": "string"
          }
        },
        "displayName": "string",
        "proprietary": true,
        "thirdParty": true
      }
    }
  ],
  "removedViolations": [
    {
      "policyId": "string",
      "policyName": "string",
      "policyViolationId": "string",
      "threatLevel": 0,
      "constraintViolations": [
        {
          "constraintId": "string",
          "constraintName": "string",
          "reasons": [
            {
              "reason": "string",
              "reference": {
                "value": "string",
                "type": "SECURITY_VULNERABILITY_REFID"
              }
            }
          ]
        }
      ],
      "component": {
        "packageUrl": "string",
        "hash": "string",
        "sha256": "string",
        "componentIdentifier": {
          "format": "string",
          "coordinates": {
            "property1": "string",
            "property2": "string"
          }
        },
        "displayName": "string",
        "proprietary": true,
        "thirdParty": true
      }
    }
  ]
}

Responses

Status Meaning Description Schema
default Default default response ApiPolicyViolationDiffDTO

getPolicyViolations_1

Code samples

URL obj = new URL("/api/v2/applications/{applicationPublicId}/reports/{scanId}/policy");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/applications/{applicationPublicId}/reports/{scanId}/policy', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/applications/{applicationPublicId}/reports/{scanId}/policy',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/applications/{applicationPublicId}/reports/{scanId}/policy

Parameters

Name In Type Required Description
applicationPublicId path string true none
scanId path string true none

Example responses

default Response

{
  "reportTime": "2019-08-24T14:15:22Z",
  "reportTitle": "string",
  "commitHash": "string",
  "initiator": "string",
  "application": {
    "id": "string",
    "publicId": "string",
    "name": "string",
    "organizationId": "string",
    "contactUserName": "string"
  },
  "counts": {
    "property1": 0,
    "property2": 0
  },
  "components": [
    {
      "packageUrl": "string",
      "hash": "string",
      "sha256": "string",
      "componentIdentifier": {
        "format": "string",
        "coordinates": {
          "property1": "string",
          "property2": "string"
        }
      },
      "displayName": "string",
      "proprietary": true,
      "thirdParty": true,
      "matchState": "string",
      "pathnames": [
        "string"
      ],
      "dependencyData": {
        "directDependency": true,
        "innerSource": true,
        "parentComponentPurls": [
          "string"
        ],
        "innerSourceData": [
          {
            "ownerApplicationName": "string",
            "ownerApplicationId": "string",
            "innerSourceComponentPurl": "string"
          }
        ]
      },
      "violations": [
        {
          "policyId": "string",
          "policyName": "string",
          "policyThreatCategory": "string",
          "policyThreatLevel": 0,
          "policyViolationId": "string",
          "waived": true,
          "grandfathered": true,
          "legacyViolation": true,
          "constraints": [
            {
              "constraintId": "string",
              "constraintName": "string",
              "conditions": [
                {
                  "conditionSummary": "string",
                  "conditionReason": "string"
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

Responses

Status Meaning Description Schema
default Default default response ApiReportPolicyDataDTOV2

getRawData

Code samples

URL obj = new URL("/api/v2/applications/{applicationPublicId}/reports/{scanId}/raw");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/applications/{applicationPublicId}/reports/{scanId}/raw', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/applications/{applicationPublicId}/reports/{scanId}/raw',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/applications/{applicationPublicId}/reports/{scanId}/raw

Parameters

Name In Type Required Description
applicationPublicId path string true none
scanId path string true none

Example responses

default Response

{
  "components": [
    {
      "packageUrl": "string",
      "hash": "string",
      "sha256": "string",
      "componentIdentifier": {
        "format": "string",
        "coordinates": {
          "property1": "string",
          "property2": "string"
        }
      },
      "displayName": "string",
      "proprietary": true,
      "thirdParty": true,
      "matchState": "string",
      "pathnames": [
        "string"
      ],
      "identificationSource": "string",
      "licenseData": {
        "declaredLicenses": [
          {
            "licenseId": "string",
            "licenseName": "string"
          }
        ],
        "observedLicenses": [
          {
            "licenseId": "string",
            "licenseName": "string"
          }
        ],
        "effectiveLicenses": [
          {
            "licenseId": "string",
            "licenseName": "string"
          }
        ],
        "overriddenLicenses": [
          {
            "licenseId": "string",
            "licenseName": "string"
          }
        ],
        "status": "string",
        "effectiveLicenseThreats": [
          {
            "licenseThreatGroupName": "string",
            "licenseThreatGroupLevel": 0,
            "licenseThreatGroupCategory": "string"
          }
        ]
      },
      "securityData": {
        "securityIssues": [
          {
            "source": "string",
            "reference": "string",
            "severity": 0.1,
            "status": "string",
            "url": "string",
            "threatCategory": "string",
            "cwe": "string",
            "cvssVector": "string",
            "cvssVectorSource": "string",
            "analysis": {
              "state": "string",
              "justification": "string",
              "response": "string",
              "detail": "string"
            }
          }
        ]
      },
      "dependencyData": {
        "directDependency": true,
        "innerSource": true,
        "parentComponentPurls": [
          "string"
        ],
        "innerSourceData": [
          {
            "ownerApplicationName": "string",
            "ownerApplicationId": "string",
            "innerSourceComponentPurl": "string"
          }
        ]
      },
      "cpe": "string",
      "swid": {
        "tagId": "string",
        "name": "string",
        "version": "string",
        "tagVersion": 0,
        "patch": true,
        "text": {
          "encoding": "string",
          "contentType": "string",
          "content": "string"
        }
      }
    }
  ],
  "matchSummary": {
    "totalComponentCount": 0,
    "knownComponentCount": 0
  },
  "globalInformation": {
    "dataVersionDate": "string"
  }
}

Responses

Status Meaning Description Schema
default Default default response ApiReportRawDataDTOV2

Audit Logs

getAuditLogs

Code samples

URL obj = new URL("/api/v2/auditLogs");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'text/plain'
}

r = requests.get('/api/v2/auditLogs', headers = headers)

print(r.json())



const headers = {
  'Accept':'text/plain'
};

fetch('/api/v2/auditLogs',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/auditLogs

Parameters

Name In Type Required Description
startUtcDate query string false none
endUtcDate query string false none

Example responses

Responses

Status Meaning Description Schema
default Default default response None

Response Schema

Claim

get

Code samples

URL obj = new URL("/api/v2/claim/components/{hash}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/claim/components/{hash}', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/claim/components/{hash}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/claim/components/{hash}

Parameters

Name In Type Required Description
hash path string true none

Example responses

default Response

{
  "hash": "string",
  "comment": "string",
  "createTime": "2019-08-24T14:15:22Z",
  "componentIdentifier": {
    "format": "string",
    "coordinates": {
      "property1": "string",
      "property2": "string"
    }
  },
  "packageUrl": "string"
}

Responses

Status Meaning Description Schema
default Default default response ApiHashComponentIdentifierDTO

delete

Code samples

URL obj = new URL("/api/v2/claim/components/{hash}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': '*/*'
}

r = requests.delete('/api/v2/claim/components/{hash}', headers = headers)

print(r.json())



const headers = {
  'Accept':'*/*'
};

fetch('/api/v2/claim/components/{hash}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /api/v2/claim/components/{hash}

Parameters

Name In Type Required Description
hash path string true none

Example responses

Responses

Status Meaning Description Schema
default Default default response None

Response Schema

getAll

Code samples

URL obj = new URL("/api/v2/claim/components");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/claim/components', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/claim/components',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/claim/components

Example responses

default Response

{
  "componentClaims": [
    {
      "hash": "string",
      "comment": "string",
      "createTime": "2019-08-24T14:15:22Z",
      "componentIdentifier": {
        "format": "string",
        "coordinates": {
          "property1": "string",
          "property2": "string"
        }
      },
      "packageUrl": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
default Default default response ApiHashComponentIdentifiersDTO

set

Code samples

URL obj = new URL("/api/v2/claim/components");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('/api/v2/claim/components', headers = headers)

print(r.json())


const inputBody = '{
  "hash": "string",
  "comment": "string",
  "createTime": "2019-08-24T14:15:22Z",
  "componentIdentifier": {
    "format": "string",
    "coordinates": {
      "property1": "string",
      "property2": "string"
    }
  },
  "packageUrl": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/api/v2/claim/components',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /api/v2/claim/components

Body parameter

{
  "hash": "string",
  "comment": "string",
  "createTime": "2019-08-24T14:15:22Z",
  "componentIdentifier": {
    "format": "string",
    "coordinates": {
      "property1": "string",
      "property2": "string"
    }
  },
  "packageUrl": "string"
}

Parameters

Name In Type Required Description
body body ApiHashComponentIdentifierDTO false none

Example responses

default Response

{
  "hash": "string",
  "comment": "string",
  "createTime": "2019-08-24T14:15:22Z",
  "componentIdentifier": {
    "format": "string",
    "coordinates": {
      "property1": "string",
      "property2": "string"
    }
  },
  "packageUrl": "string"
}

Responses

Status Meaning Description Schema
default Default default response ApiHashComponentIdentifierDTO

Composite Source Control

getCompositeSourceControlByOwner

Code samples

URL obj = new URL("/api/v2/compositeSourceControl/{ownerType}/{internalOwnerId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/compositeSourceControl/{ownerType}/{internalOwnerId}', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/compositeSourceControl/{ownerType}/{internalOwnerId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/compositeSourceControl/{ownerType}/{internalOwnerId}

Parameters

Name In Type Required Description
ownerType path string true none
internalOwnerId path string true none

Enumerated Values

Parameter Value
ownerType application
ownerType organization
ownerType repository_container
ownerType repository_manager
ownerType repository
ownerType global

Example responses

default Response

{
  "id": "string",
  "ownerId": "string",
  "repositoryUrl": "string",
  "provider": {
    "value": "string",
    "parentValue": "string",
    "parentName": "string"
  },
  "username": {
    "value": "string",
    "parentValue": "string",
    "parentName": "string"
  },
  "token": {
    "value": "string",
    "parentValue": "string",
    "parentName": "string"
  },
  "baseBranch": {
    "value": "string",
    "parentValue": "string",
    "parentName": "string"
  },
  "remediationPullRequestsEnabled": {
    "value": true,
    "parentValue": true,
    "parentName": "string"
  },
  "statusChecksEnabled": {
    "value": true,
    "parentValue": true,
    "parentName": "string"
  },
  "pullRequestCommentingEnabled": {
    "value": true,
    "parentValue": true,
    "parentName": "string"
  },
  "sourceControlEvaluationsEnabled": {
    "value": true,
    "parentValue": true,
    "parentName": "string"
  },
  "sourceControlScanTarget": {
    "value": "string",
    "parentValue": "string",
    "parentName": "string"
  },
  "sshEnabled": {
    "value": true,
    "parentValue": true,
    "parentName": "string"
  },
  "commitStatusEnabled": {
    "value": true,
    "parentValue": true,
    "parentName": "string"
  }
}

Responses

Status Meaning Description Schema
default Default default response ApiCompositeSourceControlDTO

Composite Source Control Config Validator

validateSourceControlConfig

Code samples

URL obj = new URL("/api/v2/compositeSourceControlConfigValidator/application/{applicationId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/compositeSourceControlConfigValidator/application/{applicationId}', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/compositeSourceControlConfigValidator/application/{applicationId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/compositeSourceControlConfigValidator/application/{applicationId}

Parameters

Name In Type Required Description
applicationId path string true none

Example responses

default Response

{
  "configurationComplete": {
    "valid": true,
    "message": "string"
  },
  "repoPrivate": {
    "valid": true,
    "message": "string"
  },
  "tokenPermissions": {
    "valid": true,
    "message": "string"
  },
  "sshConfiguration": {
    "valid": true,
    "message": "string"
  }
}

Responses

Status Meaning Description Schema
default Default default response ConfigurationValidationResult

Config

enabledFeature

Code samples

URL obj = new URL("/api/v2/config/features/{feature}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': '*/*'
}

r = requests.post('/api/v2/config/features/{feature}', headers = headers)

print(r.json())



const headers = {
  'Accept':'*/*'
};

fetch('/api/v2/config/features/{feature}',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /api/v2/config/features/{feature}

Parameters

Name In Type Required Description
feature path string true none

Example responses

Responses

Status Meaning Description Schema
default Default default response None

Response Schema

disableFeature

Code samples

URL obj = new URL("/api/v2/config/features/{feature}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': '*/*'
}

r = requests.delete('/api/v2/config/features/{feature}', headers = headers)

print(r.json())



const headers = {
  'Accept':'*/*'
};

fetch('/api/v2/config/features/{feature}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /api/v2/config/features/{feature}

Parameters

Name In Type Required Description
feature path string true none

Example responses

Responses

Status Meaning Description Schema
default Default default response None

Response Schema

getConfiguration

Code samples

URL obj = new URL("/api/v2/config");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/config', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/config',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/config

Parameters

Name In Type Required Description
property query array[string] false none

Example responses

default Response

{
  "property1": {},
  "property2": {}
}

Responses

Status Meaning Description Schema
default Default default response Inline

Response Schema

Status Code default

Name Type Required Restrictions Description
» additionalProperties object false none none

setConfiguration

Code samples

URL obj = new URL("/api/v2/config");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*'
}

r = requests.put('/api/v2/config', headers = headers)

print(r.json())


const inputBody = '{
  "property1": {},
  "property2": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*'
};

fetch('/api/v2/config',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /api/v2/config

Body parameter

{
  "property1": {},
  "property2": {}
}

Parameters

Name In Type Required Description
body body object false none
» additionalProperties body object false none

Example responses

Responses

Status Meaning Description Schema
default Default default response None

Response Schema

deleteConfiguration

Code samples

URL obj = new URL("/api/v2/config");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': '*/*'
}

r = requests.delete('/api/v2/config', headers = headers)

print(r.json())



const headers = {
  'Accept':'*/*'
};

fetch('/api/v2/config',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /api/v2/config

Parameters

Name In Type Required Description
property query array[string] false none

Example responses

Responses

Status Meaning Description Schema
default Default default response None

Response Schema

Config Artifactory Connection

getOwnerArtifactoryConnection

Code samples

URL obj = new URL("/api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}

Parameters

Name In Type Required Description
ownerType path string true none
internalOwnerId path string true none
inherit query boolean false none

Enumerated Values

Parameter Value
ownerType application
ownerType organization
ownerType repository_container
ownerType repository_manager
ownerType repository
ownerType global

Example responses

default Response

{
  "artifactoryConnection": {
    "artifactoryConnectionId": "string",
    "ownerType": "application",
    "ownerId": "string",
    "isAnonymous": true,
    "baseUrl": "string",
    "username": "string",
    "password": "string"
  },
  "artifactoryConnectionStatus": {
    "enabled": true,
    "inheritedFromOrganizationId": "string",
    "inheritedFromOrganizationName": "string",
    "allowOverride": true,
    "inheritedFromOrgEnabled": true,
    "allowChange": true
  },
  "ownerDTO": {
    "ownerPublicId": "string",
    "ownerId": "string",
    "ownerName": "string",
    "ownerType": "string"
  }
}

Responses

Status Meaning Description Schema
default Default default response ApiOwnerArtifactoryConnectionDTO

updateOwnerArtifactoryConnectionStatus

Code samples

URL obj = new URL("/api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('/api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}', headers = headers)

print(r.json())


const inputBody = '{
  "enabled": true,
  "allowOverride": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}

Body parameter

{
  "enabled": true,
  "allowOverride": true
}

Parameters

Name In Type Required Description
ownerType path string true none
internalOwnerId path string true none
body body ApiArtifactoryConnectionStatusRequestDTO false none

Enumerated Values

Parameter Value
ownerType application
ownerType organization
ownerType repository_container
ownerType repository_manager
ownerType repository
ownerType global

Example responses

Responses

Status Meaning Description Schema
default Default default response None

Response Schema

addArtifactoryConnection

Code samples

URL obj = new URL("/api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('/api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}', headers = headers)

print(r.json())


const inputBody = '{
  "artifactoryConnectionId": "string",
  "ownerType": "application",
  "ownerId": "string",
  "isAnonymous": true,
  "baseUrl": "string",
  "username": "string",
  "password": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}

Body parameter

{
  "artifactoryConnectionId": "string",
  "ownerType": "application",
  "ownerId": "string",
  "isAnonymous": true,
  "baseUrl": "string",
  "username": "string",
  "password": "string"
}

Parameters

Name In Type Required Description
ownerType path string true none
internalOwnerId path string true none
body body ApiArtifactoryConnectionDTO false none

Enumerated Values

Parameter Value
ownerType application
ownerType organization
ownerType repository_container
ownerType repository_manager
ownerType repository
ownerType global

Example responses

default Response

{
  "artifactoryConnectionId": "string",
  "ownerType": "application",
  "ownerId": "string",
  "isAnonymous": true,
  "baseUrl": "string",
  "username": "string",
  "password": "string"
}

Responses

Status Meaning Description Schema
default Default default response ApiArtifactoryConnectionDTO

getArtifactoryConnection

Code samples

URL obj = new URL("/api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}/{artifactoryConnectionId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}/{artifactoryConnectionId}', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}/{artifactoryConnectionId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}/{artifactoryConnectionId}

Parameters

Name In Type Required Description
ownerType path string true none
internalOwnerId path string true none
artifactoryConnectionId path string true none

Enumerated Values

Parameter Value
ownerType application
ownerType organization
ownerType repository_container
ownerType repository_manager
ownerType repository
ownerType global

Example responses

default Response

{
  "artifactoryConnectionId": "string",
  "ownerType": "application",
  "ownerId": "string",
  "isAnonymous": true,
  "baseUrl": "string",
  "username": "string",
  "password": "string"
}

Responses

Status Meaning Description Schema
default Default default response ApiArtifactoryConnectionDTO

updateArtifactoryConnection

Code samples

URL obj = new URL("/api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}/{artifactoryConnectionId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('/api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}/{artifactoryConnectionId}', headers = headers)

print(r.json())


const inputBody = '{
  "artifactoryConnectionId": "string",
  "ownerType": "application",
  "ownerId": "string",
  "isAnonymous": true,
  "baseUrl": "string",
  "username": "string",
  "password": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}/{artifactoryConnectionId}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}/{artifactoryConnectionId}

Body parameter

{
  "artifactoryConnectionId": "string",
  "ownerType": "application",
  "ownerId": "string",
  "isAnonymous": true,
  "baseUrl": "string",
  "username": "string",
  "password": "string"
}

Parameters

Name In Type Required Description
ownerType path string true none
internalOwnerId path string true none
artifactoryConnectionId path string true none
body body ApiArtifactoryConnectionDTO false none

Enumerated Values

Parameter Value
ownerType application
ownerType organization
ownerType repository_container
ownerType repository_manager
ownerType repository
ownerType global

Example responses

default Response

{
  "artifactoryConnectionId": "string",
  "ownerType": "application",
  "ownerId": "string",
  "isAnonymous": true,
  "baseUrl": "string",
  "username": "string",
  "password": "string"
}

Responses

Status Meaning Description Schema
default Default default response ApiArtifactoryConnectionDTO

deleteArtifactoryConnection

Code samples

URL obj = new URL("/api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}/{artifactoryConnectionId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': '*/*'
}

r = requests.delete('/api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}/{artifactoryConnectionId}', headers = headers)

print(r.json())



const headers = {
  'Accept':'*/*'
};

fetch('/api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}/{artifactoryConnectionId}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}/{artifactoryConnectionId}

Parameters

Name In Type Required Description
ownerType path string true none
internalOwnerId path string true none
artifactoryConnectionId path string true none

Enumerated Values

Parameter Value
ownerType application
ownerType organization
ownerType repository_container
ownerType repository_manager
ownerType repository
ownerType global

Example responses

Responses

Status Meaning Description Schema
default Default default response None

Response Schema

testArtifactoryConnection

Code samples

URL obj = new URL("/api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}/test");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Content-Type': '*/*',
  'Accept': 'application/json'
}

r = requests.post('/api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}/test', headers = headers)

print(r.json())


const inputBody = '{
  "artifactoryConnectionId": "string",
  "ownerType": "application",
  "ownerId": "string",
  "isAnonymous": true,
  "baseUrl": "string",
  "username": "string",
  "password": "string"
}';
const headers = {
  'Content-Type':'*/*',
  'Accept':'application/json'
};

fetch('/api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}/test',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}/test

Body parameter

Parameters

Name In Type Required Description
ownerType path string true none
internalOwnerId path string true none
body body ApiArtifactoryConnectionDTO false none

Enumerated Values

Parameter Value
ownerType application
ownerType organization
ownerType repository_container
ownerType repository_manager
ownerType repository
ownerType global

Example responses

default Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
default Default default response ApiStatusDTO

testArtifactoryConnection_1

Code samples

URL obj = new URL("/api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}/{artifactoryConnectionId}/test");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('/api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}/{artifactoryConnectionId}/test', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}/{artifactoryConnectionId}/test',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}/{artifactoryConnectionId}/test

Parameters

Name In Type Required Description
ownerType path string true none
internalOwnerId path string true none
artifactoryConnectionId path string true none

Enumerated Values

Parameter Value
ownerType application
ownerType organization
ownerType repository_container
ownerType repository_manager
ownerType repository
ownerType global

Example responses

default Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
default Default default response ApiStatusDTO

Config Crowd

getCrowdConfiguration

Code samples

URL obj = new URL("/api/v2/config/crowd");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/config/crowd', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/config/crowd',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/config/crowd

Example responses

default Response

{
  "serverUrl": "string",
  "applicationName": "string",
  "applicationPassword": [
    "string"
  ]
}

Responses

Status Meaning Description Schema
default Default default response ApiCrowdConfigurationDTO

insertOrUpdateCrowdConfiguration

Code samples

URL obj = new URL("/api/v2/config/crowd");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*'
}

r = requests.put('/api/v2/config/crowd', headers = headers)

print(r.json())


const inputBody = '{
  "serverUrl": "string",
  "applicationName": "string",
  "applicationPassword": [
    "string"
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*'
};

fetch('/api/v2/config/crowd',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /api/v2/config/crowd

Body parameter

{
  "serverUrl": "string",
  "applicationName": "string",
  "applicationPassword": [
    "string"
  ]
}

Parameters

Name In Type Required Description
body body ApiCrowdConfigurationDTO false none

Example responses

Responses

Status Meaning Description Schema
default Default default response None

Response Schema

deleteCrowdConfiguration

Code samples

URL obj = new URL("/api/v2/config/crowd");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': '*/*'
}

r = requests.delete('/api/v2/config/crowd', headers = headers)

print(r.json())



const headers = {
  'Accept':'*/*'
};

fetch('/api/v2/config/crowd',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /api/v2/config/crowd

Example responses

Responses

Status Meaning Description Schema
default Default default response None

Response Schema

testCrowdConfiguration

Code samples

URL obj = new URL("/api/v2/config/crowd/test");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('/api/v2/config/crowd/test', headers = headers)

print(r.json())


const inputBody = '{
  "serverUrl": "string",
  "applicationName": "string",
  "applicationPassword": [
    "string"
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/api/v2/config/crowd/test',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /api/v2/config/crowd/test

Body parameter

{
  "serverUrl": "string",
  "applicationName": "string",
  "applicationPassword": [
    "string"
  ]
}

Parameters

Name In Type Required Description
body body ApiCrowdConfigurationDTO false none

Example responses

default Response

{
  "code": 0,
  "message": "string"
}

Responses

Status Meaning Description Schema
default Default default response ApiStatusDTO

Config JIRA

getConfiguration_1

Code samples

URL obj = new URL("/api/v2/config/jira");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/config/jira', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/config/jira',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/config/jira

Example responses

default Response

{
  "url": "string",
  "username": "string",
  "password": [
    "string"
  ],
  "customFields": {
    "property1": {},
    "property2": {}
  }
}

Responses

Status Meaning Description Schema
default Default default response ApiJiraConfigurationDTO

setConfiguration_1

Code samples

URL obj = new URL("/api/v2/config/jira");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*'
}

r = requests.put('/api/v2/config/jira', headers = headers)

print(r.json())


const inputBody = '{}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*'
};

fetch('/api/v2/config/jira',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /api/v2/config/jira

Body parameter

{}

Parameters

Name In Type Required Description
body body JsonNode false none

Example responses

Responses

Status Meaning Description Schema
default Default default response None

Response Schema

deleteConfiguration_1

Code samples

URL obj = new URL("/api/v2/config/jira");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': '*/*'
}

r = requests.delete('/api/v2/config/jira', headers = headers)

print(r.json())



const headers = {
  'Accept':'*/*'
};

fetch('/api/v2/config/jira',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /api/v2/config/jira

Example responses

Responses

Status Meaning Description Schema
default Default default response None

Response Schema

Config Mail

getConfiguration_2

Code samples

URL obj = new URL("/api/v2/config/mail");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/config/mail', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/config/mail',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/config/mail

Example responses

default Response

{
  "hostname": "string",
  "port": 0,
  "username": "string",
  "password": [
    "string"
  ],
  "passwordIsIncluded": true,
  "sslEnabled": true,
  "startTlsEnabled": true,
  "systemEmail": "string"
}

Responses

Status Meaning Description Schema
default Default default response ApiMailConfigurationDTO

setConfiguration_2

Code samples

URL obj = new URL("/api/v2/config/mail");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*'
}

r = requests.put('/api/v2/config/mail', headers = headers)

print(r.json())


const inputBody = '{
  "hostname": "string",
  "port": 0,
  "username": "string",
  "password": [
    "string"
  ],
  "passwordIsIncluded": true,
  "sslEnabled": true,
  "startTlsEnabled": true,
  "systemEmail": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*'
};

fetch('/api/v2/config/mail',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /api/v2/config/mail

Body parameter

{
  "hostname": "string",
  "port": 0,
  "username": "string",
  "password": [
    "string"
  ],
  "passwordIsIncluded": true,
  "sslEnabled": true,
  "startTlsEnabled": true,
  "systemEmail": "string"
}

Parameters

Name In Type Required Description
body body ApiMailConfigurationDTO false none

Example responses

Responses

Status Meaning Description Schema
default Default default response None

Response Schema

deleteConfiguration_2

Code samples

URL obj = new URL("/api/v2/config/mail");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': '*/*'
}

r = requests.delete('/api/v2/config/mail', headers = headers)

print(r.json())



const headers = {
  'Accept':'*/*'
};

fetch('/api/v2/config/mail',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /api/v2/config/mail

Example responses

Responses

Status Meaning Description Schema
default Default default response None

Response Schema

testConfiguration

Code samples

URL obj = new URL("/api/v2/config/mail/test/{recipientEmail}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*'
}

r = requests.post('/api/v2/config/mail/test/{recipientEmail}', headers = headers)

print(r.json())


const inputBody = '{
  "hostname": "string",
  "port": 0,
  "username": "string",
  "password": [
    "string"
  ],
  "passwordIsIncluded": true,
  "sslEnabled": true,
  "startTlsEnabled": true,
  "systemEmail": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*'
};

fetch('/api/v2/config/mail/test/{recipientEmail}',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /api/v2/config/mail/test/{recipientEmail}

Body parameter

{
  "hostname": "string",
  "port": 0,
  "username": "string",
  "password": [
    "string"
  ],
  "passwordIsIncluded": true,
  "sslEnabled": true,
  "startTlsEnabled": true,
  "systemEmail": "string"
}

Parameters

Name In Type Required Description
recipientEmail path string true none
body body ApiMailConfigurationDTO false none

Example responses

Responses

Status Meaning Description Schema
default Default default response None

Response Schema

Config Proxy Server

getConfiguration_3

Code samples

URL obj = new URL("/api/v2/config/httpProxyServer");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/config/httpProxyServer', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/config/httpProxyServer',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/config/httpProxyServer

Example responses

default Response

{
  "hostname": "string",
  "port": 0,
  "username": "string",
  "password": [
    "string"
  ],
  "passwordIsIncluded": true,
  "excludeHosts": [
    "string"
  ]
}

Responses

Status Meaning Description Schema
default Default default response ApiProxyServerConfigurationDTO

setConfiguration_3

Code samples

URL obj = new URL("/api/v2/config/httpProxyServer");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*'
}

r = requests.put('/api/v2/config/httpProxyServer', headers = headers)

print(r.json())


const inputBody = '{
  "hostname": "string",
  "port": 0,
  "username": "string",
  "password": [
    "string"
  ],
  "passwordIsIncluded": true,
  "excludeHosts": [
    "string"
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*'
};

fetch('/api/v2/config/httpProxyServer',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /api/v2/config/httpProxyServer

Body parameter

{
  "hostname": "string",
  "port": 0,
  "username": "string",
  "password": [
    "string"
  ],
  "passwordIsIncluded": true,
  "excludeHosts": [
    "string"
  ]
}

Parameters

Name In Type Required Description
body body ApiProxyServerConfigurationDTO false none

Example responses

Responses

Status Meaning Description Schema
default Default default response None

Response Schema

deleteConfiguration_3

Code samples

URL obj = new URL("/api/v2/config/httpProxyServer");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': '*/*'
}

r = requests.delete('/api/v2/config/httpProxyServer', headers = headers)

print(r.json())



const headers = {
  'Accept':'*/*'
};

fetch('/api/v2/config/httpProxyServer',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /api/v2/config/httpProxyServer

Example responses

Responses

Status Meaning Description Schema
default Default default response None

Response Schema

Config Reverse Proxy Authentication

getConfiguration_4

Code samples

URL obj = new URL("/api/v2/config/reverseProxyAuthentication");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/config/reverseProxyAuthentication', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/config/reverseProxyAuthentication',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/config/reverseProxyAuthentication

Example responses

default Response

{
  "enabled": true,
  "usernameHeader": "string",
  "csrfProtectionDisabled": true,
  "logoutUrl": "string"
}

Responses

Status Meaning Description Schema
default Default default response ApiReverseProxyAuthenticationConfigurationDTO

setConfiguration_4

Code samples

URL obj = new URL("/api/v2/config/reverseProxyAuthentication");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*'
}

r = requests.put('/api/v2/config/reverseProxyAuthentication', headers = headers)

print(r.json())


const inputBody = '{
  "enabled": true,
  "usernameHeader": "string",
  "csrfProtectionDisabled": true,
  "logoutUrl": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*'
};

fetch('/api/v2/config/reverseProxyAuthentication',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /api/v2/config/reverseProxyAuthentication

Body parameter

{
  "enabled": true,
  "usernameHeader": "string",
  "csrfProtectionDisabled": true,
  "logoutUrl": "string"
}

Parameters

Name In Type Required Description
body body ApiReverseProxyAuthenticationConfigurationDTO false none

Example responses

Responses

Status Meaning Description Schema
default Default default response None

Response Schema

deleteConfiguration_4

Code samples

URL obj = new URL("/api/v2/config/reverseProxyAuthentication");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': '*/*'
}

r = requests.delete('/api/v2/config/reverseProxyAuthentication', headers = headers)

print(r.json())



const headers = {
  'Accept':'*/*'
};

fetch('/api/v2/config/reverseProxyAuthentication',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /api/v2/config/reverseProxyAuthentication

Example responses

Responses

Status Meaning Description Schema
default Default default response None

Response Schema

Config SAML

getSamlConfiguration

Code samples

URL obj = new URL("/api/v2/config/saml");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/config/saml', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/config/saml',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/config/saml

Example responses

default Response

{
  "identityProviderName": "string",
  "entityId": "string",
  "firstNameAttributeName": "string",
  "lastNameAttributeName": "string",
  "emailAttributeName": "string",
  "usernameAttributeName": "string",
  "groupsAttributeName": "string",
  "validateResponseSignature": true,
  "validateAssertionSignature": true,
  "identityProviderMetadataXml": "string"
}

Responses

Status Meaning Description Schema
default Default default response ApiSamlConfigurationResponseDTO

insertOrUpdateSamlConfiguration

Code samples

URL obj = new URL("/api/v2/config/saml");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Content-Type': 'multipart/form-data',
  'Accept': '*/*'
}

r = requests.put('/api/v2/config/saml', headers = headers)

print(r.json())


const inputBody = '{
  "identityProviderXml": "string",
  "samlConfiguration": {
    "identityProviderName": "string",
    "entityId": "string",
    "firstNameAttributeName": "string",
    "lastNameAttributeName": "string",
    "emailAttributeName": "string",
    "usernameAttributeName": "string",
    "groupsAttributeName": "string",
    "validateResponseSignature": true,
    "validateAssertionSignature": true
  }
}';
const headers = {
  'Content-Type':'multipart/form-data',
  'Accept':'*/*'
};

fetch('/api/v2/config/saml',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /api/v2/config/saml

Body parameter

identityProviderXml: string
samlConfiguration:
  identityProviderName: string
  entityId: string
  firstNameAttributeName: string
  lastNameAttributeName: string
  emailAttributeName: string
  usernameAttributeName: string
  groupsAttributeName: string
  validateResponseSignature: true
  validateAssertionSignature: true

Parameters

Name In Type Required Description
body body object false none
» identityProviderXml body string false none
» samlConfiguration body ApiSamlConfigurationDTO false none
»» identityProviderName body string false none
»» entityId body string false none
»» firstNameAttributeName body string false none
»» lastNameAttributeName body string false none
»» emailAttributeName body string false none
»» usernameAttributeName body string false none
»» groupsAttributeName body string false none
»» validateResponseSignature body boolean false none
»» validateAssertionSignature body boolean false none

Example responses

Responses

Status Meaning Description Schema
default Default default response None

Response Schema

deleteSamlConfiguration

Code samples

URL obj = new URL("/api/v2/config/saml");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': '*/*'
}

r = requests.delete('/api/v2/config/saml', headers = headers)

print(r.json())



const headers = {
  'Accept':'*/*'
};

fetch('/api/v2/config/saml',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /api/v2/config/saml

Example responses

Responses

Status Meaning Description Schema
default Default default response None

Response Schema

getMetadata

Code samples

URL obj = new URL("/api/v2/config/saml/metadata");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/xml'
}

r = requests.get('/api/v2/config/saml/metadata', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/xml'
};

fetch('/api/v2/config/saml/metadata',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/config/saml/metadata

Example responses

default Response

Responses

Status Meaning Description Schema
default Default default response string

Config Source Control

getConfiguration_5

Code samples

URL obj = new URL("/api/v2/config/sourceControl");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/config/sourceControl', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/config/sourceControl',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/config/sourceControl

Example responses

default Response

{
  "cloneDirectory": "string",
  "gitImplementation": "native",
  "prCommentPurgeWindow": 0,
  "prEventPurgeWindow": 0,
  "gitExecutable": "string",
  "gitTimeoutSeconds": 0,
  "commitUsername": "string",
  "commitEmail": "string",
  "useUsernameInRepositoryCloneUrl": true,
  "defaultBranchMonitoringStartTime": "string",
  "defaultBranchMonitoringIntervalHours": 0,
  "pullRequestMonitoringIntervalSeconds": 0
}

Responses

Status Meaning Description Schema
default Default default response ApiSourceControlConfigurationDTO

setConfiguration_5

Code samples

URL obj = new URL("/api/v2/config/sourceControl");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*'
}

r = requests.put('/api/v2/config/sourceControl', headers = headers)

print(r.json())


const inputBody = '{}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*'
};

fetch('/api/v2/config/sourceControl',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /api/v2/config/sourceControl

Body parameter

{}

Parameters

Name In Type Required Description
body body JsonNode false none

Example responses

Responses

Status Meaning Description Schema
default Default default response None

Response Schema

deleteConfiguration_5

Code samples

URL obj = new URL("/api/v2/config/sourceControl");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': '*/*'
}

r = requests.delete('/api/v2/config/sourceControl', headers = headers)

print(r.json())



const headers = {
  'Accept':'*/*'
};

fetch('/api/v2/config/sourceControl',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /api/v2/config/sourceControl

Example responses

Responses

Status Meaning Description Schema
default Default default response None

Response Schema

Endpoints

getOpenAPI

Code samples

URL obj = new URL("/api/v2/endpoints/{apiType}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/endpoints/{apiType}', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/endpoints/{apiType}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/endpoints/{apiType}

Parameters

Name In Type Required Description
apiType path string true none

Enumerated Values

Parameter Value
apiType public
apiType experimental

Example responses

default Response

"string"

Responses

Status Meaning Description Schema
default Default default response string

Firewall

getFirewallMetrics

Code samples

URL obj = new URL("/api/v2/firewall/metrics/embedded");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/firewall/metrics/embedded', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/firewall/metrics/embedded',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/firewall/metrics/embedded

Example responses

default Response

{
  "property1": {
    "firewallMetricsValue": 0,
    "latestUpdatedTime": "2019-08-24T14:15:22Z"
  },
  "property2": {
    "firewallMetricsValue": 0,
    "latestUpdatedTime": "2019-08-24T14:15:22Z"
  }
}

Responses

Status Meaning Description Schema
default Default default response Inline

Response Schema

Status Code default

Name Type Required Restrictions Description
» additionalProperties ApiFirewallMetricsResultDTO false none none
»» firewallMetricsValue integer(int32) false none none
»» latestUpdatedTime string(date-time) false none none

getRepositoryManagers

Code samples

URL obj = new URL("/api/v2/firewall/repositoryManagers");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/firewall/repositoryManagers', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/firewall/repositoryManagers',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/firewall/repositoryManagers

Example responses

default Response

{
  "repositoryManagers": [
    {
      "id": "string",
      "name": "string",
      "instanceId": "string",
      "productName": "string",
      "productVersion": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
default Default default response ApiRepositoryManagerListDTO

addRepositoryManager

Code samples

URL obj = new URL("/api/v2/firewall/repositoryManagers");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('/api/v2/firewall/repositoryManagers', headers = headers)

print(r.json())


const inputBody = '{
  "id": "string",
  "name": "string",
  "instanceId": "string",
  "productName": "string",
  "productVersion": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/api/v2/firewall/repositoryManagers',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /api/v2/firewall/repositoryManagers

Body parameter

{
  "id": "string",
  "name": "string",
  "instanceId": "string",
  "productName": "string",
  "productVersion": "string"
}

Parameters

Name In Type Required Description
body body ApiRepositoryManagerDTO false none

Example responses

default Response

{
  "id": "string",
  "name": "string",
  "instanceId": "string",
  "productName": "string",
  "productVersion": "string"
}

Responses

Status Meaning Description Schema
default Default default response ApiRepositoryManagerDTO

getConfiguredRepositories

Code samples

URL obj = new URL("/api/v2/firewall/repositories/configuration/{repositoryManagerId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/firewall/repositories/configuration/{repositoryManagerId}', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/firewall/repositories/configuration/{repositoryManagerId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/firewall/repositories/configuration/{repositoryManagerId}

Parameters

Name In Type Required Description
repositoryManagerId path string true none
sinceUtcTimestamp query integer(int64) false none

Example responses

default Response

{
  "repositories": [
    {
      "repositoryId": "string",
      "publicId": "string",
      "format": "string",
      "type": "string",
      "auditEnabled": true,
      "quarantineEnabled": true,
      "policyCompliantComponentSelectionEnabled": true,
      "namespaceConfusionProtectionEnabled": true
    }
  ]
}

Responses

Status Meaning Description Schema
default Default default response ApiRepositoryListDTO

configureRepositories

Code samples

URL obj = new URL("/api/v2/firewall/repositories/configuration/{repositoryManagerId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('/api/v2/firewall/repositories/configuration/{repositoryManagerId}', headers = headers)

print(r.json())


const inputBody = '{
  "repositories": [
    {
      "repositoryId": "string",
      "publicId": "string",
      "format": "string",
      "type": "string",
      "auditEnabled": true,
      "quarantineEnabled": true,
      "policyCompliantComponentSelectionEnabled": true,
      "namespaceConfusionProtectionEnabled": true
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/api/v2/firewall/repositories/configuration/{repositoryManagerId}',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /api/v2/firewall/repositories/configuration/{repositoryManagerId}

Body parameter

{
  "repositories": [
    {
      "repositoryId": "string",
      "publicId": "string",
      "format": "string",
      "type": "string",
      "auditEnabled": true,
      "quarantineEnabled": true,
      "policyCompliantComponentSelectionEnabled": true,
      "namespaceConfusionProtectionEnabled": true
    }
  ]
}

Parameters

Name In Type Required Description
repositoryManagerId path string true none
body body ApiRepositoryListDTO false none

Example responses

Responses

Status Meaning Description Schema
default Default default response None

Response Schema

getRepositoryManager

Code samples

URL obj = new URL("/api/v2/firewall/repositoryManagers/{repositoryManagerId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/firewall/repositoryManagers/{repositoryManagerId}', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/firewall/repositoryManagers/{repositoryManagerId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/firewall/repositoryManagers/{repositoryManagerId}

Parameters

Name In Type Required Description
repositoryManagerId path string true none

Example responses

default Response

{
  "id": "string",
  "name": "string",
  "instanceId": "string",
  "productName": "string",
  "productVersion": "string"
}

Responses

Status Meaning Description Schema
default Default default response ApiRepositoryManagerDTO

deleteRepositoryManager

Code samples

URL obj = new URL("/api/v2/firewall/repositoryManagers/{repositoryManagerId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.delete('/api/v2/firewall/repositoryManagers/{repositoryManagerId}', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/firewall/repositoryManagers/{repositoryManagerId}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /api/v2/firewall/repositoryManagers/{repositoryManagerId}

Parameters

Name In Type Required Description
repositoryManagerId path string true none

Example responses

Responses

Status Meaning Description Schema
default Default default response None

Response Schema

evaluateComponents_1

Code samples

URL obj = new URL("/api/v2/firewall/components/{repositoryManagerId}/{repositoryId}/evaluate");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('/api/v2/firewall/components/{repositoryManagerId}/{repositoryId}/evaluate', headers = headers)

print(r.json())


const inputBody = '{
  "format": "string",
  "components": [
    {
      "pathname": "string",
      "hash": "string",
      "packageUrl": "string"
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/api/v2/firewall/components/{repositoryManagerId}/{repositoryId}/evaluate',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /api/v2/firewall/components/{repositoryManagerId}/{repositoryId}/evaluate

Body parameter

{
  "format": "string",
  "components": [
    {
      "pathname": "string",
      "hash": "string",
      "packageUrl": "string"
    }
  ]
}

Parameters

Name In Type Required Description
repositoryManagerId path string true none
repositoryId path string true none
body body ApiRepositoryComponentEvaluationRequestList false none

Example responses

default Response

{
  "repositoryManagerId": "string",
  "repositoryId": "string",
  "repositoryPublicId": "string",
  "repositoryType": "string",
  "results": [
    {
      "quarantined": true,
      "quarantineDate": "2019-08-24T14:15:22Z",
      "component": {
        "pathname": "string",
        "hash": "string",
        "packageUrl": "string"
      },
      "catalogDate": "2019-08-24T14:15:22Z",
      "policyViolations": [
        {
          "policyId": "string",
          "policyName": "string",
          "policyViolationId": "string",
          "threatLevel": 0,
          "constraintViolations": [
            {
              "constraintId": "string",
              "constraintName": "string",
              "reasons": [
                {
                  "reason": "string",
                  "reference": {
                    "value": "string",
                    "type": "SECURITY_VULNERABILITY_REFID"
                  }
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

Responses

Status Meaning Description Schema
default Default default response ApiRepositoryComponentEvaluationResultList

getFirewallAutoUnquarantineConfig

Code samples

URL obj = new URL("/api/v2/firewall/releaseQuarantine/configuration");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/firewall/releaseQuarantine/configuration', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/firewall/releaseQuarantine/configuration',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/firewall/releaseQuarantine/configuration

Example responses

default Response

[
  {
    "id": "string",
    "name": "string",
    "autoReleaseQuarantineEnabled": true
  }
]

Responses

Status Meaning Description Schema
default Default default response Inline

Response Schema

Status Code default

Name Type Required Restrictions Description
anonymous [ApiFirewallReleaseQuarantineConfigDTO] false none none
» id string false none none
» name string false none none
» autoReleaseQuarantineEnabled boolean false none none

setFirewallAutoUnquarantineConfig

Code samples

URL obj = new URL("/api/v2/firewall/releaseQuarantine/configuration");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('/api/v2/firewall/releaseQuarantine/configuration', headers = headers)

print(r.json())


const inputBody = '[
  {
    "id": "string",
    "name": "string",
    "autoReleaseQuarantineEnabled": true
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/api/v2/firewall/releaseQuarantine/configuration',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /api/v2/firewall/releaseQuarantine/configuration

Body parameter

[
  {
    "id": "string",
    "name": "string",
    "autoReleaseQuarantineEnabled": true
  }
]

Parameters

Name In Type Required Description
body body ApiFirewallReleaseQuarantineConfigDTO false none

Example responses

default Response

[
  {
    "id": "string",
    "name": "string",
    "autoReleaseQuarantineEnabled": true
  }
]

Responses

Status Meaning Description Schema
default Default default response Inline

Response Schema

Status Code default

Name Type Required Restrictions Description
anonymous [ApiFirewallReleaseQuarantineConfigDTO] false none none
» id string false none none
» name string false none none
» autoReleaseQuarantineEnabled boolean false none none

getFirewallUnquarantineSummary

Code samples

URL obj = new URL("/api/v2/firewall/releaseQuarantine/summary");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/firewall/releaseQuarantine/summary', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/firewall/releaseQuarantine/summary',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/firewall/releaseQuarantine/summary

Example responses

default Response

{
  "autoReleaseQuarantineCountMTD": 0,
  "autoReleaseQuarantineCountYTD": 0
}

Responses

Status Meaning Description Schema
default Default default response ApiFirewallReleaseQuarantineSummaryDTO

getQuarantineList

Code samples

URL obj = new URL("/api/v2/firewall/components/quarantined");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/firewall/components/quarantined', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/firewall/components/quarantined',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/firewall/components/quarantined

Parameters

Name In Type Required Description
page query integer(int32) false none
pageSize query integer(int32) false none
policyId query array[string] false none
componentName query string false none
sortBy query string false none
asc query boolean false none

Example responses

Responses

Status Meaning Description Schema
default Default default response None

Response Schema

getQuarantineSummary

Code samples

URL obj = new URL("/api/v2/firewall/quarantine/summary");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/firewall/quarantine/summary', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/firewall/quarantine/summary',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/firewall/quarantine/summary

Example responses

default Response

{
  "repositoryCount": 0,
  "quarantineEnabledRepositoryCount": 0,
  "quarantineEnabled": true,
  "totalComponentCount": 0,
  "quarantinedComponentCount": 0
}

Responses

Status Meaning Description Schema
default Default default response ApiFirewallQuarantineSummaryDTO

getQuarantinedComponentViewAnonymousAccess

Code samples

URL obj = new URL("/api/v2/firewall/quarantinedComponentView/configuration/anonymousAccess");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/firewall/quarantinedComponentView/configuration/anonymousAccess', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/firewall/quarantinedComponentView/configuration/anonymousAccess',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/firewall/quarantinedComponentView/configuration/anonymousAccess

Example responses

Responses

Status Meaning Description Schema
default Default default response None

Response Schema

getRepositoryContainer

Code samples

URL obj = new URL("/api/v2/firewall/repositoryContainer");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/firewall/repositoryContainer', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/firewall/repositoryContainer',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/firewall/repositoryContainer

Example responses

default Response

{
  "id": "string",
  "name": "string"
}

Responses

Status Meaning Description Schema
default Default default response ApiRepositoryContainerDTO

getUnquarantineList

Code samples

URL obj = new URL("/api/v2/firewall/components/autoReleasedFromQuarantine");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/firewall/components/autoReleasedFromQuarantine', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/firewall/components/autoReleasedFromQuarantine',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/firewall/components/autoReleasedFromQuarantine

Parameters

Name In Type Required Description
page query integer(int32) false none
pageSize query integer(int32) false none
policyId query string false none
componentName query string false none
sortBy query string false none
asc query boolean false none

Example responses

Responses

Status Meaning Description Schema
default Default default response None

Response Schema

setQuarantinedComponentViewAnonymousAccess

Code samples

URL obj = new URL("/api/v2/firewall/quarantinedComponentView/configuration/anonymousAccess/{enabled}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.put('/api/v2/firewall/quarantinedComponentView/configuration/anonymousAccess/{enabled}', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/firewall/quarantinedComponentView/configuration/anonymousAccess/{enabled}',
{
  method: 'PUT',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /api/v2/firewall/quarantinedComponentView/configuration/anonymousAccess/{enabled}

Parameters

Name In Type Required Description
enabled path boolean true none

Example responses

Responses

Status Meaning Description Schema
default Default default response None

Response Schema

Labels

getLabels

Code samples

URL obj = new URL("/api/v2/labels/{ownerType}/{ownerId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/labels/{ownerType}/{ownerId}', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/labels/{ownerType}/{ownerId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/labels/{ownerType}/{ownerId}

Parameters

Name In Type Required Description
ownerType path string true none
ownerId path string true none
inherit query boolean false none

Enumerated Values

Parameter Value
ownerType application
ownerType organization
ownerType repository_container
ownerType repository_manager
ownerType repository
ownerType global

Example responses

default Response

[
  {
    "id": "string",
    "label": "string",
    "description": "string",
    "color": "string",
    "ownerId": "string",
    "ownerType": "string"
  }
]

Responses

Status Meaning Description Schema
default Default default response Inline

Response Schema

Status Code default

Name Type Required Restrictions Description
anonymous [ApiLabelDTO] false none none
» id string false none none
» label string false none none
» description string false none none
» color string false none none
» ownerId string false none none
» ownerType string false none none

updateLabel

Code samples

URL obj = new URL("/api/v2/labels/{ownerType}/{ownerId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('/api/v2/labels/{ownerType}/{ownerId}', headers = headers)

print(r.json())


const inputBody = '{
  "id": "string",
  "label": "string",
  "description": "string",
  "color": "string",
  "ownerId": "string",
  "ownerType": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/api/v2/labels/{ownerType}/{ownerId}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /api/v2/labels/{ownerType}/{ownerId}

Body parameter

{
  "id": "string",
  "label": "string",
  "description": "string",
  "color": "string",
  "ownerId": "string",
  "ownerType": "string"
}

Parameters

Name In Type Required Description
ownerType path string true none
ownerId path string true none
body body ApiLabelDTO false none

Enumerated Values

Parameter Value
ownerType application
ownerType organization
ownerType repository_container
ownerType repository_manager
ownerType repository
ownerType global

Example responses

default Response

{
  "id": "string",
  "label": "string",
  "description": "string",
  "color": "string",
  "ownerId": "string",
  "ownerType": "string"
}

Responses

Status Meaning Description Schema
default Default default response ApiLabelDTO

addLabel

Code samples

URL obj = new URL("/api/v2/labels/{ownerType}/{ownerId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('/api/v2/labels/{ownerType}/{ownerId}', headers = headers)

print(r.json())


const inputBody = '{
  "id": "string",
  "label": "string",
  "description": "string",
  "color": "string",
  "ownerId": "string",
  "ownerType": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/api/v2/labels/{ownerType}/{ownerId}',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /api/v2/labels/{ownerType}/{ownerId}

Body parameter

{
  "id": "string",
  "label": "string",
  "description": "string",
  "color": "string",
  "ownerId": "string",
  "ownerType": "string"
}

Parameters

Name In Type Required Description
ownerType path string true none
ownerId path string true none
body body ApiLabelDTO false none

Enumerated Values

Parameter Value
ownerType application
ownerType organization
ownerType repository_container
ownerType repository_manager
ownerType repository
ownerType global

Example responses

default Response

{
  "id": "string",
  "label": "string",
  "description": "string",
  "color": "string",
  "ownerId": "string",
  "ownerType": "string"
}

Responses

Status Meaning Description Schema
default Default default response ApiLabelDTO

deleteLabel

Code samples

URL obj = new URL("/api/v2/labels/{ownerType}/{ownerId}/{labelId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': '*/*'
}

r = requests.delete('/api/v2/labels/{ownerType}/{ownerId}/{labelId}', headers = headers)

print(r.json())



const headers = {
  'Accept':'*/*'
};

fetch('/api/v2/labels/{ownerType}/{ownerId}/{labelId}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /api/v2/labels/{ownerType}/{ownerId}/{labelId}

Parameters

Name In Type Required Description
ownerType path string true none
ownerId path string true none
labelId path string true none

Enumerated Values

Parameter Value
ownerType application
ownerType organization
ownerType repository_container
ownerType repository_manager
ownerType repository
ownerType global

Example responses

Responses

Status Meaning Description Schema
default Default default response None

Response Schema

getApplicableContexts

Code samples

URL obj = new URL("/api/v2/labels/{ownerType}/{ownerId}/applicable/context/{labelId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/labels/{ownerType}/{ownerId}/applicable/context/{labelId}', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/labels/{ownerType}/{ownerId}/applicable/context/{labelId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/labels/{ownerType}/{ownerId}/applicable/context/{labelId}

Parameters

Name In Type Required Description
ownerType path string true none
ownerId path string true none
labelId path string true none

Enumerated Values

Parameter Value
ownerType application
ownerType organization
ownerType repository_container
ownerType repository_manager
ownerType repository
ownerType global

Example responses

default Response

{
  "id": "string",
  "name": "string",
  "type": "application",
  "children": [
    {
      "id": "string",
      "name": "string",
      "type": "application",
      "children": []
    }
  ]
}

Responses

Status Meaning Description Schema
default Default default response ApplicableContext

getApplicableLabels

Code samples

URL obj = new URL("/api/v2/labels/{ownerType}/{ownerId}/applicable");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/labels/{ownerType}/{ownerId}/applicable', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/labels/{ownerType}/{ownerId}/applicable',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/labels/{ownerType}/{ownerId}/applicable

Parameters

Name In Type Required Description
ownerType path string true none
ownerId path string true none

Enumerated Values

Parameter Value
ownerType application
ownerType organization
ownerType repository_container
ownerType repository_manager
ownerType repository
ownerType global

Example responses

default Response

{
  "labelsByOwner": [
    {
      "ownerId": "string",
      "ownerName": "string",
      "ownerType": "application",
      "labels": [
        {
          "id": "string",
          "label": "string",
          "description": "string",
          "color": "string",
          "ownerId": "string",
          "ownerType": "string"
        }
      ]
    }
  ]
}

Responses

Status Meaning Description Schema
default Default default response ApplicableLabels

License Legal Metadata

getAttributionReportTemplateById

Code samples

URL obj = new URL("/api/v2/licenseLegalMetadata/report-template/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/licenseLegalMetadata/report-template/{id}', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/licenseLegalMetadata/report-template/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/licenseLegalMetadata/report-template/{id}

Parameters

Name In Type Required Description
id path string true none

Example responses

default Response

{
  "id": "string",
  "templateName": "string",
  "documentTitle": "string",
  "header": "string",
  "footer": "string",
  "includeTableOfContents": true,
  "includeAppendix": true,
  "includeStandardLicenseTexts": true,
  "includeSonatypeSpecialLicenses": true,
  "lastUpdatedAt": "2019-08-24T14:15:22Z",
  "includeInnerSource": true
}

Responses

Status Meaning Description Schema
default Default default response AttributionReportTemplateDTO

deleteAttributionReportTemplate

Code samples

URL obj = new URL("/api/v2/licenseLegalMetadata/report-template/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': '*/*'
}

r = requests.delete('/api/v2/licenseLegalMetadata/report-template/{id}', headers = headers)

print(r.json())



const headers = {
  'Accept':'*/*'
};

fetch('/api/v2/licenseLegalMetadata/report-template/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /api/v2/licenseLegalMetadata/report-template/{id}

Parameters

Name In Type Required Description
id path string true none

Example responses

Responses

Status Meaning Description Schema
default Default default response None

Response Schema

getAllAttributionReportTemplates

Code samples

URL obj = new URL("/api/v2/licenseLegalMetadata/report-template");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/licenseLegalMetadata/report-template', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/licenseLegalMetadata/report-template',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/licenseLegalMetadata/report-template

Example responses

default Response

[
  {
    "id": "string",
    "templateName": "string",
    "documentTitle": "string",
    "header": "string",
    "footer": "string",
    "includeTableOfContents": true,
    "includeAppendix": true,
    "includeStandardLicenseTexts": true,
    "includeSonatypeSpecialLicenses": true,
    "lastUpdatedAt": "2019-08-24T14:15:22Z",
    "includeInnerSource": true
  }
]

Responses

Status Meaning Description Schema
default Default default response Inline

Response Schema

Status Code default

Name Type Required Restrictions Description
anonymous [AttributionReportTemplateDTO] false none none
» id string false none none
» templateName string false none none
» documentTitle string false none none
» header string false none none
» footer string false none none
» includeTableOfContents boolean false none none
» includeAppendix boolean false none none
» includeStandardLicenseTexts boolean false none none
» includeSonatypeSpecialLicenses boolean false none none
» lastUpdatedAt string(date-time) false none none
» includeInnerSource boolean false none none

saveAttributionReportTemplate

Code samples

URL obj = new URL("/api/v2/licenseLegalMetadata/report-template");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('/api/v2/licenseLegalMetadata/report-template', headers = headers)

print(r.json())


const inputBody = '{
  "id": "string",
  "templateName": "string",
  "documentTitle": "string",
  "header": "string",
  "footer": "string",
  "includeTableOfContents": true,
  "includeAppendix": true,
  "includeStandardLicenseTexts": true,
  "includeSonatypeSpecialLicenses": true,
  "lastUpdatedAt": "2019-08-24T14:15:22Z",
  "includeInnerSource": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/api/v2/licenseLegalMetadata/report-template',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /api/v2/licenseLegalMetadata/report-template

Body parameter

{
  "id": "string",
  "templateName": "string",
  "documentTitle": "string",
  "header": "string",
  "footer": "string",
  "includeTableOfContents": true,
  "includeAppendix": true,
  "includeStandardLicenseTexts": true,
  "includeSonatypeSpecialLicenses": true,
  "lastUpdatedAt": "2019-08-24T14:15:22Z",
  "includeInnerSource": true
}

Parameters

Name In Type Required Description
body body AttributionReportTemplateDTO false none

Example responses

default Response

{
  "id": "string",
  "templateName": "string",
  "documentTitle": "string",
  "header": "string",
  "footer": "string",
  "includeTableOfContents": true,
  "includeAppendix": true,
  "includeStandardLicenseTexts": true,
  "includeSonatypeSpecialLicenses": true,
  "lastUpdatedAt": "2019-08-24T14:15:22Z",
  "includeInnerSource": true
}

Responses

Status Meaning Description Schema
default Default default response AttributionReportTemplateDTO

getLicenseLegalApplicationHTMLReport

Code samples

URL obj = new URL("/api/v2/licenseLegalMetadata/application/{applicationId}/stage/{stageId}/report");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'text/html'
}

r = requests.get('/api/v2/licenseLegalMetadata/application/{applicationId}/stage/{stageId}/report', headers = headers)

print(r.json())



const headers = {
  'Accept':'text/html'
};

fetch('/api/v2/licenseLegalMetadata/application/{applicationId}/stage/{stageId}/report',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/licenseLegalMetadata/application/{applicationId}/stage/{stageId}/report

Parameters

Name In Type Required Description
applicationId path string true none
stageId path string true none

Example responses

default Response

"string"

Responses

Status Meaning Description Schema
default Default default response string

getLicenseLegalCustomApplicationHTMLReport

Code samples

URL obj = new URL("/api/v2/licenseLegalMetadata/application/{applicationId}/stage/{stageId}/report");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Content-Type': '*/*',
  'Accept': 'text/html'
}

r = requests.post('/api/v2/licenseLegalMetadata/application/{applicationId}/stage/{stageId}/report', headers = headers)

print(r.json())


const inputBody = '{
  "contentDisposition": {
    "type": "string",
    "parameters": {
      "property1": "string",
      "property2": "string"
    },
    "fileName": "string",
    "creationDate": "2019-08-24T14:15:22Z",
    "modificationDate": "2019-08-24T14:15:22Z",
    "readDate": "2019-08-24T14:15:22Z",
    "size": 0
  },
  "entity": {},
  "headers": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  },
  "mediaType": {
    "type": "string",
    "subtype": "string",
    "parameters": {
      "property1": "string",
      "property2": "string"
    },
    "wildcardType": true,
    "wildcardSubtype": true
  },
  "messageBodyWorkers": {},
  "parent": {
    "contentDisposition": {
      "type": "string",
      "parameters": {
        "property1": "string",
        "property2": "string"
      },
      "fileName": "string",
      "creationDate": "2019-08-24T14:15:22Z",
      "modificationDate": "2019-08-24T14:15:22Z",
      "readDate": "2019-08-24T14:15:22Z",
      "size": 0
    },
    "entity": {},
    "headers": {
      "property1": [
        "string"
      ],
      "property2": [
        "string"
      ]
    },
    "mediaType": {
      "type": "string",
      "subtype": "string",
      "parameters": {
        "property1": "string",
        "property2": "string"
      },
      "wildcardType": true,
      "wildcardSubtype": true
    },
    "messageBodyWorkers": {},
    "parent": {},
    "providers": {},
    "bodyParts": [
      {
        "contentDisposition": {
          "type": "string",
          "parameters": {
            "property1": "string",
            "property2": "string"
          },
          "fileName": "string",
          "creationDate": "2019-08-24T14:15:22Z",
          "modificationDate": "2019-08-24T14:15:22Z",
          "readDate": "2019-08-24T14:15:22Z",
          "size": 0
        },
        "entity": {},
        "headers": {
          "property1": [
            "string"
          ],
          "property2": [
            "string"
          ]
        },
        "mediaType": {
          "type": "string",
          "subtype": "string",
          "parameters": {
            "property1": "string",
            "property2": "string"
          },
          "wildcardType": true,
          "wildcardSubtype": true
        },
        "messageBodyWorkers": {},
        "parent": {},
        "providers": {},
        "parameterizedHeaders": {
          "property1": [
            {
              "value": "string",
              "parameters": {
                "property1": "string",
                "property2": "string"
              }
            }
          ],
          "property2": [
            {
              "value": "string",
              "parameters": {
                "property1": "string",
                "property2": "string"
              }
            }
          ]
        }
      }
    ],
    "parameterizedHeaders": {
      "property1": [
        {
          "value": "string",
          "parameters": {
            "property1": "string",
            "property2": "string"
          }
        }
      ],
      "property2": [
        {
          "value": "string",
          "parameters": {
            "property1": "string",
            "property2": "string"
          }
        }
      ]
    }
  },
  "providers": {},
  "bodyParts": [
    {
      "contentDisposition": {
        "type": "string",
        "parameters": {
          "property1": "string",
          "property2": "string"
        },
        "fileName": "string",
        "creationDate": "2019-08-24T14:15:22Z",
        "modificationDate": "2019-08-24T14:15:22Z",
        "readDate": "2019-08-24T14:15:22Z",
        "size": 0
      },
      "entity": {},
      "headers": {
        "property1": [
          "string"
        ],
        "property2": [
          "string"
        ]
      },
      "mediaType": {
        "type": "string",
        "subtype": "string",
        "parameters": {
          "property1": "string",
          "property2": "string"
        },
        "wildcardType": true,
        "wildcardSubtype": true
      },
      "messageBodyWorkers": {},
      "parent": {
        "contentDisposition": {
          "type": "string",
          "parameters": {
            "property1": "string",
            "property2": "string"
          },
          "fileName": "string",
          "creationDate": "2019-08-24T14:15:22Z",
          "modificationDate": "2019-08-24T14:15:22Z",
          "readDate": "2019-08-24T14:15:22Z",
          "size": 0
        },
        "entity": {},
        "headers": {
          "property1": [
            "string"
          ],
          "property2": [
            "string"
          ]
        },
        "mediaType": {
          "type": "string",
          "subtype": "string",
          "parameters": {
            "property1": "string",
            "property2": "string"
          },
          "wildcardType": true,
          "wildcardSubtype": true
        },
        "messageBodyWorkers": {},
        "parent": {},
        "providers": {},
        "bodyParts": [
          {}
        ],
        "parameterizedHeaders": {
          "property1": [
            {
              "value": "string",
              "parameters": {
                "property1": "string",
                "property2": "string"
              }
            }
          ],
          "property2": [
            {
              "value": "string",
              "parameters": {
                "property1": "string",
                "property2": "string"
              }
            }
          ]
        }
      },
      "providers": {},
      "parameterizedHeaders": {
        "property1": [
          {
            "value": "string",
            "parameters": {
              "property1": "string",
              "property2": "string"
            }
          }
        ],
        "property2": [
          {
            "value": "string",
            "parameters": {
              "property1": "string",
              "property2": "string"
            }
          }
        ]
      }
    }
  ],
  "fields": {
    "property1": [
      {
        "contentDisposition": {
          "type": "string",
          "parameters": {
            "property1": "string",
            "property2": "string"
          },
          "fileName": "string",
          "creationDate": "2019-08-24T14:15:22Z",
          "modificationDate": "2019-08-24T14:15:22Z",
          "readDate": "2019-08-24T14:15:22Z",
          "size": 0
        },
        "entity": {},
        "headers": {
          "property1": [
            "string"
          ],
          "property2": [
            "string"
          ]
        },
        "mediaType": {
          "type": "string",
          "subtype": "string",
          "parameters": {
            "property1": "string",
            "property2": "string"
          },
          "wildcardType": true,
          "wildcardSubtype": true
        },
        "messageBodyWorkers": {},
        "parent": {
          "contentDisposition": {
            "type": "string",
            "parameters": {
              "property1": "string",
              "property2": "string"
            },
            "fileName": "string",
            "creationDate": "2019-08-24T14:15:22Z",
            "modificationDate": "2019-08-24T14:15:22Z",
            "readDate": "2019-08-24T14:15:22Z",
            "size": 0
          },
          "entity": {},
          "headers": {
            "property1": [
              "string"
            ],
            "property2": [
              "string"
            ]
          },
          "mediaType": {
            "type": "string",
            "subtype": "string",
            "parameters": {
              "property1": "string",
              "property2": "string"
            },
            "wildcardType": true,
            "wildcardSubtype": true
          },
          "messageBodyWorkers": {},
          "parent": {},
          "providers": {},
          "bodyParts": [
            {
              "contentDisposition": {
                "type": "string",
                "parameters": {
                  "property1": "string",
                  "property2": "string"
                },
                "fileName": "string",
                "creationDate": "2019-08-24T14:15:22Z",
                "modificationDate": "2019-08-24T14:15:22Z",
                "readDate": "2019-08-24T14:15:22Z",
                "size": 0
              },
              "entity": {},
              "headers": {
                "property1": [
                  "string"
                ],
                "property2": [
                  "string"
                ]
              },
              "mediaType": {
                "type": "string",
                "subtype": "string",
                "parameters": {
                  "property1": "string",
                  "property2": "string"
                },
                "wildcardType": true,
                "wildcardSubtype": true
              },
              "messageBodyWorkers": {},
              "parent": {},
              "providers": {},
              "parameterizedHeaders": {
                "property1": [
                  {
                    "value": "string",
                    "parameters": {}
                  }
                ],
                "property2": [
                  {
                    "value": "string",
                    "parameters": {}
                  }
                ]
              }
            }
          ],
          "parameterizedHeaders": {
            "property1": [
              {
                "value": "string",
                "parameters": {
                  "property1": "string",
                  "property2": "string"
                }
              }
            ],
            "property2": [
              {
                "value": "string",
                "parameters": {
                  "property1": "string",
                  "property2": "string"
                }
              }
            ]
          }
        },
        "providers": {},
        "simple": true,
        "name": "string",
        "value": "string",
        "formDataContentDisposition": {
          "type": "string",
          "parameters": {
            "property1": "string",
            "property2": "string"
          },
          "fileName": "string",
          "creationDate": "2019-08-24T14:15:22Z",
          "modificationDate": "2019-08-24T14:15:22Z",
          "readDate": "2019-08-24T14:15:22Z",
          "size": 0,
          "name": "string"
        },
        "parameterizedHeaders": {
          "property1": [
            {
              "value": "string",
              "parameters": {
                "property1": "string",
                "property2": "string"
              }
            }
          ],
          "property2": [
            {
              "value": "string",
              "parameters": {
                "property1": "string",
                "property2": "string"
              }
            }
          ]
        }
      }
    ],
    "property2": [
      {
        "contentDisposition": {
          "type": "string",
          "parameters": {
            "property1": "string",
            "property2": "string"
          },
          "fileName": "string",
          "creationDate": "2019-08-24T14:15:22Z",
          "modificationDate": "2019-08-24T14:15:22Z",
          "readDate": "2019-08-24T14:15:22Z",
          "size": 0
        },
        "entity": {},
        "headers": {
          "property1": [
            "string"
          ],
          "property2": [
            "string"
          ]
        },
        "mediaType": {
          "type": "string",
          "subtype": "string",
          "parameters": {
            "property1": "string",
            "property2": "string"
          },
          "wildcardType": true,
          "wildcardSubtype": true
        },
        "messageBodyWorkers": {},
        "parent": {
          "contentDisposition": {
            "type": "string",
            "parameters": {
              "property1": "string",
              "property2": "string"
            },
            "fileName": "string",
            "creationDate": "2019-08-24T14:15:22Z",
            "modificationDate": "2019-08-24T14:15:22Z",
            "readDate": "2019-08-24T14:15:22Z",
            "size": 0
          },
          "entity": {},
          "headers": {
            "property1": [
              "string"
            ],
            "property2": [
              "string"
            ]
          },
          "mediaType": {
            "type": "string",
            "subtype": "string",
            "parameters": {
              "property1": "string",
              "property2": "string"
            },
            "wildcardType": true,
            "wildcardSubtype": true
          },
          "messageBodyWorkers": {},
          "parent": {},
          "providers": {},
          "bodyParts": [
            {
              "contentDisposition": {
                "type": "string",
                "parameters": {
                  "property1": "string",
                  "property2": "string"
                },
                "fileName": "string",
                "creationDate": "2019-08-24T14:15:22Z",
                "modificationDate": "2019-08-24T14:15:22Z",
                "readDate": "2019-08-24T14:15:22Z",
                "size": 0
              },
              "entity": {},
              "headers": {
                "property1": [
                  "string"
                ],
                "property2": [
                  "string"
                ]
              },
              "mediaType": {
                "type": "string",
                "subtype": "string",
                "parameters": {
                  "property1": "string",
                  "property2": "string"
                },
                "wildcardType": true,
                "wildcardSubtype": true
              },
              "messageBodyWorkers": {},
              "parent": {},
              "providers": {},
              "parameterizedHeaders": {
                "property1": [
                  {
                    "value": "string",
                    "parameters": {}
                  }
                ],
                "property2": [
                  {
                    "value": "string",
                    "parameters": {}
                  }
                ]
              }
            }
          ],
          "parameterizedHeaders": {
            "property1": [
              {
                "value": "string",
                "parameters": {
                  "property1": "string",
                  "property2": "string"
                }
              }
            ],
            "property2": [
              {
                "value": "string",
                "parameters": {
                  "property1": "string",
                  "property2": "string"
                }
              }
            ]
          }
        },
        "providers": {},
        "simple": true,
        "name": "string",
        "value": "string",
        "formDataContentDisposition": {
          "type": "string",
          "parameters": {
            "property1": "string",
            "property2": "string"
          },
          "fileName": "string",
          "creationDate": "2019-08-24T14:15:22Z",
          "modificationDate": "2019-08-24T14:15:22Z",
          "readDate": "2019-08-24T14:15:22Z",
          "size": 0,
          "name": "string"
        },
        "parameterizedHeaders": {
          "property1": [
            {
              "value": "string",
              "parameters": {
                "property1": "string",
                "property2": "string"
              }
            }
          ],
          "property2": [
            {
              "value": "string",
              "parameters": {
                "property1": "string",
                "property2": "string"
              }
            }
          ]
        }
      }
    ]
  },
  "parameterizedHeaders": {
    "property1": [
      {
        "value": "string",
        "parameters": {
          "property1": "string",
          "property2": "string"
        }
      }
    ],
    "property2": [
      {
        "value": "string",
        "parameters": {
          "property1": "string",
          "property2": "string"
        }
      }
    ]
  }
}';
const headers = {
  'Content-Type':'*/*',
  'Accept':'text/html'
};

fetch('/api/v2/licenseLegalMetadata/application/{applicationId}/stage/{stageId}/report',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /api/v2/licenseLegalMetadata/application/{applicationId}/stage/{stageId}/report

Body parameter

Parameters

Name In Type Required Description
applicationId path string true none
stageId path string true none
body body FormDataMultiPart false none

Example responses

default Response

"string"

Responses

Status Meaning Description Schema
default Default default response string

getLicenseLegalApplicationReport

Code samples

URL obj = new URL("/api/v2/licenseLegalMetadata/application/{applicationId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/licenseLegalMetadata/application/{applicationId}', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/licenseLegalMetadata/application/{applicationId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/licenseLegalMetadata/application/{applicationId}

Parameters

Name In Type Required Description
applicationId path string true none

Example responses

default Response

{
  "components": [
    {
      "packageUrl": "string",
      "hash": "string",
      "componentIdentifier": {
        "format": "string",
        "coordinates": {
          "property1": "string",
          "property2": "string"
        }
      },
      "displayName": "string",
      "licenseLegalData": {
        "declaredLicenses": [
          "string"
        ],
        "observedLicenses": [
          "string"
        ],
        "effectiveLicenses": [
          "string"
        ],
        "highestEffectiveLicenseThreatGroup": {
          "licenseThreatGroupName": "string",
          "licenseThreatGroupLevel": 0,
          "licenseThreatGroupCategory": "string"
        },
        "copyrights": [
          {
            "id": "string",
            "content": "string",
            "originalContentHash": "string",
            "status": "enabled"
          }
        ],
        "licenseFiles": [
          {
            "id": "string",
            "relPath": "string",
            "content": "string",
            "originalContentHash": "string",
            "status": "enabled"
          }
        ],
        "noticeFiles": [
          {
            "id": "string",
            "relPath": "string",
            "content": "string",
            "originalContentHash": "string",
            "status": "enabled"
          }
        ],
        "obligations": [
          {
            "id": "string",
            "name": "string",
            "status": "OPEN",
            "comment": "string",
            "componentIdentifier": {
              "format": "string",
              "coordinates": {
                "property1": "string",
                "property2": "string"
              }
            },
            "packageUrl": "string",
            "ownerId": "string",
            "lastUpdatedAt": "2019-08-24T14:15:22Z",
            "lastUpdatedByUsername": "string"
          }
        ],
        "attributions": [
          {
            "id": "string",
            "componentIdentifier": {
              "format": "string",
              "coordinates": {
                "property1": "string",
                "property2": "string"
              }
            },
            "packageUrl": "string",
            "ownerId": "string",
            "obligationName": "string",
            "content": "string",
            "lastUpdatedAt": "2019-08-24T14:15:22Z",
            "lastUpdatedByUsername": "string"
          }
        ],
        "sourceLinks": [
          {
            "id": "string",
            "content": "string",
            "originalContent": "string",
            "status": "enabled"
          }
        ],
        "effectiveLicenseStatus": "string",
        "componentCopyrightId": "string",
        "componentCopyrightScopeOwnerId": "string",
        "componentCopyrightLastUpdatedByUsername": "string",
        "componentCopyrightLastUpdatedAt": "2019-08-24T14:15:22Z",
        "componentLicensesId": "string",
        "componentLicensesScopeOwnerId": "string",
        "componentLicensesLastUpdatedByUsername": "string",
        "componentLicensesLastUpdatedAt": "2019-08-24T14:15:22Z",
        "componentNoticesId": "string",
        "componentNoticesScopeOwnerId": "string",
        "componentNoticesLastUpdatedByUsername": "string",
        "componentNoticesLastUpdatedAt": "2019-08-24T14:15:22Z"
      },
      "stageScans": [
        {
          "stageName": "string",
          "scanId": "string",
          "scanDate": "2019-08-24T14:15:22Z"
        }
      ]
    }
  ],
  "licenseLegalMetadata": [
    {
      "licenseId": "string",
      "licenseName": "string",
      "licenseText": "string",
      "obligations": [
        {
          "name": "string",
          "obligationTexts": [
            "string"
          ]
        }
      ],
      "threatGroup": {
        "name": "string",
        "threatLevel": 0
      },
      "isMulti": true,
      "singleLicenseIds": [
        "string"
      ]
    }
  ]
}

Responses

Status Meaning Description Schema
default Default default response ApiLicenseLegalApplicationReportDTO

getLicenseLegalApplicationReport_1

Code samples

URL obj = new URL("/api/v2/licenseLegalMetadata/application/{applicationId}/stage/{stageId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/licenseLegalMetadata/application/{applicationId}/stage/{stageId}', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/licenseLegalMetadata/application/{applicationId}/stage/{stageId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/licenseLegalMetadata/application/{applicationId}/stage/{stageId}

Parameters

Name In Type Required Description
applicationId path string true none
stageId path string true none

Example responses

default Response

{
  "components": [
    {
      "packageUrl": "string",
      "hash": "string",
      "componentIdentifier": {
        "format": "string",
        "coordinates": {
          "property1": "string",
          "property2": "string"
        }
      },
      "displayName": "string",
      "licenseLegalData": {
        "declaredLicenses": [
          "string"
        ],
        "observedLicenses": [
          "string"
        ],
        "effectiveLicenses": [
          "string"
        ],
        "highestEffectiveLicenseThreatGroup": {
          "licenseThreatGroupName": "string",
          "licenseThreatGroupLevel": 0,
          "licenseThreatGroupCategory": "string"
        },
        "copyrights": [
          {
            "id": "string",
            "content": "string",
            "originalContentHash": "string",
            "status": "enabled"
          }
        ],
        "licenseFiles": [
          {
            "id": "string",
            "relPath": "string",
            "content": "string",
            "originalContentHash": "string",
            "status": "enabled"
          }
        ],
        "noticeFiles": [
          {
            "id": "string",
            "relPath": "string",
            "content": "string",
            "originalContentHash": "string",
            "status": "enabled"
          }
        ],
        "obligations": [
          {
            "id": "string",
            "name": "string",
            "status": "OPEN",
            "comment": "string",
            "componentIdentifier": {
              "format": "string",
              "coordinates": {
                "property1": "string",
                "property2": "string"
              }
            },
            "packageUrl": "string",
            "ownerId": "string",
            "lastUpdatedAt": "2019-08-24T14:15:22Z",
            "lastUpdatedByUsername": "string"
          }
        ],
        "attributions": [
          {
            "id": "string",
            "componentIdentifier": {
              "format": "string",
              "coordinates": {
                "property1": "string",
                "property2": "string"
              }
            },
            "packageUrl": "string",
            "ownerId": "string",
            "obligationName": "string",
            "content": "string",
            "lastUpdatedAt": "2019-08-24T14:15:22Z",
            "lastUpdatedByUsername": "string"
          }
        ],
        "sourceLinks": [
          {
            "id": "string",
            "content": "string",
            "originalContent": "string",
            "status": "enabled"
          }
        ],
        "effectiveLicenseStatus": "string",
        "componentCopyrightId": "string",
        "componentCopyrightScopeOwnerId": "string",
        "componentCopyrightLastUpdatedByUsername": "string",
        "componentCopyrightLastUpdatedAt": "2019-08-24T14:15:22Z",
        "componentLicensesId": "string",
        "componentLicensesScopeOwnerId": "string",
        "componentLicensesLastUpdatedByUsername": "string",
        "componentLicensesLastUpdatedAt": "2019-08-24T14:15:22Z",
        "componentNoticesId": "string",
        "componentNoticesScopeOwnerId": "string",
        "componentNoticesLastUpdatedByUsername": "string",
        "componentNoticesLastUpdatedAt": "2019-08-24T14:15:22Z"
      },
      "stageScans": [
        {
          "stageName": "string",
          "scanId": "string",
          "scanDate": "2019-08-24T14:15:22Z"
        }
      ]
    }
  ],
  "licenseLegalMetadata": [
    {
      "licenseId": "string",
      "licenseName": "string",
      "licenseText": "string",
      "obligations": [
        {
          "name": "string",
          "obligationTexts": [
            "string"
          ]
        }
      ],
      "threatGroup": {
        "name": "string",
        "threatLevel": 0
      },
      "isMulti": true,
      "singleLicenseIds": [
        "string"
      ]
    }
  ]
}

Responses

Status Meaning Description Schema
default Default default response ApiLicenseLegalApplicationReportDTO

getLicenseLegalComponentReport

Code samples

URL obj = new URL("/api/v2/licenseLegalMetadata/{ownerType}/{ownerId}/component");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/licenseLegalMetadata/{ownerType}/{ownerId}/component', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/licenseLegalMetadata/{ownerType}/{ownerId}/component',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/licenseLegalMetadata/{ownerType}/{ownerId}/component

Parameters

Name In Type Required Description
ownerType path string true none
ownerId path string true none
componentIdentifier query ComponentIdentifier false none
packageUrl query string false none
hash query string false none
identificationSource query string false none
scanId query string false none

Enumerated Values

Parameter Value
ownerType application
ownerType organization
ownerType repository_container
ownerType repository_manager
ownerType repository
ownerType global

Example responses

default Response

{
  "component": {
    "packageUrl": "string",
    "hash": "string",
    "componentIdentifier": {
      "format": "string",
      "coordinates": {
        "property1": "string",
        "property2": "string"
      }
    },
    "displayName": "string",
    "licenseLegalData": {
      "declaredLicenses": [
        "string"
      ],
      "observedLicenses": [
        "string"
      ],
      "effectiveLicenses": [
        "string"
      ],
      "highestEffectiveLicenseThreatGroup": {
        "licenseThreatGroupName": "string",
        "licenseThreatGroupLevel": 0,
        "licenseThreatGroupCategory": "string"
      },
      "copyrights": [
        {
          "id": "string",
          "content": "string",
          "originalContentHash": "string",
          "status": "enabled"
        }
      ],
      "licenseFiles": [
        {
          "id": "string",
          "relPath": "string",
          "content": "string",
          "originalContentHash": "string",
          "status": "enabled"
        }
      ],
      "noticeFiles": [
        {
          "id": "string",
          "relPath": "string",
          "content": "string",
          "originalContentHash": "string",
          "status": "enabled"
        }
      ],
      "obligations": [
        {
          "id": "string",
          "name": "string",
          "status": "OPEN",
          "comment": "string",
          "componentIdentifier": {
            "format": "string",
            "coordinates": {
              "property1": "string",
              "property2": "string"
            }
          },
          "packageUrl": "string",
          "ownerId": "string",
          "lastUpdatedAt": "2019-08-24T14:15:22Z",
          "lastUpdatedByUsername": "string"
        }
      ],
      "attributions": [
        {
          "id": "string",
          "componentIdentifier": {
            "format": "string",
            "coordinates": {
              "property1": "string",
              "property2": "string"
            }
          },
          "packageUrl": "string",
          "ownerId": "string",
          "obligationName": "string",
          "content": "string",
          "lastUpdatedAt": "2019-08-24T14:15:22Z",
          "lastUpdatedByUsername": "string"
        }
      ],
      "sourceLinks": [
        {
          "id": "string",
          "content": "string",
          "originalContent": "string",
          "status": "enabled"
        }
      ],
      "effectiveLicenseStatus": "string",
      "componentCopyrightId": "string",
      "componentCopyrightScopeOwnerId": "string",
      "componentCopyrightLastUpdatedByUsername": "string",
      "componentCopyrightLastUpdatedAt": "2019-08-24T14:15:22Z",
      "componentLicensesId": "string",
      "componentLicensesScopeOwnerId": "string",
      "componentLicensesLastUpdatedByUsername": "string",
      "componentLicensesLastUpdatedAt": "2019-08-24T14:15:22Z",
      "componentNoticesId": "string",
      "componentNoticesScopeOwnerId": "string",
      "componentNoticesLastUpdatedByUsername": "string",
      "componentNoticesLastUpdatedAt": "2019-08-24T14:15:22Z"
    },
    "stageScans": [
      {
        "stageName": "string",
        "scanId": "string",
        "scanDate": "2019-08-24T14:15:22Z"
      }
    ]
  },
  "licenseLegalMetadata": [
    {
      "licenseId": "string",
      "licenseName": "string",
      "licenseText": "string",
      "obligations": [
        {
          "name": "string",
          "obligationTexts": [
            "string"
          ]
        }
      ],
      "threatGroup": {
        "name": "string",
        "threatLevel": 0
      },
      "isMulti": true,
      "singleLicenseIds": [
        "string"
      ]
    }
  ]
}

Responses

Status Meaning Description Schema
default Default default response ApiLicenseLegalComponentReportDTO

getLicenseLegalCustomApplicationHTMLReport_1

Code samples

URL obj = new URL("/api/v2/licenseLegalMetadata/application/{applicationId}/stage/{stageId}/report/templateId/{templateId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'text/html'
}

r = requests.post('/api/v2/licenseLegalMetadata/application/{applicationId}/stage/{stageId}/report/templateId/{templateId}', headers = headers)

print(r.json())



const headers = {
  'Accept':'text/html'
};

fetch('/api/v2/licenseLegalMetadata/application/{applicationId}/stage/{stageId}/report/templateId/{templateId}',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /api/v2/licenseLegalMetadata/application/{applicationId}/stage/{stageId}/report/templateId/{templateId}

Parameters

Name In Type Required Description
applicationId path string true none
stageId path string true none
templateId path string true none

Example responses

default Response

"string"

Responses

Status Meaning Description Schema
default Default default response string

getLicenseLegalCustomMultiApplicationHTMLReport

Code samples

URL obj = new URL("/api/v2/licenseLegalMetadata/customMultiApplication/report");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Content-Type': 'multipart/form-data',
  'Accept': 'text/html'
}

r = requests.post('/api/v2/licenseLegalMetadata/customMultiApplication/report', headers = headers)

print(r.json())


const inputBody = '{
  "contentDisposition": {
    "type": "string",
    "parameters": {
      "property1": "string",
      "property2": "string"
    },
    "fileName": "string",
    "creationDate": "2019-08-24T14:15:22Z",
    "modificationDate": "2019-08-24T14:15:22Z",
    "readDate": "2019-08-24T14:15:22Z",
    "size": 0
  },
  "entity": {},
  "headers": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  },
  "mediaType": {
    "type": "string",
    "subtype": "string",
    "parameters": {
      "property1": "string",
      "property2": "string"
    },
    "wildcardType": true,
    "wildcardSubtype": true
  },
  "messageBodyWorkers": {},
  "parent": {
    "contentDisposition": {
      "type": "string",
      "parameters": {
        "property1": "string",
        "property2": "string"
      },
      "fileName": "string",
      "creationDate": "2019-08-24T14:15:22Z",
      "modificationDate": "2019-08-24T14:15:22Z",
      "readDate": "2019-08-24T14:15:22Z",
      "size": 0
    },
    "entity": {},
    "headers": {
      "property1": [
        "string"
      ],
      "property2": [
        "string"
      ]
    },
    "mediaType": {
      "type": "string",
      "subtype": "string",
      "parameters": {
        "property1": "string",
        "property2": "string"
      },
      "wildcardType": true,
      "wildcardSubtype": true
    },
    "messageBodyWorkers": {},
    "parent": {},
    "providers": {},
    "bodyParts": [
      {
        "contentDisposition": {
          "type": "string",
          "parameters": {
            "property1": "string",
            "property2": "string"
          },
          "fileName": "string",
          "creationDate": "2019-08-24T14:15:22Z",
          "modificationDate": "2019-08-24T14:15:22Z",
          "readDate": "2019-08-24T14:15:22Z",
          "size": 0
        },
        "entity": {},
        "headers": {
          "property1": [
            "string"
          ],
          "property2": [
            "string"
          ]
        },
        "mediaType": {
          "type": "string",
          "subtype": "string",
          "parameters": {
            "property1": "string",
            "property2": "string"
          },
          "wildcardType": true,
          "wildcardSubtype": true
        },
        "messageBodyWorkers": {},
        "parent": {},
        "providers": {},
        "parameterizedHeaders": {
          "property1": [
            {
              "value": "string",
              "parameters": {
                "property1": "string",
                "property2": "string"
              }
            }
          ],
          "property2": [
            {
              "value": "string",
              "parameters": {
                "property1": "string",
                "property2": "string"
              }
            }
          ]
        }
      }
    ],
    "parameterizedHeaders": {
      "property1": [
        {
          "value": "string",
          "parameters": {
            "property1": "string",
            "property2": "string"
          }
        }
      ],
      "property2": [
        {
          "value": "string",
          "parameters": {
            "property1": "string",
            "property2": "string"
          }
        }
      ]
    }
  },
  "providers": {},
  "bodyParts": [
    {
      "contentDisposition": {
        "type": "string",
        "parameters": {
          "property1": "string",
          "property2": "string"
        },
        "fileName": "string",
        "creationDate": "2019-08-24T14:15:22Z",
        "modificationDate": "2019-08-24T14:15:22Z",
        "readDate": "2019-08-24T14:15:22Z",
        "size": 0
      },
      "entity": {},
      "headers": {
        "property1": [
          "string"
        ],
        "property2": [
          "string"
        ]
      },
      "mediaType": {
        "type": "string",
        "subtype": "string",
        "parameters": {
          "property1": "string",
          "property2": "string"
        },
        "wildcardType": true,
        "wildcardSubtype": true
      },
      "messageBodyWorkers": {},
      "parent": {
        "contentDisposition": {
          "type": "string",
          "parameters": {
            "property1": "string",
            "property2": "string"
          },
          "fileName": "string",
          "creationDate": "2019-08-24T14:15:22Z",
          "modificationDate": "2019-08-24T14:15:22Z",
          "readDate": "2019-08-24T14:15:22Z",
          "size": 0
        },
        "entity": {},
        "headers": {
          "property1": [
            "string"
          ],
          "property2": [
            "string"
          ]
        },
        "mediaType": {
          "type": "string",
          "subtype": "string",
          "parameters": {
            "property1": "string",
            "property2": "string"
          },
          "wildcardType": true,
          "wildcardSubtype": true
        },
        "messageBodyWorkers": {},
        "parent": {},
        "providers": {},
        "bodyParts": [
          {}
        ],
        "parameterizedHeaders": {
          "property1": [
            {
              "value": "string",
              "parameters": {
                "property1": "string",
                "property2": "string"
              }
            }
          ],
          "property2": [
            {
              "value": "string",
              "parameters": {
                "property1": "string",
                "property2": "string"
              }
            }
          ]
        }
      },
      "providers": {},
      "parameterizedHeaders": {
        "property1": [
          {
            "value": "string",
            "parameters": {
              "property1": "string",
              "property2": "string"
            }
          }
        ],
        "property2": [
          {
            "value": "string",
            "parameters": {
              "property1": "string",
              "property2": "string"
            }
          }
        ]
      }
    }
  ],
  "fields": {
    "property1": [
      {
        "contentDisposition": {
          "type": "string",
          "parameters": {
            "property1": "string",
            "property2": "string"
          },
          "fileName": "string",
          "creationDate": "2019-08-24T14:15:22Z",
          "modificationDate": "2019-08-24T14:15:22Z",
          "readDate": "2019-08-24T14:15:22Z",
          "size": 0
        },
        "entity": {},
        "headers": {
          "property1": [
            "string"
          ],
          "property2": [
            "string"
          ]
        },
        "mediaType": {
          "type": "string",
          "subtype": "string",
          "parameters": {
            "property1": "string",
            "property2": "string"
          },
          "wildcardType": true,
          "wildcardSubtype": true
        },
        "messageBodyWorkers": {},
        "parent": {
          "contentDisposition": {
            "type": "string",
            "parameters": {
              "property1": "string",
              "property2": "string"
            },
            "fileName": "string",
            "creationDate": "2019-08-24T14:15:22Z",
            "modificationDate": "2019-08-24T14:15:22Z",
            "readDate": "2019-08-24T14:15:22Z",
            "size": 0
          },
          "entity": {},
          "headers": {
            "property1": [
              "string"
            ],
            "property2": [
              "string"
            ]
          },
          "mediaType": {
            "type": "string",
            "subtype": "string",
            "parameters": {
              "property1": "string",
              "property2": "string"
            },
            "wildcardType": true,
            "wildcardSubtype": true
          },
          "messageBodyWorkers": {},
          "parent": {},
          "providers": {},
          "bodyParts": [
            {
              "contentDisposition": {
                "type": "string",
                "parameters": {
                  "property1": "string",
                  "property2": "string"
                },
                "fileName": "string",
                "creationDate": "2019-08-24T14:15:22Z",
                "modificationDate": "2019-08-24T14:15:22Z",
                "readDate": "2019-08-24T14:15:22Z",
                "size": 0
              },
              "entity": {},
              "headers": {
                "property1": [
                  "string"
                ],
                "property2": [
                  "string"
                ]
              },
              "mediaType": {
                "type": "string",
                "subtype": "string",
                "parameters": {
                  "property1": "string",
                  "property2": "string"
                },
                "wildcardType": true,
                "wildcardSubtype": true
              },
              "messageBodyWorkers": {},
              "parent": {},
              "providers": {},
              "parameterizedHeaders": {
                "property1": [
                  {
                    "value": "string",
                    "parameters": {}
                  }
                ],
                "property2": [
                  {
                    "value": "string",
                    "parameters": {}
                  }
                ]
              }
            }
          ],
          "parameterizedHeaders": {
            "property1": [
              {
                "value": "string",
                "parameters": {
                  "property1": "string",
                  "property2": "string"
                }
              }
            ],
            "property2": [
              {
                "value": "string",
                "parameters": {
                  "property1": "string",
                  "property2": "string"
                }
              }
            ]
          }
        },
        "providers": {},
        "simple": true,
        "name": "string",
        "value": "string",
        "formDataContentDisposition": {
          "type": "string",
          "parameters": {
            "property1": "string",
            "property2": "string"
          },
          "fileName": "string",
          "creationDate": "2019-08-24T14:15:22Z",
          "modificationDate": "2019-08-24T14:15:22Z",
          "readDate": "2019-08-24T14:15:22Z",
          "size": 0,
          "name": "string"
        },
        "parameterizedHeaders": {
          "property1": [
            {
              "value": "string",
              "parameters": {
                "property1": "string",
                "property2": "string"
              }
            }
          ],
          "property2": [
            {
              "value": "string",
              "parameters": {
                "property1": "string",
                "property2": "string"
              }
            }
          ]
        }
      }
    ],
    "property2": [
      {
        "contentDisposition": {
          "type": "string",
          "parameters": {
            "property1": "string",
            "property2": "string"
          },
          "fileName": "string",
          "creationDate": "2019-08-24T14:15:22Z",
          "modificationDate": "2019-08-24T14:15:22Z",
          "readDate": "2019-08-24T14:15:22Z",
          "size": 0
        },
        "entity": {},
        "headers": {
          "property1": [
            "string"
          ],
          "property2": [
            "string"
          ]
        },
        "mediaType": {
          "type": "string",
          "subtype": "string",
          "parameters": {
            "property1": "string",
            "property2": "string"
          },
          "wildcardType": true,
          "wildcardSubtype": true
        },
        "messageBodyWorkers": {},
        "parent": {
          "contentDisposition": {
            "type": "string",
            "parameters": {
              "property1": "string",
              "property2": "string"
            },
            "fileName": "string",
            "creationDate": "2019-08-24T14:15:22Z",
            "modificationDate": "2019-08-24T14:15:22Z",
            "readDate": "2019-08-24T14:15:22Z",
            "size": 0
          },
          "entity": {},
          "headers": {
            "property1": [
              "string"
            ],
            "property2": [
              "string"
            ]
          },
          "mediaType": {
            "type": "string",
            "subtype": "string",
            "parameters": {
              "property1": "string",
              "property2": "string"
            },
            "wildcardType": true,
            "wildcardSubtype": true
          },
          "messageBodyWorkers": {},
          "parent": {},
          "providers": {},
          "bodyParts": [
            {
              "contentDisposition": {
                "type": "string",
                "parameters": {
                  "property1": "string",
                  "property2": "string"
                },
                "fileName": "string",
                "creationDate": "2019-08-24T14:15:22Z",
                "modificationDate": "2019-08-24T14:15:22Z",
                "readDate": "2019-08-24T14:15:22Z",
                "size": 0
              },
              "entity": {},
              "headers": {
                "property1": [
                  "string"
                ],
                "property2": [
                  "string"
                ]
              },
              "mediaType": {
                "type": "string",
                "subtype": "string",
                "parameters": {
                  "property1": "string",
                  "property2": "string"
                },
                "wildcardType": true,
                "wildcardSubtype": true
              },
              "messageBodyWorkers": {},
              "parent": {},
              "providers": {},
              "parameterizedHeaders": {
                "property1": [
                  {
                    "value": "string",
                    "parameters": {}
                  }
                ],
                "property2": [
                  {
                    "value": "string",
                    "parameters": {}
                  }
                ]
              }
            }
          ],
          "parameterizedHeaders": {
            "property1": [
              {
                "value": "string",
                "parameters": {
                  "property1": "string",
                  "property2": "string"
                }
              }
            ],
            "property2": [
              {
                "value": "string",
                "parameters": {
                  "property1": "string",
                  "property2": "string"
                }
              }
            ]
          }
        },
        "providers": {},
        "simple": true,
        "name": "string",
        "value": "string",
        "formDataContentDisposition": {
          "type": "string",
          "parameters": {
            "property1": "string",
            "property2": "string"
          },
          "fileName": "string",
          "creationDate": "2019-08-24T14:15:22Z",
          "modificationDate": "2019-08-24T14:15:22Z",
          "readDate": "2019-08-24T14:15:22Z",
          "size": 0,
          "name": "string"
        },
        "parameterizedHeaders": {
          "property1": [
            {
              "value": "string",
              "parameters": {
                "property1": "string",
                "property2": "string"
              }
            }
          ],
          "property2": [
            {
              "value": "string",
              "parameters": {
                "property1": "string",
                "property2": "string"
              }
            }
          ]
        }
      }
    ]
  },
  "parameterizedHeaders": {
    "property1": [
      {
        "value": "string",
        "parameters": {
          "property1": "string",
          "property2": "string"
        }
      }
    ],
    "property2": [
      {
        "value": "string",
        "parameters": {
          "property1": "string",
          "property2": "string"
        }
      }
    ]
  }
}';
const headers = {
  'Content-Type':'multipart/form-data',
  'Accept':'text/html'
};

fetch('/api/v2/licenseLegalMetadata/customMultiApplication/report',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /api/v2/licenseLegalMetadata/customMultiApplication/report

Body parameter

contentDisposition:
  type: string
  parameters:
    property1: string
    property2: string
  fileName: string
  creationDate: 2019-08-24T14:15:22Z
  modificationDate: 2019-08-24T14:15:22Z
  readDate: 2019-08-24T14:15:22Z
  size: 0
entity: {}
headers:
  property1:
    - string
  property2:
    - string
mediaType:
  type: string
  subtype: string
  parameters:
    property1: string
    property2: string
  wildcardType: true
  wildcardSubtype: true
messageBodyWorkers: {}
parent:
  contentDisposition:
    type: string
    parameters:
      property1: string
      property2: string
    fileName: string
    creationDate: 2019-08-24T14:15:22Z
    modificationDate: 2019-08-24T14:15:22Z
    readDate: 2019-08-24T14:15:22Z
    size: 0
  entity: {}
  headers:
    property1:
      - string
    property2:
      - string
  mediaType:
    type: string
    subtype: string
    parameters:
      property1: string
      property2: string
    wildcardType: true
    wildcardSubtype: true
  messageBodyWorkers: {}
  parent: {}
  providers: {}
  bodyParts:
    - contentDisposition:
        type: string
        parameters:
          property1: string
          property2: string
        fileName: string
        creationDate: 2019-08-24T14:15:22Z
        modificationDate: 2019-08-24T14:15:22Z
        readDate: 2019-08-24T14:15:22Z
        size: 0
      entity: {}
      headers:
        property1:
          - string
        property2:
          - string
      mediaType:
        type: string
        subtype: string
        parameters:
          property1: string
          property2: string
        wildcardType: true
        wildcardSubtype: true
      messageBodyWorkers: {}
      parent: {}
      providers: {}
      parameterizedHeaders:
        property1:
          - value: string
            parameters:
              property1: string
              property2: string
        property2:
          - value: string
            parameters:
              property1: string
              property2: string
  parameterizedHeaders:
    property1:
      - value: string
        parameters:
          property1: string
          property2: string
    property2:
      - value: string
        parameters:
          property1: string
          property2: string
providers: {}
bodyParts:
  - contentDisposition:
      type: string
      parameters:
        property1: string
        property2: string
      fileName: string
      creationDate: 2019-08-24T14:15:22Z
      modificationDate: 2019-08-24T14:15:22Z
      readDate: 2019-08-24T14:15:22Z
      size: 0
    entity: {}
    headers:
      property1:
        - string
      property2:
        - string
    mediaType:
      type: string
      subtype: string
      parameters:
        property1: string
        property2: string
      wildcardType: true
      wildcardSubtype: true
    messageBodyWorkers: {}
    parent:
      contentDisposition:
        type: string
        parameters:
          property1: string
          property2: string
        fileName: string
        creationDate: 2019-08-24T14:15:22Z
        modificationDate: 2019-08-24T14:15:22Z
        readDate: 2019-08-24T14:15:22Z
        size: 0
      entity: {}
      headers:
        property1:
          - string
        property2:
          - string
      mediaType:
        type: string
        subtype: string
        parameters:
          property1: string
          property2: string
        wildcardType: true
        wildcardSubtype: true
      messageBodyWorkers: {}
      parent: {}
      providers: {}
      bodyParts:
        - {}
      parameterizedHeaders:
        property1:
          - value: string
            parameters:
              property1: string
              property2: string
        property2:
          - value: string
            parameters:
              property1: string
              property2: string
    providers: {}
    parameterizedHeaders:
      property1:
        - value: string
          parameters:
            property1: string
            property2: string
      property2:
        - value: string
          parameters:
            property1: string
            property2: string
fields:
  property1:
    - contentDisposition:
        type: string
        parameters:
          property1: string
          property2: string
        fileName: string
        creationDate: 2019-08-24T14:15:22Z
        modificationDate: 2019-08-24T14:15:22Z
        readDate: 2019-08-24T14:15:22Z
        size: 0
      entity: {}
      headers:
        property1:
          - string
        property2:
          - string
      mediaType:
        type: string
        subtype: string
        parameters:
          property1: string
          property2: string
        wildcardType: true
        wildcardSubtype: true
      messageBodyWorkers: {}
      parent:
        contentDisposition:
          type: string
          parameters:
            property1: string
            property2: string
          fileName: string
          creationDate: 2019-08-24T14:15:22Z
          modificationDate: 2019-08-24T14:15:22Z
          readDate: 2019-08-24T14:15:22Z
          size: 0
        entity: {}
        headers:
          property1:
            - string
          property2:
            - string
        mediaType:
          type: string
          subtype: string
          parameters:
            property1: string
            property2: string
          wildcardType: true
          wildcardSubtype: true
        messageBodyWorkers: {}
        parent: {}
        providers: {}
        bodyParts:
          - contentDisposition:
              type: string
              parameters:
                property1: string
                property2: string
              fileName: string
              creationDate: 2019-08-24T14:15:22Z
              modificationDate: 2019-08-24T14:15:22Z
              readDate: 2019-08-24T14:15:22Z
              size: 0
            entity: {}
            headers:
              property1:
                - string
              property2:
                - string
            mediaType:
              type: string
              subtype: string
              parameters:
                property1: string
                property2: string
              wildcardType: true
              wildcardSubtype: true
            messageBodyWorkers: {}
            parent: {}
            providers: {}
            parameterizedHeaders:
              property1:
                - value: string
                  parameters: {}
              property2:
                - value: string
                  parameters: {}
        parameterizedHeaders:
          property1:
            - value: string
              parameters:
                property1: string
                property2: string
          property2:
            - value: string
              parameters:
                property1: string
                property2: string
      providers: {}
      simple: true
      name: string
      value: string
      formDataContentDisposition:
        type: string
        parameters:
          property1: string
          property2: string
        fileName: string
        creationDate: 2019-08-24T14:15:22Z
        modificationDate: 2019-08-24T14:15:22Z
        readDate: 2019-08-24T14:15:22Z
        size: 0
        name: string
      parameterizedHeaders:
        property1:
          - value: string
            parameters:
              property1: string
              property2: string
        property2:
          - value: string
            parameters:
              property1: string
              property2: string
  property2:
    - contentDisposition:
        type: string
        parameters:
          property1: string
          property2: string
        fileName: string
        creationDate: 2019-08-24T14:15:22Z
        modificationDate: 2019-08-24T14:15:22Z
        readDate: 2019-08-24T14:15:22Z
        size: 0
      entity: {}
      headers:
        property1:
          - string
        property2:
          - string
      mediaType:
        type: string
        subtype: string
        parameters:
          property1: string
          property2: string
        wildcardType: true
        wildcardSubtype: true
      messageBodyWorkers: {}
      parent:
        contentDisposition:
          type: string
          parameters:
            property1: string
            property2: string
          fileName: string
          creationDate: 2019-08-24T14:15:22Z
          modificationDate: 2019-08-24T14:15:22Z
          readDate: 2019-08-24T14:15:22Z
          size: 0
        entity: {}
        headers:
          property1:
            - string
          property2:
            - string
        mediaType:
          type: string
          subtype: string
          parameters:
            property1: string
            property2: string
          wildcardType: true
          wildcardSubtype: true
        messageBodyWorkers: {}
        parent: {}
        providers: {}
        bodyParts:
          - contentDisposition:
              type: string
              parameters:
                property1: string
                property2: string
              fileName: string
              creationDate: 2019-08-24T14:15:22Z
              modificationDate: 2019-08-24T14:15:22Z
              readDate: 2019-08-24T14:15:22Z
              size: 0
            entity: {}
            headers:
              property1:
                - string
              property2:
                - string
            mediaType:
              type: string
              subtype: string
              parameters:
                property1: string
                property2: string
              wildcardType: true
              wildcardSubtype: true
            messageBodyWorkers: {}
            parent: {}
            providers: {}
            parameterizedHeaders:
              property1:
                - value: string
                  parameters: {}
              property2:
                - value: string
                  parameters: {}
        parameterizedHeaders:
          property1:
            - value: string
              parameters:
                property1: string
                property2: string
          property2:
            - value: string
              parameters:
                property1: string
                property2: string
      providers: {}
      simple: true
      name: string
      value: string
      formDataContentDisposition:
        type: string
        parameters:
          property1: string
          property2: string
        fileName: string
        creationDate: 2019-08-24T14:15:22Z
        modificationDate: 2019-08-24T14:15:22Z
        readDate: 2019-08-24T14:15:22Z
        size: 0
        name: string
      parameterizedHeaders:
        property1:
          - value: string
            parameters:
              property1: string
              property2: string
        property2:
          - value: string
            parameters:
              property1: string
              property2: string
parameterizedHeaders:
  property1:
    - value: string
      parameters:
        property1: string
        property2: string
  property2:
    - value: string
      parameters:
        property1: string
        property2: string

Parameters

Name In Type Required Description
body body FormDataMultiPart false none

Example responses

default Response

"string"

Responses

Status Meaning Description Schema
default Default default response string

getLicenseLegalCustomMultiApplicationHTMLReport_1

Code samples

URL obj = new URL("/api/v2/licenseLegalMetadata/multiApplication/report/templateId/{templateId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'text/html'
}

r = requests.post('/api/v2/licenseLegalMetadata/multiApplication/report/templateId/{templateId}', headers = headers)

print(r.json())



const headers = {
  'Accept':'text/html'
};

fetch('/api/v2/licenseLegalMetadata/multiApplication/report/templateId/{templateId}',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /api/v2/licenseLegalMetadata/multiApplication/report/templateId/{templateId}

Parameters

Name In Type Required Description
templateId path string true none

Example responses

default Response

"string"

Responses

Status Meaning Description Schema
default Default default response string

getLicenseLegalMultiApplicationHTMLReport

Code samples

URL obj = new URL("/api/v2/licenseLegalMetadata/multiApplication/report");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'text/html'
}

r = requests.post('/api/v2/licenseLegalMetadata/multiApplication/report', headers = headers)

print(r.json())



const headers = {
  'Accept':'text/html'
};

fetch('/api/v2/licenseLegalMetadata/multiApplication/report',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /api/v2/licenseLegalMetadata/multiApplication/report

Example responses

default Response

"string"

Responses

Status Meaning Description Schema
default Default default response string

getLicenseLegalMultiApplicationReportFromActiveUserFilter

Code samples

URL obj = new URL("/api/v2/licenseLegalMetadata/multiApplication/activeUserFilter/report/templateId/{templateId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'text/html'
}

r = requests.post('/api/v2/licenseLegalMetadata/multiApplication/activeUserFilter/report/templateId/{templateId}', headers = headers)

print(r.json())



const headers = {
  'Accept':'text/html'
};

fetch('/api/v2/licenseLegalMetadata/multiApplication/activeUserFilter/report/templateId/{templateId}',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /api/v2/licenseLegalMetadata/multiApplication/activeUserFilter/report/templateId/{templateId}

Parameters

Name In Type Required Description
templateId path string true none

Example responses

default Response

"string"

Responses

Status Meaning Description Schema
default Default default response string

Organizations

getOrganizations

Code samples

URL obj = new URL("/api/v2/organizations");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/organizations', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/organizations',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/organizations

Parameters

Name In Type Required Description
organizationName query array[string] false none

Example responses

default Response

{
  "organizations": [
    {
      "id": "string",
      "name": "string",
      "parentOrganizationId": "string",
      "tags": [
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "color": "white"
        }
      ]
    }
  ]
}

Responses

Status Meaning Description Schema
default Default default response ApiOrganizationListDTO

addOrganization

Code samples

URL obj = new URL("/api/v2/organizations");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('/api/v2/organizations', headers = headers)

print(r.json())


const inputBody = '{
  "id": "string",
  "name": "string",
  "parentOrganizationId": "string",
  "tags": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "color": "white"
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/api/v2/organizations',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /api/v2/organizations

Body parameter

{
  "id": "string",
  "name": "string",
  "parentOrganizationId": "string",
  "tags": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "color": "white"
    }
  ]
}

Parameters

Name In Type Required Description
body body ApiOrganizationDTO false none

Example responses

default Response

{
  "id": "string",
  "name": "string",
  "parentOrganizationId": "string",
  "tags": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "color": "white"
    }
  ]
}

Responses

Status Meaning Description Schema
default Default default response ApiOrganizationDTO

getOrganization

Code samples

URL obj = new URL("/api/v2/organizations/{organizationId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/organizations/{organizationId}', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/organizations/{organizationId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/organizations/{organizationId}

Parameters

Name In Type Required Description
organizationId path string true none

Example responses

default Response

{
  "id": "string",
  "name": "string",
  "parentOrganizationId": "string",
  "tags": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "color": "white"
    }
  ]
}

Responses

Status Meaning Description Schema
default Default default response ApiOrganizationDTO

deleteOrganization

Code samples

URL obj = new URL("/api/v2/organizations/{organizationId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': '*/*'
}

r = requests.delete('/api/v2/organizations/{organizationId}', headers = headers)

print(r.json())



const headers = {
  'Accept':'*/*'
};

fetch('/api/v2/organizations/{organizationId}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /api/v2/organizations/{organizationId}

Parameters

Name In Type Required Description
organizationId path string true none

Example responses

Responses

Status Meaning Description Schema
default Default default response None

Response Schema

moveOrganization

Code samples

URL obj = new URL("/api/v2/organizations/{organizationId}/move/destination/{destinationId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.put('/api/v2/organizations/{organizationId}/move/destination/{destinationId}', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/organizations/{organizationId}/move/destination/{destinationId}',
{
  method: 'PUT',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /api/v2/organizations/{organizationId}/move/destination/{destinationId}

Parameters

Name In Type Required Description
organizationId path string true none
destinationId path string true none
failEarlyOnError query boolean false none

Example responses

Responses

Status Meaning Description Schema
default Default default response None

Response Schema

Policies

getPolicies

Code samples

URL obj = new URL("/api/v2/policies");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/policies', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/policies',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/policies

Example responses

default Response

{
  "policies": [
    {
      "id": "string",
      "name": "string",
      "ownerId": "string",
      "ownerType": "APPLICATION",
      "threatLevel": 0,
      "policyType": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
default Default default response ApiPolicyListDTO

Policy Violations

getApplicableWaivers

Code samples

URL obj = new URL("/api/v2/policyViolations/{violationId}/applicableWaivers");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/policyViolations/{violationId}/applicableWaivers', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/policyViolations/{violationId}/applicableWaivers',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/policyViolations/{violationId}/applicableWaivers

Parameters

Name In Type Required Description
violationId path string true none

Example responses

default Response

{
  "activeWaivers": [
    {
      "policyWaiverId": "string",
      "policyViolationId": "string",
      "comment": "string",
      "createTime": "2019-08-24T14:15:22Z",
      "expiryTime": "2019-08-24T14:15:22Z",
      "isObsolete": true,
      "scopeOwnerType": "string",
      "scopeOwnerId": "string",
      "scopeOwnerName": "string",
      "hash": "string",
      "policyId": "string",
      "vulnerabilityId": "string",
      "policyName": "string",
      "constraintFacts": [
        {
          "constraintId": "string",
          "constraintName": "string",
          "operatorName": "string",
          "conditionFacts": [
            {
              "conditionTypeId": "string",
              "conditionIndex": 0,
              "summary": "string",
              "reason": "string",
              "reference": {
                "value": "string",
                "type": "SECURITY_VULNERABILITY_REFID"
              },
              "triggerJson": "string"
            }
          ]
        }
      ],
      "constraintFactsJson": "string",
      "componentName": "string",
      "creatorId": "string",
      "creatorName": "string",
      "matcherStrategy": "DEFAULT",
      "associatedPackageUrl": "string",
      "componentIdentifier": {
        "format": "string",
        "coordinates": {
          "property1": "string",
          "property2": "string"
        }
      },
      "threatLevel": 0,
      "componentUpgradeAvailable": true,
      "displayName": {
        "parts": [
          {
            "field": "string",
            "value": "string"
          }
        ],
        "name": "string"
      }
    }
  ],
  "expiredWaivers": [
    {
      "policyWaiverId": "string",
      "policyViolationId": "string",
      "comment": "string",
      "createTime": "2019-08-24T14:15:22Z",
      "expiryTime": "2019-08-24T14:15:22Z",
      "isObsolete": true,
      "scopeOwnerType": "string",
      "scopeOwnerId": "string",
      "scopeOwnerName": "string",
      "hash": "string",
      "policyId": "string",
      "vulnerabilityId": "string",
      "policyName": "string",
      "constraintFacts": [
        {
          "constraintId": "string",
          "constraintName": "string",
          "operatorName": "string",
          "conditionFacts": [
            {
              "conditionTypeId": "string",
              "conditionIndex": 0,
              "summary": "string",
              "reason": "string",
              "reference": {
                "value": "string",
                "type": "SECURITY_VULNERABILITY_REFID"
              },
              "triggerJson": "string"
            }
          ]
        }
      ],
      "constraintFactsJson": "string",
      "componentName": "string",
      "creatorId": "string",
      "creatorName": "string",
      "matcherStrategy": "DEFAULT",
      "associatedPackageUrl": "string",
      "componentIdentifier": {
        "format": "string",
        "coordinates": {
          "property1": "string",
          "property2": "string"
        }
      },
      "threatLevel": 0,
      "componentUpgradeAvailable": true,
      "displayName": {
        "parts": [
          {
            "field": "string",
            "value": "string"
          }
        ],
        "name": "string"
      }
    }
  ]
}

Responses

Status Meaning Description Schema
default Default default response ApiPolicyWaiversApplicableToViolationDTO

getCrossStagePolicyViolationByConstituentId

Code samples

URL obj = new URL("/api/v2/policyViolations/crossStage");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/policyViolations/crossStage', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/policyViolations/crossStage',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/policyViolations/crossStage

Parameters

Name In Type Required Description
constituentId query string false none

Example responses

default Response

{
  "policyId": "string",
  "policyName": "string",
  "policyViolationId": "string",
  "threatLevel": 0,
  "constraintViolations": [
    {
      "constraintId": "string",
      "constraintName": "string",
      "reasons": [
        {
          "reason": "string",
          "reference": {
            "value": "string",
            "type": "SECURITY_VULNERABILITY_REFID"
          }
        }
      ]
    }
  ],
  "applicationPublicId": "string",
  "applicationName": "string",
  "organizationName": "string",
  "openTime": "2019-08-24T14:15:22Z",
  "fixTime": "2019-08-24T14:15:22Z",
  "hash": "string",
  "policyThreatCategory": "string",
  "displayName": {
    "parts": [
      {
        "field": "string",
        "value": "string"
      }
    ],
    "name": "string"
  },
  "componentIdentifier": {
    "format": "string",
    "coordinates": {
      "property1": "string",
      "property2": "string"
    }
  },
  "filename": "string",
  "stageData": {
    "property1": {
      "mostRecentEvaluationTime": "2019-08-24T14:15:22Z",
      "mostRecentScanId": "string",
      "actionTypeId": "string"
    },
    "property2": {
      "mostRecentEvaluationTime": "2019-08-24T14:15:22Z",
      "mostRecentScanId": "string",
      "actionTypeId": "string"
    }
  },
  "policyOwner": {
    "ownerPublicId": "string",
    "ownerId": "string",
    "ownerName": "string",
    "ownerType": "string"
  }
}

Responses

Status Meaning Description Schema
default Default default response ApiCrossStageViolationDTOV2

getCrossStagePolicyViolationById

Code samples

URL obj = new URL("/api/v2/policyViolations/crossStage/{violationId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/policyViolations/crossStage/{violationId}', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/policyViolations/crossStage/{violationId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/policyViolations/crossStage/{violationId}

Parameters

Name In Type Required Description
violationId path string true none

Example responses

default Response

{
  "policyId": "string",
  "policyName": "string",
  "policyViolationId": "string",
  "threatLevel": 0,
  "constraintViolations": [
    {
      "constraintId": "string",
      "constraintName": "string",
      "reasons": [
        {
          "reason": "string",
          "reference": {
            "value": "string",
            "type": "SECURITY_VULNERABILITY_REFID"
          }
        }
      ]
    }
  ],
  "applicationPublicId": "string",
  "applicationName": "string",
  "organizationName": "string",
  "openTime": "2019-08-24T14:15:22Z",
  "fixTime": "2019-08-24T14:15:22Z",
  "hash": "string",
  "policyThreatCategory": "string",
  "displayName": {
    "parts": [
      {
        "field": "string",
        "value": "string"
      }
    ],
    "name": "string"
  },
  "componentIdentifier": {
    "format": "string",
    "coordinates": {
      "property1": "string",
      "property2": "string"
    }
  },
  "filename": "string",
  "stageData": {
    "property1": {
      "mostRecentEvaluationTime": "2019-08-24T14:15:22Z",
      "mostRecentScanId": "string",
      "actionTypeId": "string"
    },
    "property2": {
      "mostRecentEvaluationTime": "2019-08-24T14:15:22Z",
      "mostRecentScanId": "string",
      "actionTypeId": "string"
    }
  },
  "policyOwner": {
    "ownerPublicId": "string",
    "ownerId": "string",
    "ownerName": "string",
    "ownerType": "string"
  }
}

Responses

Status Meaning Description Schema
default Default default response ApiCrossStageViolationDTOV2

getPolicyViolations

Code samples

URL obj = new URL("/api/v2/policyViolations");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/policyViolations', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/policyViolations',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/policyViolations

Parameters

Name In Type Required Description
p query array[string] false none
openTimeAfter query string false none
openTimeBefore query string false none

Example responses

default Response

{
  "applicationViolations": [
    {
      "application": {
        "id": "string",
        "publicId": "string",
        "name": "string",
        "organizationId": "string",
        "contactUserName": "string"
      },
      "policyViolations": [
        {
          "policyId": "string",
          "policyName": "string",
          "policyViolationId": "string",
          "threatLevel": 0,
          "constraintViolations": [
            {
              "constraintId": "string",
              "constraintName": "string",
              "reasons": [
                {
                  "reason": "string",
                  "reference": {
                    "value": "string",
                    "type": "SECURITY_VULNERABILITY_REFID"
                  }
                }
              ]
            }
          ],
          "stageId": "string",
          "reportId": "string",
          "reportUrl": "string",
          "openTime": "2019-08-24T14:15:22Z",
          "component": {
            "packageUrl": "string",
            "hash": "string",
            "sha256": "string",
            "componentIdentifier": {
              "format": "string",
              "coordinates": {
                "property1": "string",
                "property2": "string"
              }
            },
            "displayName": "string",
            "proprietary": true,
            "thirdParty": true
          }
        }
      ]
    }
  ]
}

Responses

Status Meaning Description Schema
default Default default response ApiApplicationViolationListDTOV2

getTransitivePolicyViolationsByAppScanComponent

Code samples

URL obj = new URL("/api/v2/policyViolations/transitive/{ownerType}/{ownerId}/{scanId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/policyViolations/transitive/{ownerType}/{ownerId}/{scanId}', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/policyViolations/transitive/{ownerType}/{ownerId}/{scanId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/policyViolations/transitive/{ownerType}/{ownerId}/{scanId}

Parameters

Name In Type Required Description
ownerType path string true none
ownerId path string true none
scanId path string true none
componentIdentifier query ComponentIdentifier false none
packageUrl query string false none
hash query string false none

Enumerated Values

Parameter Value
ownerType application
ownerType organization
ownerType repository_container
ownerType repository_manager
ownerType repository
ownerType global

Example responses

default Response

{
  "componentIdentifier": {
    "format": "string",
    "coordinates": {
      "property1": "string",
      "property2": "string"
    }
  },
  "packageUrl": "string",
  "hash": "string",
  "displayName": "string",
  "isInnerSource": true,
  "transitivePolicyViolations": [
    {
      "policyId": "string",
      "policyName": "string",
      "threatLevel": 0,
      "threatCategory": "string",
      "policyViolationId": "string",
      "action": "string",
      "componentIdentifier": {
        "format": "string",
        "coordinates": {
          "property1": "string",
          "property2": "string"
        }
      },
      "packageUrl": "string",
      "hash": "string",
      "displayName": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
default Default default response ApiComponentTransitivePolicyViolationsDTO

getTransitivePolicyViolationsByOwnerStageComponent

Code samples

URL obj = new URL("/api/v2/policyViolations/transitive/{ownerType}/{ownerId}/stages/{stageId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/policyViolations/transitive/{ownerType}/{ownerId}/stages/{stageId}', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/policyViolations/transitive/{ownerType}/{ownerId}/stages/{stageId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/policyViolations/transitive/{ownerType}/{ownerId}/stages/{stageId}

Parameters

Name In Type Required Description
ownerType path string true none
ownerId path string true none
stageId path string true none
componentIdentifier query ComponentIdentifier false none
packageUrl query string false none
hash query string false none

Enumerated Values

Parameter Value
ownerType application
ownerType organization
ownerType repository_container
ownerType repository_manager
ownerType repository
ownerType global

Example responses

default Response

{
  "componentIdentifier": {
    "format": "string",
    "coordinates": {
      "property1": "string",
      "property2": "string"
    }
  },
  "packageUrl": "string",
  "hash": "string",
  "displayName": "string",
  "isInnerSource": true,
  "transitivePolicyViolations": [
    {
      "policyId": "string",
      "policyName": "string",
      "threatLevel": 0,
      "threatCategory": "string",
      "policyViolationId": "string",
      "action": "string",
      "componentIdentifier": {
        "format": "string",
        "coordinates": {
          "property1": "string",
          "property2": "string"
        }
      },
      "packageUrl": "string",
      "hash": "string",
      "displayName": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
default Default default response ApiComponentTransitivePolicyViolationsDTO

Policy Waiver

addPolicyWaiver

Code samples

URL obj = new URL("/api/v2/policyWaiver/{policyViolationId}/{ownerType}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Content-Type': 'text/plain',
  'Accept': '*/*'
}

r = requests.post('/api/v2/policyWaiver/{policyViolationId}/{ownerType}', headers = headers)

print(r.json())


const inputBody = 'string';
const headers = {
  'Content-Type':'text/plain',
  'Accept':'*/*'
};

fetch('/api/v2/policyWaiver/{policyViolationId}/{ownerType}',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /api/v2/policyWaiver/{policyViolationId}/{ownerType}

Body parameter

string

Parameters

Name In Type Required Description
policyViolationId path string true none
ownerType path string true none
body body string false none

Enumerated Values

Parameter Value
ownerType application
ownerType organization
ownerType repository_container
ownerType repository_manager
ownerType repository
ownerType global

Example responses

Responses

Status Meaning Description Schema
default Default default response None

Response Schema

Policy Waivers

addPolicyWaiverByPolicyViolationId

Code samples

URL obj = new URL("/api/v2/policyWaivers/{ownerType}/{ownerId}/{policyViolationId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*'
}

r = requests.post('/api/v2/policyWaivers/{ownerType}/{ownerId}/{policyViolationId}', headers = headers)

print(r.json())


const inputBody = '{
  "comment": "string",
  "applyToAllComponents": true,
  "matcherStrategy": "DEFAULT",
  "expiryTime": "2019-08-24T14:15:22Z"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*'
};

fetch('/api/v2/policyWaivers/{ownerType}/{ownerId}/{policyViolationId}',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /api/v2/policyWaivers/{ownerType}/{ownerId}/{policyViolationId}

Body parameter

{
  "comment": "string",
  "applyToAllComponents": true,
  "matcherStrategy": "DEFAULT",
  "expiryTime": "2019-08-24T14:15:22Z"
}

Parameters

Name In Type Required Description
ownerType path string true none
ownerId path string true none
policyViolationId path string true none
body body ApiWaiverOptionsDTO false none

Enumerated Values

Parameter Value
ownerType application
ownerType organization
ownerType repository_container
ownerType repository_manager
ownerType repository
ownerType global

Example responses

Responses

Status Meaning Description Schema
default Default default response None

Response Schema

getTransitivePolicyWaiversByAppScanComponent

Code samples

URL obj = new URL("/api/v2/policyWaivers/transitive/{ownerType}/{ownerId}/{scanId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/policyWaivers/transitive/{ownerType}/{ownerId}/{scanId}', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/policyWaivers/transitive/{ownerType}/{ownerId}/{scanId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/policyWaivers/transitive/{ownerType}/{ownerId}/{scanId}

Parameters

Name In Type Required Description
ownerType path string true none
ownerId path string true none
scanId path string true none
componentIdentifier query ComponentIdentifier false none
packageUrl query string false none
hash query string false none

Enumerated Values

Parameter Value
ownerType application
ownerType organization
ownerType repository_container
ownerType repository_manager
ownerType repository
ownerType global

Example responses

default Response

{
  "componentPolicyWaivers": [
    {
      "policyWaiverId": "string",
      "policyViolationId": "string",
      "comment": "string",
      "createTime": "2019-08-24T14:15:22Z",
      "expiryTime": "2019-08-24T14:15:22Z",
      "isObsolete": true,
      "scopeOwnerType": "string",
      "scopeOwnerId": "string",
      "scopeOwnerName": "string",
      "hash": "string",
      "policyId": "string",
      "vulnerabilityId": "string",
      "policyName": "string",
      "constraintFacts": [
        {
          "constraintId": "string",
          "constraintName": "string",
          "operatorName": "string",
          "conditionFacts": [
            {
              "conditionTypeId": "string",
              "conditionIndex": 0,
              "summary": "string",
              "reason": "string",
              "reference": {
                "value": "string",
                "type": "SECURITY_VULNERABILITY_REFID"
              },
              "triggerJson": "string"
            }
          ]
        }
      ],
      "constraintFactsJson": "string",
      "componentName": "string",
      "creatorId": "string",
      "creatorName": "string",
      "matcherStrategy": "DEFAULT",
      "associatedPackageUrl": "string",
      "componentIdentifier": {
        "format": "string",
        "coordinates": {
          "property1": "string",
          "property2": "string"
        }
      },
      "threatLevel": 0,
      "componentUpgradeAvailable": true,
      "displayName": {
        "parts": [
          {
            "field": "string",
            "value": "string"
          }
        ],
        "name": "string"
      }
    }
  ]
}

Responses

Status Meaning Description Schema
default Default default response ApiComponentPolicyWaiversDTO

addWaiverToTransitivePolicyViolationsByAppScanComponent

Code samples

URL obj = new URL("/api/v2/policyWaivers/transitive/{ownerType}/{ownerId}/{scanId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*'
}

r = requests.post('/api/v2/policyWaivers/transitive/{ownerType}/{ownerId}/{scanId}', headers = headers)

print(r.json())


const inputBody = '{
  "comment": "string",
  "applyToAllComponents": true,
  "matcherStrategy": "DEFAULT",
  "expiryTime": "2019-08-24T14:15:22Z"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*'
};

fetch('/api/v2/policyWaivers/transitive/{ownerType}/{ownerId}/{scanId}',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /api/v2/policyWaivers/transitive/{ownerType}/{ownerId}/{scanId}

Body parameter

{
  "comment": "string",
  "applyToAllComponents": true,
  "matcherStrategy": "DEFAULT",
  "expiryTime": "2019-08-24T14:15:22Z"
}

Parameters

Name In Type Required Description
ownerType path string true none
ownerId path string true none
scanId path string true none
componentIdentifier query ComponentIdentifier false none
packageUrl query string false none
hash query string false none
body body ApiWaiverOptionsDTO false none

Enumerated Values

Parameter Value
ownerType application
ownerType organization
ownerType repository_container
ownerType repository_manager
ownerType repository
ownerType global

Example responses

Responses

Status Meaning Description Schema
default Default default response None

Response Schema

addWaiverToTransitivePolicyViolationsByOwnerStageComponent

Code samples

URL obj = new URL("/api/v2/policyWaivers/transitive/{ownerType}/{ownerId}/stages/{stageId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*'
}

r = requests.post('/api/v2/policyWaivers/transitive/{ownerType}/{ownerId}/stages/{stageId}', headers = headers)

print(r.json())


const inputBody = '{
  "comment": "string",
  "applyToAllComponents": true,
  "matcherStrategy": "DEFAULT",
  "expiryTime": "2019-08-24T14:15:22Z"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*'
};

fetch('/api/v2/policyWaivers/transitive/{ownerType}/{ownerId}/stages/{stageId}',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /api/v2/policyWaivers/transitive/{ownerType}/{ownerId}/stages/{stageId}

Body parameter

{
  "comment": "string",
  "applyToAllComponents": true,
  "matcherStrategy": "DEFAULT",
  "expiryTime": "2019-08-24T14:15:22Z"
}

Parameters

Name In Type Required Description
ownerType path string true none
ownerId path string true none
stageId path string true none
componentIdentifier query ComponentIdentifier false none
packageUrl query string false none
hash query string false none
body body ApiWaiverOptionsDTO false none

Enumerated Values

Parameter Value
ownerType application
ownerType organization
ownerType repository_container
ownerType repository_manager
ownerType repository
ownerType global

Example responses

Responses

Status Meaning Description Schema
default Default default response None

Response Schema

getPolicyWaiver

Code samples

URL obj = new URL("/api/v2/policyWaivers/{ownerType}/{ownerId}/{policyWaiverId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/policyWaivers/{ownerType}/{ownerId}/{policyWaiverId}', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/policyWaivers/{ownerType}/{ownerId}/{policyWaiverId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/policyWaivers/{ownerType}/{ownerId}/{policyWaiverId}

Parameters

Name In Type Required Description
ownerType path string true none
ownerId path string true none
policyWaiverId path string true none

Enumerated Values

Parameter Value
ownerType application
ownerType organization
ownerType repository_container
ownerType repository_manager
ownerType repository
ownerType global

Example responses

default Response

{
  "policyWaiverId": "string",
  "policyViolationId": "string",
  "comment": "string",
  "createTime": "2019-08-24T14:15:22Z",
  "expiryTime": "2019-08-24T14:15:22Z",
  "isObsolete": true,
  "scopeOwnerType": "string",
  "scopeOwnerId": "string",
  "scopeOwnerName": "string",
  "hash": "string",
  "policyId": "string",
  "vulnerabilityId": "string",
  "policyName": "string",
  "constraintFacts": [
    {
      "constraintId": "string",
      "constraintName": "string",
      "operatorName": "string",
      "conditionFacts": [
        {
          "conditionTypeId": "string",
          "conditionIndex": 0,
          "summary": "string",
          "reason": "string",
          "reference": {
            "value": "string",
            "type": "SECURITY_VULNERABILITY_REFID"
          },
          "triggerJson": "string"
        }
      ]
    }
  ],
  "constraintFactsJson": "string",
  "componentName": "string",
  "creatorId": "string",
  "creatorName": "string",
  "matcherStrategy": "DEFAULT",
  "associatedPackageUrl": "string",
  "componentIdentifier": {
    "format": "string",
    "coordinates": {
      "property1": "string",
      "property2": "string"
    }
  },
  "threatLevel": 0,
  "componentUpgradeAvailable": true,
  "displayName": {
    "parts": [
      {
        "field": "string",
        "value": "string"
      }
    ],
    "name": "string"
  }
}

Responses

Status Meaning Description Schema
default Default default response ApiPolicyWaiverDTO

deletePolicyWaiver

Code samples

URL obj = new URL("/api/v2/policyWaivers/{ownerType}/{ownerId}/{policyWaiverId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': '*/*'
}

r = requests.delete('/api/v2/policyWaivers/{ownerType}/{ownerId}/{policyWaiverId}', headers = headers)

print(r.json())



const headers = {
  'Accept':'*/*'
};

fetch('/api/v2/policyWaivers/{ownerType}/{ownerId}/{policyWaiverId}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /api/v2/policyWaivers/{ownerType}/{ownerId}/{policyWaiverId}

Parameters

Name In Type Required Description
ownerType path string true none
ownerId path string true none
policyWaiverId path string true none

Enumerated Values

Parameter Value
ownerType application
ownerType organization
ownerType repository_container
ownerType repository_manager
ownerType repository
ownerType global

Example responses

Responses

Status Meaning Description Schema
default Default default response None

Response Schema

getPolicyWaivers

Code samples

URL obj = new URL("/api/v2/policyWaivers/{ownerType}/{ownerId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/policyWaivers/{ownerType}/{ownerId}', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/policyWaivers/{ownerType}/{ownerId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/policyWaivers/{ownerType}/{ownerId}

Parameters

Name In Type Required Description
ownerType path string true none
ownerId path string true none

Enumerated Values

Parameter Value
ownerType application
ownerType organization
ownerType repository_container
ownerType repository_manager
ownerType repository
ownerType global

Example responses

default Response

[
  {
    "policyWaiverId": "string",
    "policyViolationId": "string",
    "comment": "string",
    "createTime": "2019-08-24T14:15:22Z",
    "expiryTime": "2019-08-24T14:15:22Z",
    "isObsolete": true,
    "scopeOwnerType": "string",
    "scopeOwnerId": "string",
    "scopeOwnerName": "string",
    "hash": "string",
    "policyId": "string",
    "vulnerabilityId": "string",
    "policyName": "string",
    "constraintFacts": [
      {
        "constraintId": "string",
        "constraintName": "string",
        "operatorName": "string",
        "conditionFacts": [
          {
            "conditionTypeId": "string",
            "conditionIndex": 0,
            "summary": "string",
            "reason": "string",
            "reference": {
              "value": "string",
              "type": "SECURITY_VULNERABILITY_REFID"
            },
            "triggerJson": "string"
          }
        ]
      }
    ],
    "constraintFactsJson": "string",
    "componentName": "string",
    "creatorId": "string",
    "creatorName": "string",
    "matcherStrategy": "DEFAULT",
    "associatedPackageUrl": "string",
    "componentIdentifier": {
      "format": "string",
      "coordinates": {
        "property1": "string",
        "property2": "string"
      }
    },
    "threatLevel": 0,
    "componentUpgradeAvailable": true,
    "displayName": {
      "parts": [
        {
          "field": "string",
          "value": "string"
        }
      ],
      "name": "string"
    }
  }
]

Responses

Status Meaning Description Schema
default Default default response Inline

Response Schema

Status Code default

Name Type Required Restrictions Description
anonymous [ApiPolicyWaiverDTO] false none none
» policyWaiverId string false none none
» policyViolationId string false none none
» comment string false none none
» createTime string(date-time) false none none
» expiryTime string(date-time) false none none
» isObsolete boolean false none none
» scopeOwnerType string false none none
» scopeOwnerId string false none none
» scopeOwnerName string false none none
» hash string false none none
» policyId string false none none
» vulnerabilityId string false none none
» policyName string false none none
» constraintFacts [ConstraintFact] false none none
»» constraintId string false none none
»» constraintName string false none none
»» operatorName string false none none
»» conditionFacts [ConditionFact] false none none
»»» conditionTypeId string false none none
»»» conditionIndex integer(int32) false none none
»»» summary string false none none
»»» reason string false none none
»»» reference TriggerReference false none none
»»»» value string false none none
»»»» type string false none none
»»» triggerJson string false none none
» constraintFactsJson string false none none
» componentName string false none none
» creatorId string false none none
» creatorName string false none none
» matcherStrategy string false none none
» associatedPackageUrl string false none none
» componentIdentifier ApiComponentIdentifierDTOV2 false none none
»» format string false none none
»» coordinates object false none none
»»» additionalProperties string false none none
» threatLevel integer(int32) false none none
» componentUpgradeAvailable boolean false none none
» displayName ComponentDisplayName false none none
»» parts [ComponentDisplayNamePart] false none none
»»» field string false none none
»»» value string false none none
»» name string false none none

Enumerated Values

Property Value
type SECURITY_VULNERABILITY_REFID
matcherStrategy DEFAULT
matcherStrategy EXACT_COMPONENT
matcherStrategy ALL_COMPONENTS
matcherStrategy ALL_VERSIONS

requestPolicyWaiver

Code samples

URL obj = new URL("/api/v2/policyWaivers/waiverRequests/{policyViolationId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*'
}

r = requests.post('/api/v2/policyWaivers/waiverRequests/{policyViolationId}', headers = headers)

print(r.json())


const inputBody = '{
  "comment": "string",
  "policyViolationLink": "string",
  "addWaiverLink": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*'
};

fetch('/api/v2/policyWaivers/waiverRequests/{policyViolationId}',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /api/v2/policyWaivers/waiverRequests/{policyViolationId}

Body parameter

{
  "comment": "string",
  "policyViolationLink": "string",
  "addWaiverLink": "string"
}

Parameters

Name In Type Required Description
policyViolationId path string true none
body body ApiRequestPolicyWaiverDTO false none

Example responses

Responses

Status Meaning Description Schema
default Default default response None

Response Schema

Product

installLicense

Code samples

URL obj = new URL("/api/v2/product/license");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Content-Type': 'multipart/form-data',
  'Accept': 'text/plain'
}

r = requests.post('/api/v2/product/license', headers = headers)

print(r.json())


const inputBody = '{
  "file": {
    "type": "string",
    "parameters": {
      "property1": "string",
      "property2": "string"
    },
    "fileName": "string",
    "creationDate": "2019-08-24T14:15:22Z",
    "modificationDate": "2019-08-24T14:15:22Z",
    "readDate": "2019-08-24T14:15:22Z",
    "size": 0,
    "name": "string"
  }
}';
const headers = {
  'Content-Type':'multipart/form-data',
  'Accept':'text/plain'
};

fetch('/api/v2/product/license',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /api/v2/product/license

Body parameter

file:
  type: string
  parameters:
    property1: string
    property2: string
  fileName: string
  creationDate: 2019-08-24T14:15:22Z
  modificationDate: 2019-08-24T14:15:22Z
  readDate: 2019-08-24T14:15:22Z
  size: 0
  name: string

Parameters

Name In Type Required Description
body body object false none
» file body FormDataContentDisposition false none
»» type body string false none
»» parameters body object false none
»»» additionalProperties body string false none
»» fileName body string false none
»» creationDate body string(date-time) false none
»» modificationDate body string(date-time) false none
»» readDate body string(date-time) false none
»» size body integer(int64) false none
»» name body string false none

Example responses

Responses

Status Meaning Description Schema
default Default default response None

Response Schema

uninstallLicense

Code samples

URL obj = new URL("/api/v2/product/license");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': '*/*'
}

r = requests.delete('/api/v2/product/license', headers = headers)

print(r.json())



const headers = {
  'Accept':'*/*'
};

fetch('/api/v2/product/license',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /api/v2/product/license

Example responses

Responses

Status Meaning Description Schema
default Default default response None

Response Schema

Reports

getComponentsInQuarantine

Code samples

URL obj = new URL("/api/v2/reports/components/quarantined");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/reports/components/quarantined', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/reports/components/quarantined',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/reports/components/quarantined

Example responses

default Response

{
  "componentsInQuarantine": [
    {
      "repository": {
        "repositoryId": "string",
        "publicId": "string",
        "format": "string",
        "type": "string",
        "auditEnabled": true,
        "quarantineEnabled": true,
        "policyCompliantComponentSelectionEnabled": true,
        "namespaceConfusionProtectionEnabled": true
      },
      "components": [
        {
          "component": {
            "packageUrl": "string",
            "hash": "string",
            "sha256": "string",
            "componentIdentifier": {
              "format": "string",
              "coordinates": {
                "property1": "string",
                "property2": "string"
              }
            },
            "displayName": "string",
            "thirdParty": true,
            "quarantineId": "string",
            "quarantineTime": "2019-08-24T14:15:22Z",
            "quarantineReleaseTime": "2019-08-24T14:15:22Z"
          },
          "waivedPolicyViolations": [
            {
              "policyId": "string",
              "policyName": "string",
              "policyViolationId": "string",
              "threatLevel": 0,
              "constraintViolations": [
                {
                  "constraintId": "string",
                  "constraintName": "string",
                  "reasons": [
                    {}
                  ]
                }
              ],
              "policyWaiver": {
                "policyWaiverId": "string",
                "policyViolationId": "string",
                "comment": "string",
                "createTime": "2019-08-24T14:15:22Z",
                "expiryTime": "2019-08-24T14:15:22Z",
                "isObsolete": true,
                "scopeOwnerType": "string",
                "scopeOwnerId": "string",
                "scopeOwnerName": "string",
                "hash": "string",
                "policyId": "string",
                "vulnerabilityId": "string",
                "policyName": "string",
                "constraintFacts": [
                  {
                    "constraintId": "string",
                    "constraintName": "string",
                    "operatorName": "string",
                    "conditionFacts": []
                  }
                ],
                "constraintFactsJson": "string",
                "componentName": "string",
                "creatorId": "string",
                "creatorName": "string",
                "matcherStrategy": "DEFAULT",
                "associatedPackageUrl": "string",
                "componentIdentifier": {
                  "format": "string",
                  "coordinates": {
                    "property1": "string",
                    "property2": "string"
                  }
                },
                "threatLevel": 0,
                "componentUpgradeAvailable": true,
                "displayName": {
                  "parts": [
                    {}
                  ],
                  "name": "string"
                }
              }
            }
          ],
          "policyViolations": [
            {
              "policyId": "string",
              "policyName": "string",
              "policyViolationId": "string",
              "threatLevel": 0,
              "constraintViolations": [
                {
                  "constraintId": "string",
                  "constraintName": "string",
                  "reasons": [
                    {}
                  ]
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

Responses

Status Meaning Description Schema
default Default default response ApiComponentsInQuarantineDTO

getComponentsWithWaivers

Code samples

URL obj = new URL("/api/v2/reports/components/waivers");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/reports/components/waivers', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/reports/components/waivers',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/reports/components/waivers

Parameters

Name In Type Required Description
format query string false none

Example responses

default Response

{
  "applicationWaivers": [
    {
      "application": {
        "id": "string",
        "publicId": "string",
        "name": "string",
        "organizationId": "string",
        "contactUserName": "string"
      },
      "stages": [
        {
          "stageId": "string",
          "componentPolicyViolations": [
            {
              "component": {
                "packageUrl": "string",
                "hash": "string",
                "sha256": "string",
                "componentIdentifier": {
                  "format": "string",
                  "coordinates": {
                    "property1": "string",
                    "property2": "string"
                  }
                },
                "displayName": "string",
                "proprietary": true,
                "thirdParty": true
              },
              "waivedPolicyViolations": [
                {
                  "policyId": "string",
                  "policyName": "string",
                  "policyViolationId": "string",
                  "threatLevel": 0,
                  "constraintViolations": [
                    {}
                  ],
                  "policyWaiver": {
                    "policyWaiverId": "string",
                    "policyViolationId": "string",
                    "comment": "string",
                    "createTime": "2019-08-24T14:15:22Z",
                    "expiryTime": "2019-08-24T14:15:22Z",
                    "isObsolete": true,
                    "scopeOwnerType": "string",
                    "scopeOwnerId": "string",
                    "scopeOwnerName": "string",
                    "hash": "string",
                    "policyId": "string",
                    "vulnerabilityId": "string",
                    "policyName": "string",
                    "constraintFacts": [],
                    "constraintFactsJson": "string",
                    "componentName": "string",
                    "creatorId": "string",
                    "creatorName": "string",
                    "matcherStrategy": "DEFAULT",
                    "associatedPackageUrl": "string",
                    "componentIdentifier": {},
                    "threatLevel": 0,
                    "componentUpgradeAvailable": true,
                    "displayName": {}
                  }
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "repositoryWaivers": [
    {
      "repository": {
        "repositoryId": "string",
        "publicId": "string",
        "format": "string",
        "type": "string",
        "auditEnabled": true,
        "quarantineEnabled": true,
        "policyCompliantComponentSelectionEnabled": true,
        "namespaceConfusionProtectionEnabled": true
      },
      "stages": [
        {
          "stageId": "string",
          "componentPolicyViolations": [
            {
              "component": {
                "packageUrl": "string",
                "hash": "string",
                "sha256": "string",
                "componentIdentifier": {
                  "format": "string",
                  "coordinates": {
                    "property1": "string",
                    "property2": "string"
                  }
                },
                "displayName": "string",
                "proprietary": true,
                "thirdParty": true
              },
              "waivedPolicyViolations": [
                {
                  "policyId": "string",
                  "policyName": "string",
                  "policyViolationId": "string",
                  "threatLevel": 0,
                  "constraintViolations": [
                    {}
                  ],
                  "policyWaiver": {
                    "policyWaiverId": "string",
                    "policyViolationId": "string",
                    "comment": "string",
                    "createTime": "2019-08-24T14:15:22Z",
                    "expiryTime": "2019-08-24T14:15:22Z",
                    "isObsolete": true,
                    "scopeOwnerType": "string",
                    "scopeOwnerId": "string",
                    "scopeOwnerName": "string",
                    "hash": "string",
                    "policyId": "string",
                    "vulnerabilityId": "string",
                    "policyName": "string",
                    "constraintFacts": [],
                    "constraintFactsJson": "string",
                    "componentName": "string",
                    "creatorId": "string",
                    "creatorName": "string",
                    "matcherStrategy": "DEFAULT",
                    "associatedPackageUrl": "string",
                    "componentIdentifier": {},
                    "threatLevel": 0,
                    "componentUpgradeAvailable": true,
                    "displayName": {}
                  }
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

Responses

Status Meaning Description Schema
default Default default response ApiComponentWaiversDTO

getMetrics

Code samples

URL obj = new URL("/api/v2/reports/metrics");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('/api/v2/reports/metrics', headers = headers)

print(r.json())


const inputBody = '{
  "timePeriod": "WEEK",
  "firstTimePeriod": "string",
  "lastTimePeriod": "string",
  "applicationIds": [
    "string"
  ],
  "organizationIds": [
    "string"
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/api/v2/reports/metrics',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /api/v2/reports/metrics

Body parameter

{
  "timePeriod": "WEEK",
  "firstTimePeriod": "string",
  "lastTimePeriod": "string",
  "applicationIds": [
    "string"
  ],
  "organizationIds": [
    "string"
  ]
}

Parameters

Name In Type Required Description
body body ApiMetricsReportingQueryDTOV2 false none

Example responses

Responses

Status Meaning Description Schema
default Default default response None

Response Schema

getAll_1

Code samples

URL obj = new URL("/api/v2/reports/applications");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/reports/applications', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/reports/applications',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/reports/applications

Example responses

default Response

[
  {
    "stage": "string",
    "applicationId": "string",
    "evaluationDate": "2019-08-24T14:15:22Z",
    "latestReportHtmlUrl": "string",
    "reportHtmlUrl": "string",
    "embeddableReportHtmlUrl": "string",
    "reportPdfUrl": "string",
    "reportDataUrl": "string"
  }
]

Responses

Status Meaning Description Schema
default Default default response Inline

Response Schema

Status Code default

Name Type Required Restrictions Description
anonymous [ApiApplicationReportDTOV2] false none none
» stage string false none none
» applicationId string false none none
» evaluationDate string(date-time) false none none
» latestReportHtmlUrl string false none none
» reportHtmlUrl string false none none
» embeddableReportHtmlUrl string false none none
» reportPdfUrl string false none none
» reportDataUrl string false none none

getByApplicationId

Code samples

URL obj = new URL("/api/v2/reports/applications/{applicationId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/reports/applications/{applicationId}', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/reports/applications/{applicationId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/reports/applications/{applicationId}

Parameters

Name In Type Required Description
applicationId path string true none

Example responses

default Response

[
  {
    "stage": "string",
    "applicationId": "string",
    "evaluationDate": "2019-08-24T14:15:22Z",
    "latestReportHtmlUrl": "string",
    "reportHtmlUrl": "string",
    "embeddableReportHtmlUrl": "string",
    "reportPdfUrl": "string",
    "reportDataUrl": "string"
  }
]

Responses

Status Meaning Description Schema
default Default default response Inline

Response Schema

Status Code default

Name Type Required Restrictions Description
anonymous [ApiApplicationReportDTOV2] false none none
» stage string false none none
» applicationId string false none none
» evaluationDate string(date-time) false none none
» latestReportHtmlUrl string false none none
» reportHtmlUrl string false none none
» embeddableReportHtmlUrl string false none none
» reportPdfUrl string false none none
» reportDataUrl string false none none

getReportHistoryForApplication

Code samples

URL obj = new URL("/api/v2/reports/applications/{applicationId}/history");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/reports/applications/{applicationId}/history', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/reports/applications/{applicationId}/history',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/reports/applications/{applicationId}/history

Parameters

Name In Type Required Description
applicationId path string true none
stage query string false none
limit query integer(int32) false none

Example responses

default Response

{
  "applicationId": "string",
  "reports": [
    {
      "stage": "string",
      "applicationId": "string",
      "evaluationDate": "2019-08-24T14:15:22Z",
      "latestReportHtmlUrl": "string",
      "reportHtmlUrl": "string",
      "embeddableReportHtmlUrl": "string",
      "reportPdfUrl": "string",
      "reportDataUrl": "string",
      "policyEvaluationId": "string",
      "scanId": "string",
      "isReevaluation": true,
      "isForMonitoring": true,
      "commitHash": "string",
      "scanTriggerType": "string",
      "policyEvaluationResult": {
        "alerts": [
          {
            "trigger": {
              "policyId": "string",
              "policyName": "string",
              "threatLevel": 0,
              "policyViolationId": "string",
              "componentFacts": [
                {
                  "componentIdentifier": {
                    "format": "string",
                    "coordinates": {}
                  },
                  "hash": "string",
                  "constraintFacts": [
                    {}
                  ],
                  "pathnames": [
                    "string"
                  ],
                  "displayName": {
                    "parts": [],
                    "name": "string"
                  }
                }
              ]
            },
            "actions": [
              {
                "actionTypeId": "string",
                "target": "string",
                "targetType": "string"
              }
            ]
          }
        ],
        "affectedComponentCount": 0,
        "criticalComponentCount": 0,
        "severeComponentCount": 0,
        "moderateComponentCount": 0,
        "criticalPolicyViolationCount": 0,
        "severePolicyViolationCount": 0,
        "moderatePolicyViolationCount": 0,
        "legacyViolationCount": 0,
        "totalComponentCount": 0,
        "grandfatheredPolicyViolationCount": 0
      }
    }
  ]
}

Responses

Status Meaning Description Schema
default Default default response ApiReportHistoryDTO

getStaleWaivers

Code samples

URL obj = new URL("/api/v2/reports/waivers/stale");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/reports/waivers/stale', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/reports/waivers/stale',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/reports/waivers/stale

Example responses

default Response

{
  "staleWaivers": [
    {
      "waiverId": "string",
      "policyId": "string",
      "policyName": "string",
      "comment": "string",
      "scopeOwnerType": "string",
      "scopeOwnerId": "string",
      "scopeOwnerName": "string",
      "createTime": "2019-08-24T14:15:22Z",
      "expiryTime": "2019-08-24T14:15:22Z",
      "creatorId": "string",
      "creatorName": "string",
      "constraintFacts": [
        {
          "constraintName": "string",
          "constraintId": "string",
          "reasons": [
            {
              "reason": "string"
            }
          ]
        }
      ],
      "staleEvaluations": {
        "applications": [
          {
            "application": {
              "id": "string",
              "publicId": "string",
              "name": "string",
              "organizationId": "string",
              "contactUserName": "string"
            },
            "stages": [
              {
                "stageId": "string",
                "lastEvaluationDate": "2019-08-24T14:15:22Z"
              }
            ]
          }
        ],
        "repositories": [
          {
            "repository": {
              "repositoryId": "string",
              "publicId": "string",
              "format": "string",
              "type": "string",
              "auditEnabled": true,
              "quarantineEnabled": true,
              "policyCompliantComponentSelectionEnabled": true,
              "namespaceConfusionProtectionEnabled": true
            },
            "stages": [
              {
                "stageId": "string",
                "lastEvaluationDate": "2019-08-24T14:15:22Z"
              }
            ]
          }
        ]
      }
    }
  ]
}

Responses

Status Meaning Description Schema
default Default default response ApiStaleWaiversResponseDTO

Repositories

releaseQuarantineWithoutReEval

Code samples

URL obj = new URL("/api/v2/repositories/quarantine/{quarantineId}/release");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Content-Type': 'text/plain',
  'Accept': 'application/json'
}

r = requests.post('/api/v2/repositories/quarantine/{quarantineId}/release', headers = headers)

print(r.json())


const inputBody = 'string';
const headers = {
  'Content-Type':'text/plain',
  'Accept':'application/json'
};

fetch('/api/v2/repositories/quarantine/{quarantineId}/release',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /api/v2/repositories/quarantine/{quarantineId}/release

Body parameter

string

Parameters

Name In Type Required Description
quarantineId path string true none
body body string false none

Example responses

default Response

{
  "componentReleasedFromQuarantine": {
    "component": {
      "packageUrl": "string",
      "hash": "string",
      "sha256": "string",
      "componentIdentifier": {
        "format": "string",
        "coordinates": {
          "property1": "string",
          "property2": "string"
        }
      },
      "displayName": "string",
      "thirdParty": true,
      "quarantineId": "string",
      "quarantineTime": "2019-08-24T14:15:22Z",
      "quarantineReleaseTime": "2019-08-24T14:15:22Z"
    },
    "waivedPolicyViolations": [
      {
        "policyId": "string",
        "policyName": "string",
        "policyViolationId": "string",
        "threatLevel": 0,
        "constraintViolations": [
          {
            "constraintId": "string",
            "constraintName": "string",
            "reasons": [
              {
                "reason": "string",
                "reference": {
                  "value": "string",
                  "type": "SECURITY_VULNERABILITY_REFID"
                }
              }
            ]
          }
        ],
        "policyWaiver": {
          "policyWaiverId": "string",
          "policyViolationId": "string",
          "comment": "string",
          "createTime": "2019-08-24T14:15:22Z",
          "expiryTime": "2019-08-24T14:15:22Z",
          "isObsolete": true,
          "scopeOwnerType": "string",
          "scopeOwnerId": "string",
          "scopeOwnerName": "string",
          "hash": "string",
          "policyId": "string",
          "vulnerabilityId": "string",
          "policyName": "string",
          "constraintFacts": [
            {
              "constraintId": "string",
              "constraintName": "string",
              "operatorName": "string",
              "conditionFacts": [
                {
                  "conditionTypeId": "string",
                  "conditionIndex": 0,
                  "summary": "string",
                  "reason": "string",
                  "reference": {
                    "value": "string",
                    "type": "SECURITY_VULNERABILITY_REFID"
                  },
                  "triggerJson": "string"
                }
              ]
            }
          ],
          "constraintFactsJson": "string",
          "componentName": "string",
          "creatorId": "string",
          "creatorName": "string",
          "matcherStrategy": "DEFAULT",
          "associatedPackageUrl": "string",
          "componentIdentifier": {
            "format": "string",
            "coordinates": {
              "property1": "string",
              "property2": "string"
            }
          },
          "threatLevel": 0,
          "componentUpgradeAvailable": true,
          "displayName": {
            "parts": [
              {
                "field": "string",
                "value": "string"
              }
            ],
            "name": "string"
          }
        }
      }
    ],
    "policyViolations": [
      {
        "policyId": "string",
        "policyName": "string",
        "policyViolationId": "string",
        "threatLevel": 0,
        "constraintViolations": [
          {
            "constraintId": "string",
            "constraintName": "string",
            "reasons": [
              {
                "reason": "string",
                "reference": {
                  "value": "string",
                  "type": "SECURITY_VULNERABILITY_REFID"
                }
              }
            ]
          }
        ]
      }
    ]
  }
}

Responses

Status Meaning Description Schema
default Default default response ApiComponentReleasedFromQuarantineDTO

getQuarantinedByPath

Code samples

URL obj = new URL("/api/v2/repositories/{repositoryManagerInstanceId}/{repositoryPublicId}/components/quarantined/pathnames");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('/api/v2/repositories/{repositoryManagerInstanceId}/{repositoryPublicId}/components/quarantined/pathnames', headers = headers)

print(r.json())


const inputBody = '[
  "string"
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/api/v2/repositories/{repositoryManagerInstanceId}/{repositoryPublicId}/components/quarantined/pathnames',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /api/v2/repositories/{repositoryManagerInstanceId}/{repositoryPublicId}/components/quarantined/pathnames

Body parameter

[
  "string"
]

Parameters

Name In Type Required Description
repositoryManagerInstanceId path string true none
repositoryPublicId path string true none
body body array[string] false none

Example responses

default Response

{
  "pathVersions": [
    {
      "requestIndex": 0,
      "repositoryComponentPaths": [
        {
          "pathname": "string",
          "quarantine": true
        }
      ]
    }
  ]
}

Responses

Status Meaning Description Schema
default Default default response ApiRepositoryPathResponseDTO

Role Memberships

getRoleMembershipsApplicationOrOrganization

Code samples

URL obj = new URL("/api/v2/roleMemberships/{ownerType}/{internalOwnerId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/roleMemberships/{ownerType}/{internalOwnerId}', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/roleMemberships/{ownerType}/{internalOwnerId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/roleMemberships/{ownerType}/{internalOwnerId}

Parameters

Name In Type Required Description
ownerType path string true none
internalOwnerId path string true none

Enumerated Values

Parameter Value
ownerType application
ownerType organization
ownerType repository_container
ownerType repository_manager
ownerType repository
ownerType global

Example responses

default Response

{
  "memberMappings": [
    {
      "roleId": "string",
      "members": [
        {
          "ownerId": "string",
          "ownerType": "string",
          "type": "USER",
          "userOrGroupName": "string"
        }
      ]
    }
  ]
}

Responses

Status Meaning Description Schema
default Default default response ApiRoleMemberMappingListDTO

getRoleMembershipsGlobalOrRepositoryContainer

Code samples

URL obj = new URL("/api/v2/roleMemberships/{ownerType}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/roleMemberships/{ownerType}', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/roleMemberships/{ownerType}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/roleMemberships/{ownerType}

Parameters

Name In Type Required Description
ownerType path string true none

Enumerated Values

Parameter Value
ownerType application
ownerType organization
ownerType repository_container
ownerType repository_manager
ownerType repository
ownerType global

Example responses

default Response

{
  "memberMappings": [
    {
      "roleId": "string",
      "members": [
        {
          "ownerId": "string",
          "ownerType": "string",
          "type": "USER",
          "userOrGroupName": "string"
        }
      ]
    }
  ]
}

Responses

Status Meaning Description Schema
default Default default response ApiRoleMemberMappingListDTO

grantRoleMembershipApplicationOrOrganization

Code samples

URL obj = new URL("/api/v2/roleMemberships/{ownerType}/{internalOwnerId}/role/{roleId}/{memberType}/{memberName}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': '*/*'
}

r = requests.put('/api/v2/roleMemberships/{ownerType}/{internalOwnerId}/role/{roleId}/{memberType}/{memberName}', headers = headers)

print(r.json())



const headers = {
  'Accept':'*/*'
};

fetch('/api/v2/roleMemberships/{ownerType}/{internalOwnerId}/role/{roleId}/{memberType}/{memberName}',
{
  method: 'PUT',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /api/v2/roleMemberships/{ownerType}/{internalOwnerId}/role/{roleId}/{memberType}/{memberName}

Parameters

Name In Type Required Description
ownerType path string true none
internalOwnerId path string true none
roleId path string true none
memberType path string true none
memberName path string true none

Enumerated Values

Parameter Value
ownerType application
ownerType organization
ownerType repository_container
ownerType repository_manager
ownerType repository
ownerType global
memberType USER
memberType GROUP

Example responses

Responses

Status Meaning Description Schema
default Default default response None

Response Schema

revokeRoleMembershipApplicationOrOrganization

Code samples

URL obj = new URL("/api/v2/roleMemberships/{ownerType}/{internalOwnerId}/role/{roleId}/{memberType}/{memberName}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': '*/*'
}

r = requests.delete('/api/v2/roleMemberships/{ownerType}/{internalOwnerId}/role/{roleId}/{memberType}/{memberName}', headers = headers)

print(r.json())



const headers = {
  'Accept':'*/*'
};

fetch('/api/v2/roleMemberships/{ownerType}/{internalOwnerId}/role/{roleId}/{memberType}/{memberName}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /api/v2/roleMemberships/{ownerType}/{internalOwnerId}/role/{roleId}/{memberType}/{memberName}

Parameters

Name In Type Required Description
ownerType path string true none
internalOwnerId path string true none
roleId path string true none
memberType path string true none
memberName path string true none

Enumerated Values

Parameter Value
ownerType application
ownerType organization
ownerType repository_container
ownerType repository_manager
ownerType repository
ownerType global
memberType USER
memberType GROUP

Example responses

Responses

Status Meaning Description Schema
default Default default response None

Response Schema

grantRoleMembershipGlobalOrRepositoryContainer

Code samples

URL obj = new URL("/api/v2/roleMemberships/{ownerType}/role/{roleId}/{memberType}/{memberName}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': '*/*'
}

r = requests.put('/api/v2/roleMemberships/{ownerType}/role/{roleId}/{memberType}/{memberName}', headers = headers)

print(r.json())



const headers = {
  'Accept':'*/*'
};

fetch('/api/v2/roleMemberships/{ownerType}/role/{roleId}/{memberType}/{memberName}',
{
  method: 'PUT',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /api/v2/roleMemberships/{ownerType}/role/{roleId}/{memberType}/{memberName}

Parameters

Name In Type Required Description
ownerType path string true none
roleId path string true none
memberType path string true none
memberName path string true none

Enumerated Values

Parameter Value
ownerType application
ownerType organization
ownerType repository_container
ownerType repository_manager
ownerType repository
ownerType global
memberType USER
memberType GROUP

Example responses

Responses

Status Meaning Description Schema
default Default default response None

Response Schema

revokeRoleMembershipGlobalOrRepositoryContainer

Code samples

URL obj = new URL("/api/v2/roleMemberships/{ownerType}/role/{roleId}/{memberType}/{memberName}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': '*/*'
}

r = requests.delete('/api/v2/roleMemberships/{ownerType}/role/{roleId}/{memberType}/{memberName}', headers = headers)

print(r.json())



const headers = {
  'Accept':'*/*'
};

fetch('/api/v2/roleMemberships/{ownerType}/role/{roleId}/{memberType}/{memberName}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /api/v2/roleMemberships/{ownerType}/role/{roleId}/{memberType}/{memberName}

Parameters

Name In Type Required Description
ownerType path string true none
roleId path string true none
memberType path string true none
memberName path string true none

Enumerated Values

Parameter Value
ownerType application
ownerType organization
ownerType repository_container
ownerType repository_manager
ownerType repository
ownerType global
memberType USER
memberType GROUP

Example responses

Responses

Status Meaning Description Schema
default Default default response None

Response Schema

Roles

getRoles

Code samples

URL obj = new URL("/api/v2/roles");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/roles', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/roles',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/roles

Example responses

default Response

{
  "roles": [
    {
      "id": "string",
      "name": "string",
      "description": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
default Default default response ApiRoleListDTO

Scan

getIdeUsersOverview

Code samples

URL obj = new URL("/api/v2/scan/applications/ideUser/overview");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/scan/applications/ideUser/overview', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/scan/applications/ideUser/overview',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/scan/applications/ideUser/overview

Parameters

Name In Type Required Description
sinceUtcTimestamp query integer(int64) false none

Example responses

default Response

{
  "userCount": 0
}

Responses

Status Meaning Description Schema
default Default default response IdeUsersOverviewDTO

getScanStatus

Code samples

URL obj = new URL("/api/v2/scan/applications/{applicationId}/status/{scanRequestId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/scan/applications/{applicationId}/status/{scanRequestId}', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/scan/applications/{applicationId}/status/{scanRequestId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/scan/applications/{applicationId}/status/{scanRequestId}

Parameters

Name In Type Required Description
applicationId path string true none
scanRequestId path string true none

Example responses

default Response

{
  "policyAction": "string",
  "reportHtmlUrl": "string",
  "reportPdfUrl": "string",
  "reportDataUrl": "string",
  "embeddableReportHtmlUrl": "string",
  "isError": true,
  "errorMessage": "string",
  "componentsAffected": {
    "critical": 0,
    "severe": 0,
    "moderate": 0
  },
  "openPolicyViolations": {
    "critical": 0,
    "severe": 0,
    "moderate": 0
  },
  "grandfatheredPolicyViolations": 0,
  "legacyViolations": 0
}

Responses

Status Meaning Description Schema
default Default default response ApiThirdPartyScanResultDTO

scanComponents

Code samples

URL obj = new URL("/api/v2/scan/applications/{applicationId}/sources/{source}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Content-Type': 'application/xml',
  'Accept': 'application/json'
}

r = requests.post('/api/v2/scan/applications/{applicationId}/sources/{source}', headers = headers)

print(r.json())


const inputBody = 'string';
const headers = {
  'Content-Type':'application/xml',
  'Accept':'application/json'
};

fetch('/api/v2/scan/applications/{applicationId}/sources/{source}',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /api/v2/scan/applications/{applicationId}/sources/{source}

Body parameter

"string"

Parameters

Name In Type Required Description
applicationId path string true none
source path string true none
stageId query string false none
body body string false none

Example responses

Responses

Status Meaning Description Schema
default Default default response None

Response Schema

Search

searchComponent

Code samples

URL obj = new URL("/api/v2/search/component");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/search/component', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/search/component',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/search/component

Parameters

Name In Type Required Description
stageId query string false none
hash query string false none
componentIdentifier query ComponentIdentifier false none
packageUrl query string false none

Example responses

default Response

{
  "criteria": {
    "stageId": "string",
    "hash": "string",
    "componentIdentifier": {
      "format": "string",
      "coordinates": {
        "property1": "string",
        "property2": "string"
      }
    },
    "packageUrl": "string"
  },
  "results": [
    {
      "applicationId": "string",
      "applicationName": "string",
      "reportHtmlUrl": "string",
      "reportUrl": "string",
      "hash": "string",
      "componentIdentifier": {
        "format": "string",
        "coordinates": {
          "property1": "string",
          "property2": "string"
        }
      },
      "packageUrl": "string",
      "threatLevel": 0,
      "dependencyData": {
        "directDependency": true,
        "innerSource": true,
        "parentComponentPurls": [
          "string"
        ],
        "innerSourceData": [
          {
            "ownerApplicationName": "string",
            "ownerApplicationId": "string",
            "innerSourceComponentPurl": "string"
          }
        ]
      }
    }
  ]
}

Responses

Status Meaning Description Schema
default Default default response ApiSearchResultsDTOV2

Security Overrides

getSecurityVulnerabilityOverrides

Code samples

URL obj = new URL("/api/v2/securityOverrides");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/securityOverrides', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/securityOverrides',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/securityOverrides

Parameters

Name In Type Required Description
refId query string false none
componentPurl query string false none
ownerId query string false none

Example responses

default Response

{
  "securityOverrides": [
    {
      "securityOverrideId": "string",
      "hash": "string",
      "referenceId": "string",
      "status": "string",
      "comment": "string",
      "owner": {
        "ownerPublicId": "string",
        "ownerId": "string",
        "ownerName": "string",
        "ownerType": "string"
      },
      "currentlyAffectedComponents": [
        {
          "packageUrl": "string",
          "hash": "string",
          "sha256": "string",
          "componentIdentifier": {
            "format": "string",
            "coordinates": {
              "property1": "string",
              "property2": "string"
            }
          },
          "displayName": "string",
          "proprietary": true,
          "thirdParty": true
        }
      ]
    }
  ]
}

Responses

Status Meaning Description Schema
default Default default response ApiSecurityVulnerabilityOverrideResponseDTOV2

Source Control

getSourceControl_1

Code samples

URL obj = new URL("/api/v2/sourceControl/{ownerType}/{internalOwnerId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/sourceControl/{ownerType}/{internalOwnerId}', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/sourceControl/{ownerType}/{internalOwnerId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/sourceControl/{ownerType}/{internalOwnerId}

Parameters

Name In Type Required Description
ownerType path string true none
internalOwnerId path string true none

Enumerated Values

Parameter Value
ownerType application
ownerType organization
ownerType repository_container
ownerType repository_manager
ownerType repository
ownerType global

Example responses

default Response

{
  "id": "string",
  "ownerId": "string",
  "repositoryUrl": "string",
  "username": "string",
  "token": "string",
  "provider": "string",
  "baseBranch": "string",
  "enablePullRequests": true,
  "remediationPullRequestsEnabled": true,
  "enableStatusChecks": true,
  "statusChecksEnabled": true,
  "pullRequestCommentingEnabled": true,
  "sourceControlEvaluationsEnabled": true,
  "sourceControlScanTarget": "string",
  "sshEnabled": true,
  "commitStatusEnabled": true
}

Responses

Status Meaning Description Schema
default Default default response ApiSourceControlDTO

updateSourceControl

Code samples

URL obj = new URL("/api/v2/sourceControl/{ownerType}/{internalOwnerId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('/api/v2/sourceControl/{ownerType}/{internalOwnerId}', headers = headers)

print(r.json())


const inputBody = '{
  "id": "string",
  "ownerId": "string",
  "repositoryUrl": "string",
  "username": "string",
  "token": "string",
  "provider": "string",
  "baseBranch": "string",
  "enablePullRequests": true,
  "remediationPullRequestsEnabled": true,
  "enableStatusChecks": true,
  "statusChecksEnabled": true,
  "pullRequestCommentingEnabled": true,
  "sourceControlEvaluationsEnabled": true,
  "sourceControlScanTarget": "string",
  "sshEnabled": true,
  "commitStatusEnabled": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/api/v2/sourceControl/{ownerType}/{internalOwnerId}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /api/v2/sourceControl/{ownerType}/{internalOwnerId}

Body parameter

{
  "id": "string",
  "ownerId": "string",
  "repositoryUrl": "string",
  "username": "string",
  "token": "string",
  "provider": "string",
  "baseBranch": "string",
  "enablePullRequests": true,
  "remediationPullRequestsEnabled": true,
  "enableStatusChecks": true,
  "statusChecksEnabled": true,
  "pullRequestCommentingEnabled": true,
  "sourceControlEvaluationsEnabled": true,
  "sourceControlScanTarget": "string",
  "sshEnabled": true,
  "commitStatusEnabled": true
}

Parameters

Name In Type Required Description
ownerType path string true none
internalOwnerId path string true none
body body ApiSourceControlDTO false none

Enumerated Values

Parameter Value
ownerType application
ownerType organization
ownerType repository_container
ownerType repository_manager
ownerType repository
ownerType global

Example responses

default Response

{
  "id": "string",
  "ownerId": "string",
  "repositoryUrl": "string",
  "username": "string",
  "token": "string",
  "provider": "string",
  "baseBranch": "string",
  "enablePullRequests": true,
  "remediationPullRequestsEnabled": true,
  "enableStatusChecks": true,
  "statusChecksEnabled": true,
  "pullRequestCommentingEnabled": true,
  "sourceControlEvaluationsEnabled": true,
  "sourceControlScanTarget": "string",
  "sshEnabled": true,
  "commitStatusEnabled": true
}

Responses

Status Meaning Description Schema
default Default default response ApiSourceControlDTO

addSourceControl

Code samples

URL obj = new URL("/api/v2/sourceControl/{ownerType}/{internalOwnerId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('/api/v2/sourceControl/{ownerType}/{internalOwnerId}', headers = headers)

print(r.json())


const inputBody = '{
  "id": "string",
  "ownerId": "string",
  "repositoryUrl": "string",
  "username": "string",
  "token": "string",
  "provider": "string",
  "baseBranch": "string",
  "enablePullRequests": true,
  "remediationPullRequestsEnabled": true,
  "enableStatusChecks": true,
  "statusChecksEnabled": true,
  "pullRequestCommentingEnabled": true,
  "sourceControlEvaluationsEnabled": true,
  "sourceControlScanTarget": "string",
  "sshEnabled": true,
  "commitStatusEnabled": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/api/v2/sourceControl/{ownerType}/{internalOwnerId}',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /api/v2/sourceControl/{ownerType}/{internalOwnerId}

Body parameter

{
  "id": "string",
  "ownerId": "string",
  "repositoryUrl": "string",
  "username": "string",
  "token": "string",
  "provider": "string",
  "baseBranch": "string",
  "enablePullRequests": true,
  "remediationPullRequestsEnabled": true,
  "enableStatusChecks": true,
  "statusChecksEnabled": true,
  "pullRequestCommentingEnabled": true,
  "sourceControlEvaluationsEnabled": true,
  "sourceControlScanTarget": "string",
  "sshEnabled": true,
  "commitStatusEnabled": true
}

Parameters

Name In Type Required Description
ownerType path string true none
internalOwnerId path string true none
body body ApiSourceControlDTO false none

Enumerated Values

Parameter Value
ownerType application
ownerType organization
ownerType repository_container
ownerType repository_manager
ownerType repository
ownerType global

Example responses

default Response

{
  "id": "string",
  "ownerId": "string",
  "repositoryUrl": "string",
  "username": "string",
  "token": "string",
  "provider": "string",
  "baseBranch": "string",
  "enablePullRequests": true,
  "remediationPullRequestsEnabled": true,
  "enableStatusChecks": true,
  "statusChecksEnabled": true,
  "pullRequestCommentingEnabled": true,
  "sourceControlEvaluationsEnabled": true,
  "sourceControlScanTarget": "string",
  "sshEnabled": true,
  "commitStatusEnabled": true
}

Responses

Status Meaning Description Schema
default Default default response ApiSourceControlDTO

deleteSourceControl

Code samples

URL obj = new URL("/api/v2/sourceControl/{ownerType}/{internalOwnerId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': '*/*'
}

r = requests.delete('/api/v2/sourceControl/{ownerType}/{internalOwnerId}', headers = headers)

print(r.json())



const headers = {
  'Accept':'*/*'
};

fetch('/api/v2/sourceControl/{ownerType}/{internalOwnerId}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /api/v2/sourceControl/{ownerType}/{internalOwnerId}

Parameters

Name In Type Required Description
ownerType path string true none
internalOwnerId path string true none

Enumerated Values

Parameter Value
ownerType application
ownerType organization
ownerType repository_container
ownerType repository_manager
ownerType repository
ownerType global

Example responses

Responses

Status Meaning Description Schema
default Default default response None

Response Schema

Source Control Metrics

getSourceControl

Code samples

URL obj = new URL("/api/v2/sourceControlMetrics/{ownerType}/{internalOwnerId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/sourceControlMetrics/{ownerType}/{internalOwnerId}', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/sourceControlMetrics/{ownerType}/{internalOwnerId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/sourceControlMetrics/{ownerType}/{internalOwnerId}

Parameters

Name In Type Required Description
ownerType path string true none
internalOwnerId path string true none

Enumerated Values

Parameter Value
ownerType application
ownerType organization
ownerType repository_container
ownerType repository_manager
ownerType repository
ownerType global

Example responses

default Response

{
  "results": [
    {
      "startTime": "2019-08-24T14:15:22Z",
      "title": "string",
      "exceptionThrown": true,
      "successful": true,
      "totalTime": 0,
      "reasoning": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
default Default default response ApiPullRequestResults

Spdx

getByScanId

Code samples

URL obj = new URL("/api/v2/spdx/{applicationId}/reports/{scanId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/xml'
}

r = requests.get('/api/v2/spdx/{applicationId}/reports/{scanId}', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/xml'
};

fetch('/api/v2/spdx/{applicationId}/reports/{scanId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/spdx/{applicationId}/reports/{scanId}

Parameters

Name In Type Required Description
applicationId path string true none
scanId path string true none
format query string false none
generateCycloneDx query boolean false none
spdxVersion query string false none

Example responses

Responses

Status Meaning Description Schema
default Default default response None

Response Schema

getLatestForStage

Code samples

URL obj = new URL("/api/v2/spdx/{applicationId}/stages/{stageId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/xml'
}

r = requests.get('/api/v2/spdx/{applicationId}/stages/{stageId}', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/xml'
};

fetch('/api/v2/spdx/{applicationId}/stages/{stageId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/spdx/{applicationId}/stages/{stageId}

Parameters

Name In Type Required Description
applicationId path string true none
stageId path string true none
format query string false none
generateCycloneDx query boolean false none
spdxVersion query string false none

Example responses

Responses

Status Meaning Description Schema
default Default default response None

Response Schema

Telemetry

postExternalTelemetry

Code samples

URL obj = new URL("/api/v2/telemetry");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'user-agent': 'string'
}

r = requests.post('/api/v2/telemetry', headers = headers)

print(r.json())


const inputBody = '{
  "property1": "string",
  "property2": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*',
  'user-agent':'string'
};

fetch('/api/v2/telemetry',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /api/v2/telemetry

Body parameter

{
  "property1": "string",
  "property2": "string"
}

Parameters

Name In Type Required Description
user-agent header string false none
body body object false none
» additionalProperties body string false none

Example responses

Responses

Status Meaning Description Schema
default Default default response None

Response Schema

User Tokens

createUserToken

Code samples

URL obj = new URL("/api/v2/userTokens/currentUser");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('/api/v2/userTokens/currentUser', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/userTokens/currentUser',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /api/v2/userTokens/currentUser

Example responses

default Response

{
  "userCode": "string",
  "passCode": "string",
  "username": "string",
  "realm": "string"
}

Responses

Status Meaning Description Schema
default Default default response ApiUserTokenDTO

deleteCurrentUserToken

Code samples

URL obj = new URL("/api/v2/userTokens/currentUser");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': '*/*'
}

r = requests.delete('/api/v2/userTokens/currentUser', headers = headers)

print(r.json())



const headers = {
  'Accept':'*/*'
};

fetch('/api/v2/userTokens/currentUser',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /api/v2/userTokens/currentUser

Example responses

Responses

Status Meaning Description Schema
default Default default response None

Response Schema

deleteUserTokenByUserCode

Code samples

URL obj = new URL("/api/v2/userTokens/userCode/{userCode}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': '*/*'
}

r = requests.delete('/api/v2/userTokens/userCode/{userCode}', headers = headers)

print(r.json())



const headers = {
  'Accept':'*/*'
};

fetch('/api/v2/userTokens/userCode/{userCode}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /api/v2/userTokens/userCode/{userCode}

Parameters

Name In Type Required Description
userCode path string true none

Example responses

Responses

Status Meaning Description Schema
default Default default response None

Response Schema

getUserTokenByUsernameAndRealmId

Code samples

URL obj = new URL("/api/v2/userTokens/{username}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/userTokens/{username}', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/userTokens/{username}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/userTokens/{username}

Parameters

Name In Type Required Description
username path string true none
realm query string false none

Example responses

default Response

{
  "userCode": "string",
  "passCode": "string",
  "username": "string",
  "realm": "string"
}

Responses

Status Meaning Description Schema
default Default default response ApiUserTokenDTO

getUserTokenExistsForCurrentUser

Code samples

URL obj = new URL("/api/v2/userTokens/currentUser/hasToken");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/userTokens/currentUser/hasToken', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/userTokens/currentUser/hasToken',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/userTokens/currentUser/hasToken

Example responses

default Response

{
  "userTokenExists": true
}

Responses

Status Meaning Description Schema
default Default default response ApiUserTokenExistsDTO

getUserTokensByCreatedBetweenAndRealmId

Code samples

URL obj = new URL("/api/v2/userTokens");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/userTokens', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/userTokens',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/userTokens

Parameters

Name In Type Required Description
createdAfter query string false none
createdBefore query string false none
realm query string false none

Example responses

default Response

[
  {
    "userCode": "string",
    "passCode": "string",
    "username": "string",
    "realm": "string"
  }
]

Responses

Status Meaning Description Schema
default Default default response Inline

Response Schema

Status Code default

Name Type Required Restrictions Description
anonymous [ApiUserTokenDTO] false none none
» userCode string false none none
» passCode string false none none
» username string false none none
» realm string false none none

purgeUserTokens

Code samples

URL obj = new URL("/api/v2/userTokens/purge");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': '*/*'
}

r = requests.delete('/api/v2/userTokens/purge', headers = headers)

print(r.json())



const headers = {
  'Accept':'*/*'
};

fetch('/api/v2/userTokens/purge',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /api/v2/userTokens/purge

Example responses

Responses

Status Meaning Description Schema
default Default default response None

Response Schema

Users

getAll_2

Code samples

URL obj = new URL("/api/v2/users");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/users', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/users',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/users

Parameters

Name In Type Required Description
realm query string false none

Example responses

default Response

{
  "users": [
    {
      "username": "string",
      "password": "string",
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "realm": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
default Default default response ApiUserListDTO

add

Code samples

URL obj = new URL("/api/v2/users");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*'
}

r = requests.post('/api/v2/users', headers = headers)

print(r.json())


const inputBody = '{
  "username": "string",
  "password": "string",
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "realm": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*'
};

fetch('/api/v2/users',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /api/v2/users

Body parameter

{
  "username": "string",
  "password": "string",
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "realm": "string"
}

Parameters

Name In Type Required Description
body body ApiUserDTO false none

Example responses

Responses

Status Meaning Description Schema
default Default default response None

Response Schema

get_1

Code samples

URL obj = new URL("/api/v2/users/{username}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/users/{username}', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/users/{username}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/users/{username}

Parameters

Name In Type Required Description
username path string true none
realm query string false none

Example responses

default Response

{
  "username": "string",
  "password": "string",
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "realm": "string"
}

Responses

Status Meaning Description Schema
default Default default response ApiUserDTO

update

Code samples

URL obj = new URL("/api/v2/users/{username}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('/api/v2/users/{username}', headers = headers)

print(r.json())


const inputBody = '{
  "username": "string",
  "password": "string",
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "realm": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/api/v2/users/{username}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /api/v2/users/{username}

Body parameter

{
  "username": "string",
  "password": "string",
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "realm": "string"
}

Parameters

Name In Type Required Description
username path string true none
body body ApiUserDTO false none

Example responses

default Response

{
  "username": "string",
  "password": "string",
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "realm": "string"
}

Responses

Status Meaning Description Schema
default Default default response ApiUserDTO

delete_1

Code samples

URL obj = new URL("/api/v2/users/{username}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': '*/*'
}

r = requests.delete('/api/v2/users/{username}', headers = headers)

print(r.json())



const headers = {
  'Accept':'*/*'
};

fetch('/api/v2/users/{username}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /api/v2/users/{username}

Parameters

Name In Type Required Description
username path string true none
realm query string false none

Example responses

Responses

Status Meaning Description Schema
default Default default response None

Response Schema

Vulnerabilities

getSecurityVulnerabilityDetails

Code samples

URL obj = new URL("/api/v2/vulnerabilities/{refId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/vulnerabilities/{refId}', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/vulnerabilities/{refId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/vulnerabilities/{refId}

Parameters

Name In Type Required Description
refId path string true none
componentIdentifier query ComponentIdentifier false none
identificationSource query string false none
scanId query string false none
ownerType query string false none
ownerId query string false none

Enumerated Values

Parameter Value
ownerType application
ownerType organization
ownerType repository_container
ownerType repository_manager
ownerType repository
ownerType global

Example responses

default Response

{
  "identifier": "string",
  "vulnIds": [
    "string"
  ],
  "vulnerabilityLink": "http://example.com",
  "source": {
    "shortName": "string",
    "longName": "string"
  },
  "mainSeverity": {
    "source": "string",
    "sourceLabel": "string",
    "score": 0.1,
    "vector": "string"
  },
  "severityScores": [
    {
      "source": "string",
      "sourceLabel": "string",
      "score": 0.1,
      "vector": "string"
    }
  ],
  "weakness": {
    "cweSource": "string",
    "cweIds": [
      {
        "id": "string",
        "uri": "http://example.com"
      }
    ]
  },
  "categories": [
    "string"
  ],
  "description": "string",
  "explanationMarkdown": "string",
  "componentExplanationMarkdown": "string",
  "detectionMarkdown": "string",
  "componentDetectionMarkdown": "string",
  "recommendationMarkdown": "string",
  "componentRecommendationMarkdown": "string",
  "rootCauses": [
    {
      "listOfPaths": [
        "string"
      ],
      "versionRange": "string"
    }
  ],
  "advisories": [
    {
      "referenceType": "string",
      "url": "string"
    }
  ],
  "vulnerableVersionRanges": [
    "string"
  ],
  "researchType": "FAST_TRACK",
  "isAdvancedVulnerabilityDetection": true,
  "customData": {
    "remediation": "string",
    "cweId": "string",
    "cvssVector": "string",
    "cvssSeverity": 0.1
  }
}

Responses

Status Meaning Description Schema
default Default default response SecurityVulnerabilityData

sbom

Gets a sbom version

Code samples

URL obj = new URL("/api/v2/sbom/applications/{applicationId}/versions/{version}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json|application/xml',
  'Accept': 'string'
}

r = requests.get('/api/v2/sbom/applications/{applicationId}/versions/{version}', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json|application/xml',
  'Accept':'string'
};

fetch('/api/v2/sbom/applications/{applicationId}/versions/{version}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/sbom/applications/{applicationId}/versions/{version}

Downloads a specific sbom version in its original or current form

Parameters

Name In Type Required Description
applicationId path string true The internal id of the application
version path string true URL Encoded version value of the sbom
state query string false The state of the sbom version. Allowed values [original
specification query string false Target specification of the sbom. Allowed values [cyclonedx1.5
Accept header string false Output format(json/xml) of the sbom. Changing the output format only applicable when downloading the current form of the SBOM. The original sbom will always return in the original form that it was ingested. When requesting current form and if this header value is not present the sbom will be returned in its original ingested format. Allowed values {'application/json'

Example responses

Responses

Status Meaning Description Schema
200 OK Content of the sbom None
404 Not Found Supplied sbom version not found None

Response Schema

Delete sbom version

Code samples

URL obj = new URL("/api/v2/sbom/applications/{applicationId}/versions/{version}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests

r = requests.delete('/api/v2/sbom/applications/{applicationId}/versions/{version}')

print(r.json())



fetch('/api/v2/sbom/applications/{applicationId}/versions/{version}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /api/v2/sbom/applications/{applicationId}/versions/{version}

Deletes a specific sbom version including it's original contents and updates

Parameters

Name In Type Required Description
applicationId path string true The internal id of the application
version path string true URL Encoded version value of the sbom to be deleted

Responses

Status Meaning Description Schema
204 No Content Delete successful None
404 Not Found Supplied sbom version not found None

Gets a list of active sbom versions by application id

Code samples

URL obj = new URL("/api/v2/sbom/applications/{applicationId}/versions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/sbom/applications/{applicationId}/versions', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/sbom/applications/{applicationId}/versions',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/sbom/applications/{applicationId}/versions

Gets a list of active sbom versions by application id

Parameters

Name In Type Required Description
applicationId path string true The internal id of the application

Example responses

Responses

Status Meaning Description Schema
200 OK list of the active sbom versions by application id None

Response Schema

Get sbom import status

Code samples

URL obj = new URL("/api/v2/sbom/applications/{applicationId}/status/{importRequestId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/sbom/applications/{applicationId}/status/{importRequestId}', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/sbom/applications/{applicationId}/status/{importRequestId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/sbom/applications/{applicationId}/status/{importRequestId}

Gets status of a sbom import.

Parameters

Name In Type Required Description
applicationId path string true The internal id of the application
importRequestId path string true The id of the import request

Example responses

Responses

Status Meaning Description Schema
200 OK Sbom import completed successfully. None
404 Not Found Sbom import still in progress. None

Response Schema

Gets the components found in a specific sbom version

Code samples

URL obj = new URL("/api/v2/sbom/applications/{applicationId}/versions/{version}/components");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/sbom/applications/{applicationId}/versions/{version}/components', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/sbom/applications/{applicationId}/versions/{version}/components',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/sbom/applications/{applicationId}/versions/{version}/components

Lists the components in a specific sbom version with data about vulnerabilities and licenses

Parameters

Name In Type Required Description
applicationId path string true The internal id of the application
version path string true URL Encoded version value of the sbom to query its components
vulnerabilityThreatLevels query array[string] false If provided, filter components by the given threat level on their vulnerabilities
dependencyTypes query array[string] false If provided, filter components by the given dependency types
sortBy query string false Criteria to sort the results. default = VULNERABILITIES
asc query boolean false Order mode ASC=true or DESC=false. default = false
page query integer(int32) false Current page number. default = 1
pageSize query integer(int32) false Number of items to return by page. default = 50

Enumerated Values

Parameter Value
vulnerabilityThreatLevels NONE
vulnerabilityThreatLevels LOW
vulnerabilityThreatLevels MEDIUM
vulnerabilityThreatLevels HIGH
vulnerabilityThreatLevels CRITICAL
dependencyTypes DIRECT
dependencyTypes TRANSITIVE
dependencyTypes UNSPECIFIED
sortBy TYPE
sortBy PERCENTAGE_ANNOTATED
sortBy VULNERABILITIES

Example responses

Responses

Status Meaning Description Schema
200 OK List of components in the sbom None

Response Schema

Gets a paginated list of SBOMs for an application

Code samples

URL obj = new URL("/api/v2/sbom/applications/{applicationId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/sbom/applications/{applicationId}', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/sbom/applications/{applicationId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/sbom/applications/{applicationId}

Gets a paginated list of SBOMs for an application

Parameters

Name In Type Required Description
applicationId path string true The internal id of the application
sortByDate query string false Sort results by import date. Allowed values [asc
pageSize query integer(int32) false Number of items to return by page. default = 10
page query integer(int32) false Current page number. default = 1

Example responses

Responses

Status Meaning Description Schema
200 OK list of the sboms None

Response Schema

Import a new sbom version

Code samples

URL obj = new URL("/api/v2/sbom/import");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Content-Type': '*/*',
  'Accept': 'application/json'
}

r = requests.post('/api/v2/sbom/import', headers = headers)

print(r.json())


const inputBody = '{
  "applicationId": "string",
  "file": {}
}';
const headers = {
  'Content-Type':'*/*',
  'Accept':'application/json'
};

fetch('/api/v2/sbom/import',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /api/v2/sbom/import

Imports a new sbom version to an existing application

Body parameter

Parameters

Name In Type Required Description
body body object false none
» applicationId body string true The internal id of the application
» file body object false none

Example responses

Responses

Status Meaning Description Schema
202 Accepted Import successful. URL to check the status of the import returned None
400 Bad Request Invalid/Unsupported data provided for sbom import None

Response Schema

Updates a vulnerability analysis annotation for a specific SBOM vulnerability

Code samples

URL obj = new URL("/api/v2/sbom/applications/{applicationId}/versions/{version}/vulnerability/{refId}/analysis");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('/api/v2/sbom/applications/{applicationId}/versions/{version}/vulnerability/{refId}/analysis', headers = headers)

print(r.json())


const inputBody = '{
  "componentLocator": {
    "hash": "string",
    "packageUrl": "string"
  },
  "vulnerabilityAnalysis": {
    "state": "resolved",
    "justification": "code_not_present",
    "response": "can_not_fix",
    "detail": "string"
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/api/v2/sbom/applications/{applicationId}/versions/{version}/vulnerability/{refId}/analysis',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /api/v2/sbom/applications/{applicationId}/versions/{version}/vulnerability/{refId}/analysis

Updates a vulnerability analysis annotation for a specific SBOM vulnerability

Body parameter

{
  "componentLocator": {
    "hash": "string",
    "packageUrl": "string"
  },
  "vulnerabilityAnalysis": {
    "state": "resolved",
    "justification": "code_not_present",
    "response": "can_not_fix",
    "detail": "string"
  }
}

Parameters

Name In Type Required Description
applicationId path string true The internal id of the application
version path string true The version for a specific SBOM where the vulnerability is present
refId path string true The vulnerability id of a vulnerability
body body SBOM vulnerability analysis request true Vulnerability analysis details with component information

Example responses

Responses

Status Meaning Description Schema
200 OK Vulnerability analysis annotation updated successfully None
404 Not Found Target vulnerability not found None

Response Schema

sbom dashboard

Gets application history metrics

Code samples

URL obj = new URL("/api/v2/sbom/dashboard/sbomsHistoryMetrics");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/sbom/dashboard/sbomsHistoryMetrics', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/sbom/dashboard/sbomsHistoryMetrics',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/sbom/dashboard/sbomsHistoryMetrics

Queries how many SBOMs applications have been analyzed

Example responses

Responses

Status Meaning Description Schema
200 OK Total of SBOMs applications analyzed None

Response Schema

Gets total of SBOMs analyzed and the threshold in the product license

Code samples

URL obj = new URL("/api/v2/sbom/dashboard/sbomsAnalyzed");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/sbom/dashboard/sbomsAnalyzed', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/sbom/dashboard/sbomsAnalyzed',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/sbom/dashboard/sbomsAnalyzed

Queries how many SBOMs have been analyzed and the threshold in the product license

Example responses

Responses

Status Meaning Description Schema
200 OK Total of SBOMs analyzed and the threshold in the product license None

Response Schema

Gets counters of vulnerabilities and annotations by threat level

Code samples

URL obj = new URL("/api/v2/sbom/dashboard/vulnerabilitiesByThreatLevel");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/sbom/dashboard/vulnerabilitiesByThreatLevel', headers = headers)

print(r.json())



const headers = {
  'Accept':'application/json'
};

fetch('/api/v2/sbom/dashboard/vulnerabilitiesByThreatLevel',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /api/v2/sbom/dashboard/vulnerabilitiesByThreatLevel

Queries how many vulnerabilities and annotations have been found by each threat level

Example responses

Responses

Status Meaning Description Schema
200 OK Counters of vulnerabilities and annotations by threat level None

Response Schema

Schemas

ApiComponentIdentifierDTOV2

{
  "format": "string",
  "coordinates": {
    "property1": "string",
    "property2": "string"
  }
}

Properties

Name Type Required Restrictions Description
format string false none none
coordinates object false none none
» additionalProperties string false none none

GroupingByDTO

{
  "groupIdentifier": "itemType",
  "groupBy": "string",
  "additionalInfo": "string",
  "searchResultItemDTOS": [
    {
      "itemType": "string",
      "organizationId": "string",
      "organizationName": "string",
      "applicationId": "string",
      "applicationPublicId": "string",
      "applicationName": "string",
      "applicationVersion": "string",
      "sbomSpecification": "string",
      "policyEvaluationStage": "string",
      "reportId": "string",
      "componentHash": "string",
      "componentIdentifier": {
        "format": "string",
        "coordinates": {
          "property1": "string",
          "property2": "string"
        }
      },
      "componentName": "string",
      "vulnerabilityId": "string",
      "vulnerabilityDescription": "string",
      "vulnerabilityStatus": "string",
      "applicationCategoryId": "string",
      "applicationCategoryName": "string",
      "applicationCategoryColor": "string",
      "applicationCategoryDescription": "string",
      "componentLabelId": "string",
      "componentLabelName": "string",
      "componentLabelColor": "string",
      "componentLabelDescription": "string",
      "policyId": "string",
      "policyName": "string",
      "policyThreatCategory": "string",
      "policyThreatLevel": 0,
      "resultIndex": 0
    }
  ]
}

Properties

Name Type Required Restrictions Description
groupIdentifier string false none none
groupBy string false none none
additionalInfo string false none none
searchResultItemDTOS [SearchResultItemDTO] false none none

Enumerated Values

Property Value
groupIdentifier itemType
groupIdentifier organizationId
groupIdentifier organizationName
groupIdentifier applicationId
groupIdentifier applicationName
groupIdentifier applicationPublicId
groupIdentifier policyEvaluationStage
groupIdentifier applicationVersion
groupIdentifier reportId
groupIdentifier componentHash
groupIdentifier componentFormat
groupIdentifier componentName
groupIdentifier componentCoordinate
groupIdentifier vulnerabilityId
groupIdentifier vulnerabilitySeverity
groupIdentifier vulnerabilityStatus
groupIdentifier vulnerabilityDescription
groupIdentifier applicationCategoryId
groupIdentifier applicationCategoryName
groupIdentifier applicationCategoryColor
groupIdentifier applicationCategoryDescription
groupIdentifier componentLabelId
groupIdentifier componentLabelName
groupIdentifier componentLabelColor
groupIdentifier componentLabelDescription
groupIdentifier policyId
groupIdentifier policyName
groupIdentifier policyThreatCategory
groupIdentifier policyThreatLevel
groupIdentifier parentOrganizationName
groupIdentifier parentOrganizationId
groupIdentifier sbomSpecification

SearchResultDTO

{
  "searchQuery": "string",
  "page": 0,
  "pageSize": 0,
  "totalNumberOfHits": 0,
  "isExactTotalNumberOfHits": true,
  "groupingByDTOS": [
    {
      "groupIdentifier": "itemType",
      "groupBy": "string",
      "additionalInfo": "string",
      "searchResultItemDTOS": [
        {
          "itemType": "string",
          "organizationId": "string",
          "organizationName": "string",
          "applicationId": "string",
          "applicationPublicId": "string",
          "applicationName": "string",
          "applicationVersion": "string",
          "sbomSpecification": "string",
          "policyEvaluationStage": "string",
          "reportId": "string",
          "componentHash": "string",
          "componentIdentifier": {
            "format": "string",
            "coordinates": {
              "property1": "string",
              "property2": "string"
            }
          },
          "componentName": "string",
          "vulnerabilityId": "string",
          "vulnerabilityDescription": "string",
          "vulnerabilityStatus": "string",
          "applicationCategoryId": "string",
          "applicationCategoryName": "string",
          "applicationCategoryColor": "string",
          "applicationCategoryDescription": "string",
          "componentLabelId": "string",
          "componentLabelName": "string",
          "componentLabelColor": "string",
          "componentLabelDescription": "string",
          "policyId": "string",
          "policyName": "string",
          "policyThreatCategory": "string",
          "policyThreatLevel": 0,
          "resultIndex": 0
        }
      ]
    }
  ]
}

Properties

Name Type Required Restrictions Description
searchQuery string false none none
page integer(int32) false none none
pageSize integer(int32) false none none
totalNumberOfHits integer(int32) false none none
isExactTotalNumberOfHits boolean false none none
groupingByDTOS [GroupingByDTO] false none none

SearchResultItemDTO

{
  "itemType": "string",
  "organizationId": "string",
  "organizationName": "string",
  "applicationId": "string",
  "applicationPublicId": "string",
  "applicationName": "string",
  "applicationVersion": "string",
  "sbomSpecification": "string",
  "policyEvaluationStage": "string",
  "reportId": "string",
  "componentHash": "string",
  "componentIdentifier": {
    "format": "string",
    "coordinates": {
      "property1": "string",
      "property2": "string"
    }
  },
  "componentName": "string",
  "vulnerabilityId": "string",
  "vulnerabilityDescription": "string",
  "vulnerabilityStatus": "string",
  "applicationCategoryId": "string",
  "applicationCategoryName": "string",
  "applicationCategoryColor": "string",
  "applicationCategoryDescription": "string",
  "componentLabelId": "string",
  "componentLabelName": "string",
  "componentLabelColor": "string",
  "componentLabelDescription": "string",
  "policyId": "string",
  "policyName": "string",
  "policyThreatCategory": "string",
  "policyThreatLevel": 0,
  "resultIndex": 0
}

Properties

Name Type Required Restrictions Description
itemType string false none none
organizationId string false none none
organizationName string false none none
applicationId string false none none
applicationPublicId string false none none
applicationName string false none none
applicationVersion string false none none
sbomSpecification string false none none
policyEvaluationStage string false none none
reportId string false none none
componentHash string false none none
componentIdentifier ApiComponentIdentifierDTOV2 false none none
componentName string false none none
vulnerabilityId string false none none
vulnerabilityDescription string false none none
vulnerabilityStatus string false none none
applicationCategoryId string false none none
applicationCategoryName string false none none
applicationCategoryColor string false none none
applicationCategoryDescription string false none none
componentLabelId string false none none
componentLabelName string false none none
componentLabelColor string false none none
componentLabelDescription string false none none
policyId string false none none
policyName string false none none
policyThreatCategory string false none none
policyThreatLevel integer(int32) false none none
resultIndex integer(int32) false none none

ApiApplicationCategoryDTO

{
  "id": "string",
  "name": "string",
  "description": "string",
  "organizationId": "string",
  "color": "string"
}

Properties

Name Type Required Restrictions Description
id string false none none
name string false none none
description string false none none
organizationId string false none none
color string false none none

ApplicableTagsDTO

{
  "applicationCategoriesByOwner": [
    {
      "ownerId": "string",
      "ownerName": "string",
      "ownerType": "application",
      "applicationCategories": [
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "organizationId": "string",
          "color": "string"
        }
      ]
    }
  ]
}

Properties

Name Type Required Restrictions Description
applicationCategoriesByOwner [TagsByOwnerDTO] false none none

TagsByOwnerDTO

{
  "ownerId": "string",
  "ownerName": "string",
  "ownerType": "application",
  "applicationCategories": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "organizationId": "string",
      "color": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
ownerId string false none none
ownerName string false none none
ownerType string false none none
applicationCategories [ApiApplicationCategoryDTO] false none none

Enumerated Values

Property Value
ownerType application
ownerType organization
ownerType repository_container
ownerType repository_manager
ownerType repository
ownerType global

PolicyTag

{
  "id": "string",
  "policyId": "string",
  "tagId": "string"
}

Properties

Name Type Required Restrictions Description
id string false none none
policyId string false none none
tagId string false none none

ApplicationTag

{
  "id": "string",
  "applicationId": "string",
  "tagId": "string"
}

Properties

Name Type Required Restrictions Description
id string false none none
applicationId string false none none
tagId string false none none

ApplicationTagsByOwnerDTO

{
  "ownerId": "string",
  "ownerName": "string",
  "ownerType": "application",
  "applicationTags": [
    {
      "id": "string",
      "applicationId": "string",
      "tagId": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
ownerId string false none none
ownerName string false none none
ownerType string false none none
applicationTags [ApplicationTag] false none none

Enumerated Values

Property Value
ownerType application
ownerType organization
ownerType repository_container
ownerType repository_manager
ownerType repository
ownerType global

AppliedTagsDTO

{
  "applicationTagsByOwner": [
    {
      "ownerId": "string",
      "ownerName": "string",
      "ownerType": "application",
      "applicationTags": [
        {
          "id": "string",
          "applicationId": "string",
          "tagId": "string"
        }
      ]
    }
  ]
}

Properties

Name Type Required Restrictions Description
applicationTagsByOwner [ApplicationTagsByOwnerDTO] false none none

ApiApplicationDTO

{
  "id": "string",
  "publicId": "string",
  "name": "string",
  "organizationId": "string",
  "contactUserName": "string",
  "applicationTags": [
    {
      "id": "string",
      "tagId": "string",
      "applicationId": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
id string false none none
publicId string false none none
name string false none none
organizationId string false none none
contactUserName string false none none
applicationTags [ApiApplicationTagDTO] false none none

ApiApplicationTagDTO

{
  "id": "string",
  "tagId": "string",
  "applicationId": "string"
}

Properties

Name Type Required Restrictions Description
id string false none none
tagId string false none none
applicationId string false none none

ApiApplicationListDTO

{
  "applications": [
    {
      "id": "string",
      "publicId": "string",
      "name": "string",
      "organizationId": "string",
      "contactUserName": "string",
      "applicationTags": [
        {
          "id": "string",
          "tagId": "string",
          "applicationId": "string"
        }
      ]
    }
  ]
}

Properties

Name Type Required Restrictions Description
applications [ApiApplicationDTO] false none none

ApiMoveApplicationResponseDTOV2

{
  "warnings": [
    "string"
  ],
  "errors": [
    "string"
  ]
}

Properties

Name Type Required Restrictions Description
warnings [string] false none none
errors [string] false none none

ApiComponentDTOV2

{
  "packageUrl": "string",
  "hash": "string",
  "sha256": "string",
  "componentIdentifier": {
    "format": "string",
    "coordinates": {
      "property1": "string",
      "property2": "string"
    }
  },
  "displayName": "string",
  "proprietary": true,
  "thirdParty": true
}

Properties

Name Type Required Restrictions Description
packageUrl string false none none
hash string false none none
sha256 string false none none
componentIdentifier ApiComponentIdentifierDTOV2 false none none
displayName string false none none
proprietary boolean false none none
thirdParty boolean false none none

ApiComponentDetailsDTOV2

{
  "component": {
    "packageUrl": "string",
    "hash": "string",
    "sha256": "string",
    "componentIdentifier": {
      "format": "string",
      "coordinates": {
        "property1": "string",
        "property2": "string"
      }
    },
    "displayName": "string",
    "proprietary": true,
    "thirdParty": true
  },
  "matchState": "string",
  "catalogDate": "2019-08-24T14:15:22Z",
  "relativePopularity": 0,
  "licenseData": {
    "declaredLicenses": [
      {
        "licenseId": "string",
        "licenseName": "string"
      }
    ],
    "observedLicenses": [
      {
        "licenseId": "string",
        "licenseName": "string"
      }
    ],
    "effectiveLicenses": [
      {
        "licenseId": "string",
        "licenseName": "string"
      }
    ],
    "overriddenLicenses": [
      {
        "licenseId": "string",
        "licenseName": "string"
      }
    ],
    "status": "string"
  },
  "integrityRating": "string",
  "hygieneRating": "string",
  "securityData": {
    "securityIssues": [
      {
        "source": "string",
        "reference": "string",
        "severity": 0.1,
        "status": "string",
        "url": "string",
        "threatCategory": "string",
        "cwe": "string",
        "cvssVector": "string",
        "cvssVectorSource": "string",
        "analysis": {
          "state": "string",
          "justification": "string",
          "response": "string",
          "detail": "string"
        }
      }
    ]
  },
  "policyData": {
    "policyViolations": [
      {
        "policyId": "string",
        "policyName": "string",
        "policyViolationId": "string",
        "threatLevel": 0,
        "constraintViolations": [
          {
            "constraintId": "string",
            "constraintName": "string",
            "reasons": [
              {
                "reason": "string",
                "reference": {
                  "value": "string",
                  "type": "SECURITY_VULNERABILITY_REFID"
                }
              }
            ]
          }
        ]
      }
    ]
  },
  "projectData": {
    "firstReleaseDate": "2019-08-24T14:15:22Z",
    "lastReleaseDate": "2019-08-24T14:15:22Z",
    "projectMetadata": {
      "description": "string",
      "organization": "string"
    },
    "sourceControlManagement": {
      "scmUrl": "string",
      "scmMetadata": {
        "stars": 0,
        "forks": 0
      },
      "scmDetails": {
        "commitsPerMonth": 0,
        "uniqueDevsPerMonth": 0
      }
    }
  }
}

Properties

Name Type Required Restrictions Description
component ApiComponentDTOV2 false none none
matchState string false none none
catalogDate string(date-time) false none none
relativePopularity integer(int32) false none none
licenseData ApiLicenseDataDTO false none none
integrityRating string false none none
hygieneRating string false none none
securityData ApiSecurityDataDTO false none none
policyData ApiComponentPolicyViolationListDTOV2 false none none
projectData ApiComponentProjectDataDTO false none none

ApiComponentDetailsResultDTOV2

{
  "componentDetails": [
    {
      "component": {
        "packageUrl": "string",
        "hash": "string",
        "sha256": "string",
        "componentIdentifier": {
          "format": "string",
          "coordinates": {
            "property1": "string",
            "property2": "string"
          }
        },
        "displayName": "string",
        "proprietary": true,
        "thirdParty": true
      },
      "matchState": "string",
      "catalogDate": "2019-08-24T14:15:22Z",
      "relativePopularity": 0,
      "licenseData": {
        "declaredLicenses": [
          {
            "licenseId": "string",
            "licenseName": "string"
          }
        ],
        "observedLicenses": [
          {
            "licenseId": "string",
            "licenseName": "string"
          }
        ],
        "effectiveLicenses": [
          {
            "licenseId": "string",
            "licenseName": "string"
          }
        ],
        "overriddenLicenses": [
          {
            "licenseId": "string",
            "licenseName": "string"
          }
        ],
        "status": "string"
      },
      "integrityRating": "string",
      "hygieneRating": "string",
      "securityData": {
        "securityIssues": [
          {
            "source": "string",
            "reference": "string",
            "severity": 0.1,
            "status": "string",
            "url": "string",
            "threatCategory": "string",
            "cwe": "string",
            "cvssVector": "string",
            "cvssVectorSource": "string",
            "analysis": {
              "state": "string",
              "justification": "string",
              "response": "string",
              "detail": "string"
            }
          }
        ]
      },
      "policyData": {
        "policyViolations": [
          {
            "policyId": "string",
            "policyName": "string",
            "policyViolationId": "string",
            "threatLevel": 0,
            "constraintViolations": [
              {
                "constraintId": "string",
                "constraintName": "string",
                "reasons": [
                  {
                    "reason": "string",
                    "reference": {}
                  }
                ]
              }
            ]
          }
        ]
      },
      "projectData": {
        "firstReleaseDate": "2019-08-24T14:15:22Z",
        "lastReleaseDate": "2019-08-24T14:15:22Z",
        "projectMetadata": {
          "description": "string",
          "organization": "string"
        },
        "sourceControlManagement": {
          "scmUrl": "string",
          "scmMetadata": {
            "stars": 0,
            "forks": 0
          },
          "scmDetails": {
            "commitsPerMonth": 0,
            "uniqueDevsPerMonth": 0
          }
        }
      }
    }
  ]
}

Properties

Name Type Required Restrictions Description
componentDetails [ApiComponentDetailsDTOV2] false none none

ApiComponentPolicyViolationListDTOV2

{
  "policyViolations": [
    {
      "policyId": "string",
      "policyName": "string",
      "policyViolationId": "string",
      "threatLevel": 0,
      "constraintViolations": [
        {
          "constraintId": "string",
          "constraintName": "string",
          "reasons": [
            {
              "reason": "string",
              "reference": {
                "value": "string",
                "type": "SECURITY_VULNERABILITY_REFID"
              }
            }
          ]
        }
      ]
    }
  ]
}

Properties

Name Type Required Restrictions Description
policyViolations [ApiPolicyViolationDTOV2] false none none

ApiComponentProjectDataDTO

{
  "firstReleaseDate": "2019-08-24T14:15:22Z",
  "lastReleaseDate": "2019-08-24T14:15:22Z",
  "projectMetadata": {
    "description": "string",
    "organization": "string"
  },
  "sourceControlManagement": {
    "scmUrl": "string",
    "scmMetadata": {
      "stars": 0,
      "forks": 0
    },
    "scmDetails": {
      "commitsPerMonth": 0,
      "uniqueDevsPerMonth": 0
    }
  }
}

Properties

Name Type Required Restrictions Description
firstReleaseDate string(date-time) false none none
lastReleaseDate string(date-time) false none none
projectMetadata ApiComponentProjectMetadataDTO false none none
sourceControlManagement ApiComponentProjectScmDTO false none none

ApiComponentProjectMetadataDTO

{
  "description": "string",
  "organization": "string"
}

Properties

Name Type Required Restrictions Description
description string false none none
organization string false none none

ApiComponentProjectScmDTO

{
  "scmUrl": "string",
  "scmMetadata": {
    "stars": 0,
    "forks": 0
  },
  "scmDetails": {
    "commitsPerMonth": 0,
    "uniqueDevsPerMonth": 0
  }
}

Properties

Name Type Required Restrictions Description
scmUrl string false none none
scmMetadata ApiComponentProjectScmMetadataDTO false none none
scmDetails ApiComponentProjectScmDetailsDTO false none none

ApiComponentProjectScmDetailsDTO

{
  "commitsPerMonth": 0,
  "uniqueDevsPerMonth": 0
}

Properties

Name Type Required Restrictions Description
commitsPerMonth integer(int32) false none none
uniqueDevsPerMonth integer(int32) false none none

ApiComponentProjectScmMetadataDTO

{
  "stars": 0,
  "forks": 0
}

Properties

Name Type Required Restrictions Description
stars integer(int32) false none none
forks integer(int32) false none none

ApiConstraintViolationDTO

{
  "constraintId": "string",
  "constraintName": "string",
  "reasons": [
    {
      "reason": "string",
      "reference": {
        "value": "string",
        "type": "SECURITY_VULNERABILITY_REFID"
      }
    }
  ]
}

Properties

Name Type Required Restrictions Description
constraintId string false none none
constraintName string false none none
reasons [ApiConstraintViolationReasonDTO] false none none

ApiConstraintViolationReasonDTO

{
  "reason": "string",
  "reference": {
    "value": "string",
    "type": "SECURITY_VULNERABILITY_REFID"
  }
}

Properties

Name Type Required Restrictions Description
reason string false none none
reference TriggerReference false none none

ApiLicenseDTO

{
  "licenseId": "string",
  "licenseName": "string"
}

Properties

Name Type Required Restrictions Description
licenseId string false none none
licenseName string false none none

ApiLicenseDataDTO

{
  "declaredLicenses": [
    {
      "licenseId": "string",
      "licenseName": "string"
    }
  ],
  "observedLicenses": [
    {
      "licenseId": "string",
      "licenseName": "string"
    }
  ],
  "effectiveLicenses": [
    {
      "licenseId": "string",
      "licenseName": "string"
    }
  ],
  "overriddenLicenses": [
    {
      "licenseId": "string",
      "licenseName": "string"
    }
  ],
  "status": "string"
}

Properties

Name Type Required Restrictions Description
declaredLicenses [ApiLicenseDTO] false none none
observedLicenses [ApiLicenseDTO] false none none
effectiveLicenses [ApiLicenseDTO] false none none
overriddenLicenses [ApiLicenseDTO] false none none
status string false none none

ApiPolicyViolationDTOV2

{
  "policyId": "string",
  "policyName": "string",
  "policyViolationId": "string",
  "threatLevel": 0,
  "constraintViolations": [
    {
      "constraintId": "string",
      "constraintName": "string",
      "reasons": [
        {
          "reason": "string",
          "reference": {
            "value": "string",
            "type": "SECURITY_VULNERABILITY_REFID"
          }
        }
      ]
    }
  ]
}

Properties

Name Type Required Restrictions Description
policyId string false none none
policyName string false none none
policyViolationId string false none none
threatLevel integer(int32) false none none
constraintViolations [ApiConstraintViolationDTO] false none none

ApiSecurityDataDTO

{
  "securityIssues": [
    {
      "source": "string",
      "reference": "string",
      "severity": 0.1,
      "status": "string",
      "url": "string",
      "threatCategory": "string",
      "cwe": "string",
      "cvssVector": "string",
      "cvssVectorSource": "string",
      "analysis": {
        "state": "string",
        "justification": "string",
        "response": "string",
        "detail": "string"
      }
    }
  ]
}

Properties

Name Type Required Restrictions Description
securityIssues [ApiSecurityIssueDTO] false none none

ApiSecurityIssueAnalysisDTO

{
  "state": "string",
  "justification": "string",
  "response": "string",
  "detail": "string"
}

Properties

Name Type Required Restrictions Description
state string false none none
justification string false none none
response string false none none
detail string false none none

ApiSecurityIssueDTO

{
  "source": "string",
  "reference": "string",
  "severity": 0.1,
  "status": "string",
  "url": "string",
  "threatCategory": "string",
  "cwe": "string",
  "cvssVector": "string",
  "cvssVectorSource": "string",
  "analysis": {
    "state": "string",
    "justification": "string",
    "response": "string",
    "detail": "string"
  }
}

Properties

Name Type Required Restrictions Description
source string false none none
reference string false none none
severity number(float) false none none
status string false none none
url string false none none
threatCategory string false none none
cwe string false none none
cvssVector string false none none
cvssVectorSource string false none none
analysis ApiSecurityIssueAnalysisDTO false none none

TriggerReference

{
  "value": "string",
  "type": "SECURITY_VULNERABILITY_REFID"
}

Properties

Name Type Required Restrictions Description
value string false none none
type string false none none

Enumerated Values

Property Value
type SECURITY_VULNERABILITY_REFID

ApiComponentDetailsRequestDTOV2

{
  "components": [
    {
      "packageUrl": "string",
      "hash": "string",
      "sha256": "string",
      "componentIdentifier": {
        "format": "string",
        "coordinates": {
          "property1": "string",
          "property2": "string"
        }
      },
      "displayName": "string",
      "proprietary": true,
      "thirdParty": true
    }
  ]
}

Properties

Name Type Required Restrictions Description
components [ApiComponentDTOV2] false none none

ApiComponentReleasedFromQuarantineDTO

{
  "componentReleasedFromQuarantine": {
    "component": {
      "packageUrl": "string",
      "hash": "string",
      "sha256": "string",
      "componentIdentifier": {
        "format": "string",
        "coordinates": {
          "property1": "string",
          "property2": "string"
        }
      },
      "displayName": "string",
      "thirdParty": true,
      "quarantineId": "string",
      "quarantineTime": "2019-08-24T14:15:22Z",
      "quarantineReleaseTime": "2019-08-24T14:15:22Z"
    },
    "waivedPolicyViolations": [
      {
        "policyId": "string",
        "policyName": "string",
        "policyViolationId": "string",
        "threatLevel": 0,
        "constraintViolations": [
          {
            "constraintId": "string",
            "constraintName": "string",
            "reasons": [
              {
                "reason": "string",
                "reference": {
                  "value": "string",
                  "type": "SECURITY_VULNERABILITY_REFID"
                }
              }
            ]
          }
        ],
        "policyWaiver": {
          "policyWaiverId": "string",
          "policyViolationId": "string",
          "comment": "string",
          "createTime": "2019-08-24T14:15:22Z",
          "expiryTime": "2019-08-24T14:15:22Z",
          "isObsolete": true,
          "scopeOwnerType": "string",
          "scopeOwnerId": "string",
          "scopeOwnerName": "string",
          "hash": "string",
          "policyId": "string",
          "vulnerabilityId": "string",
          "policyName": "string",
          "constraintFacts": [
            {
              "constraintId": "string",
              "constraintName": "string",
              "operatorName": "string",
              "conditionFacts": [
                {
                  "conditionTypeId": "string",
                  "conditionIndex": 0,
                  "summary": "string",
                  "reason": "string",
                  "reference": {
                    "value": "string",
                    "type": "SECURITY_VULNERABILITY_REFID"
                  },
                  "triggerJson": "string"
                }
              ]
            }
          ],
          "constraintFactsJson": "string",
          "componentName": "string",
          "creatorId": "string",
          "creatorName": "string",
          "matcherStrategy": "DEFAULT",
          "associatedPackageUrl": "string",
          "componentIdentifier": {
            "format": "string",
            "coordinates": {
              "property1": "string",
              "property2": "string"
            }
          },
          "threatLevel": 0,
          "componentUpgradeAvailable": true,
          "displayName": {
            "parts": [
              {
                "field": "string",
                "value": "string"
              }
            ],
            "name": "string"
          }
        }
      }
    ],
    "policyViolations": [
      {
        "policyId": "string",
        "policyName": "string",
        "policyViolationId": "string",
        "threatLevel": 0,
        "constraintViolations": [
          {
            "constraintId": "string",
            "constraintName": "string",
            "reasons": [
              {
                "reason": "string",
                "reference": {
                  "value": "string",
                  "type": "SECURITY_VULNERABILITY_REFID"
                }
              }
            ]
          }
        ]
      }
    ]
  }
}

Properties

Name Type Required Restrictions Description
componentReleasedFromQuarantine ApiRepositoryComponentPolicyViolationDTO false none none

ApiPolicyWaiverDTO

{
  "policyWaiverId": "string",
  "policyViolationId": "string",
  "comment": "string",
  "createTime": "2019-08-24T14:15:22Z",
  "expiryTime": "2019-08-24T14:15:22Z",
  "isObsolete": true,
  "scopeOwnerType": "string",
  "scopeOwnerId": "string",
  "scopeOwnerName": "string",
  "hash": "string",
  "policyId": "string",
  "vulnerabilityId": "string",
  "policyName": "string",
  "constraintFacts": [
    {
      "constraintId": "string",
      "constraintName": "string",
      "operatorName": "string",
      "conditionFacts": [
        {
          "conditionTypeId": "string",
          "conditionIndex": 0,
          "summary": "string",
          "reason": "string",
          "reference": {
            "value": "string",
            "type": "SECURITY_VULNERABILITY_REFID"
          },
          "triggerJson": "string"
        }
      ]
    }
  ],
  "constraintFactsJson": "string",
  "componentName": "string",
  "creatorId": "string",
  "creatorName": "string",
  "matcherStrategy": "DEFAULT",
  "associatedPackageUrl": "string",
  "componentIdentifier": {
    "format": "string",
    "coordinates": {
      "property1": "string",
      "property2": "string"
    }
  },
  "threatLevel": 0,
  "componentUpgradeAvailable": true,
  "displayName": {
    "parts": [
      {
        "field": "string",
        "value": "string"
      }
    ],
    "name": "string"
  }
}

Properties

Name Type Required Restrictions Description
policyWaiverId string false none none
policyViolationId string false none none
comment string false none none
createTime string(date-time) false none none
expiryTime string(date-time) false none none
isObsolete boolean false none none
scopeOwnerType string false none none
scopeOwnerId string false none none
scopeOwnerName string false none none
hash string false none none
policyId string false none none
vulnerabilityId string false none none
policyName string false none none
constraintFacts [ConstraintFact] false none none
constraintFactsJson string false none none
componentName string false none none
creatorId string false none none
creatorName string false none none
matcherStrategy string false none none
associatedPackageUrl string false none none
componentIdentifier ApiComponentIdentifierDTOV2 false none none
threatLevel integer(int32) false none none
componentUpgradeAvailable boolean false none none
displayName ComponentDisplayName false none none

Enumerated Values

Property Value
matcherStrategy DEFAULT
matcherStrategy EXACT_COMPONENT
matcherStrategy ALL_COMPONENTS
matcherStrategy ALL_VERSIONS

ApiRepositoryComponentDTO

{
  "packageUrl": "string",
  "hash": "string",
  "sha256": "string",
  "componentIdentifier": {
    "format": "string",
    "coordinates": {
      "property1": "string",
      "property2": "string"
    }
  },
  "displayName": "string",
  "thirdParty": true,
  "quarantineId": "string",
  "quarantineTime": "2019-08-24T14:15:22Z",
  "quarantineReleaseTime": "2019-08-24T14:15:22Z"
}

Properties

Name Type Required Restrictions Description
packageUrl string false none none
hash string false none none
sha256 string false none none
componentIdentifier ApiComponentIdentifierDTOV2 false none none
displayName string false none none
thirdParty boolean false none none
quarantineId string false none none
quarantineTime string(date-time) false none none
quarantineReleaseTime string(date-time) false none none

ApiRepositoryComponentPolicyViolationDTO

{
  "component": {
    "packageUrl": "string",
    "hash": "string",
    "sha256": "string",
    "componentIdentifier": {
      "format": "string",
      "coordinates": {
        "property1": "string",
        "property2": "string"
      }
    },
    "displayName": "string",
    "thirdParty": true,
    "quarantineId": "string",
    "quarantineTime": "2019-08-24T14:15:22Z",
    "quarantineReleaseTime": "2019-08-24T14:15:22Z"
  },
  "waivedPolicyViolations": [
    {
      "policyId": "string",
      "policyName": "string",
      "policyViolationId": "string",
      "threatLevel": 0,
      "constraintViolations": [
        {
          "constraintId": "string",
          "constraintName": "string",
          "reasons": [
            {
              "reason": "string",
              "reference": {
                "value": "string",
                "type": "SECURITY_VULNERABILITY_REFID"
              }
            }
          ]
        }
      ],
      "policyWaiver": {
        "policyWaiverId": "string",
        "policyViolationId": "string",
        "comment": "string",
        "createTime": "2019-08-24T14:15:22Z",
        "expiryTime": "2019-08-24T14:15:22Z",
        "isObsolete": true,
        "scopeOwnerType": "string",
        "scopeOwnerId": "string",
        "scopeOwnerName": "string",
        "hash": "string",
        "policyId": "string",
        "vulnerabilityId": "string",
        "policyName": "string",
        "constraintFacts": [
          {
            "constraintId": "string",
            "constraintName": "string",
            "operatorName": "string",
            "conditionFacts": [
              {
                "conditionTypeId": "string",
                "conditionIndex": 0,
                "summary": "string",
                "reason": "string",
                "reference": {
                  "value": "string",
                  "type": "SECURITY_VULNERABILITY_REFID"
                },
                "triggerJson": "string"
              }
            ]
          }
        ],
        "constraintFactsJson": "string",
        "componentName": "string",
        "creatorId": "string",
        "creatorName": "string",
        "matcherStrategy": "DEFAULT",
        "associatedPackageUrl": "string",
        "componentIdentifier": {
          "format": "string",
          "coordinates": {
            "property1": "string",
            "property2": "string"
          }
        },
        "threatLevel": 0,
        "componentUpgradeAvailable": true,
        "displayName": {
          "parts": [
            {
              "field": "string",
              "value": "string"
            }
          ],
          "name": "string"
        }
      }
    }
  ],
  "policyViolations": [
    {
      "policyId": "string",
      "policyName": "string",
      "policyViolationId": "string",
      "threatLevel": 0,
      "constraintViolations": [
        {
          "constraintId": "string",
          "constraintName": "string",
          "reasons": [
            {
              "reason": "string",
              "reference": {
                "value": "string",
                "type": "SECURITY_VULNERABILITY_REFID"
              }
            }
          ]
        }
      ]
    }
  ]
}

Properties

Name Type Required Restrictions Description
component ApiRepositoryComponentDTO false none none
waivedPolicyViolations [ApiWaivedPolicyViolationDTO] false none none
policyViolations [ApiPolicyViolationDTOV2] false none none

ApiWaivedPolicyViolationDTO

{
  "policyId": "string",
  "policyName": "string",
  "policyViolationId": "string",
  "threatLevel": 0,
  "constraintViolations": [
    {
      "constraintId": "string",
      "constraintName": "string",
      "reasons": [
        {
          "reason": "string",
          "reference": {
            "value": "string",
            "type": "SECURITY_VULNERABILITY_REFID"
          }
        }
      ]
    }
  ],
  "policyWaiver": {
    "policyWaiverId": "string",
    "policyViolationId": "string",
    "comment": "string",
    "createTime": "2019-08-24T14:15:22Z",
    "expiryTime": "2019-08-24T14:15:22Z",
    "isObsolete": true,
    "scopeOwnerType": "string",
    "scopeOwnerId": "string",
    "scopeOwnerName": "string",
    "hash": "string",
    "policyId": "string",
    "vulnerabilityId": "string",
    "policyName": "string",
    "constraintFacts": [
      {
        "constraintId": "string",
        "constraintName": "string",
        "operatorName": "string",
        "conditionFacts": [
          {
            "conditionTypeId": "string",
            "conditionIndex": 0,
            "summary": "string",
            "reason": "string",
            "reference": {
              "value": "string",
              "type": "SECURITY_VULNERABILITY_REFID"
            },
            "triggerJson": "string"
          }
        ]
      }
    ],
    "constraintFactsJson": "string",
    "componentName": "string",
    "creatorId": "string",
    "creatorName": "string",
    "matcherStrategy": "DEFAULT",
    "associatedPackageUrl": "string",
    "componentIdentifier": {
      "format": "string",
      "coordinates": {
        "property1": "string",
        "property2": "string"
      }
    },
    "threatLevel": 0,
    "componentUpgradeAvailable": true,
    "displayName": {
      "parts": [
        {
          "field": "string",
          "value": "string"
        }
      ],
      "name": "string"
    }
  }
}

Properties

Name Type Required Restrictions Description
policyId string false none none
policyName string false none none
policyViolationId string false none none
threatLevel integer(int32) false none none
constraintViolations [ApiConstraintViolationDTO] false none none
policyWaiver ApiPolicyWaiverDTO false none none

ComponentDisplayName

{
  "parts": [
    {
      "field": "string",
      "value": "string"
    }
  ],
  "name": "string"
}

Properties

Name Type Required Restrictions Description
parts [ComponentDisplayNamePart] false none none
name string false none none

ComponentDisplayNamePart

{
  "field": "string",
  "value": "string"
}

Properties

Name Type Required Restrictions Description
field string false none none
value string false none none

ConditionFact

{
  "conditionTypeId": "string",
  "conditionIndex": 0,
  "summary": "string",
  "reason": "string",
  "reference": {
    "value": "string",
    "type": "SECURITY_VULNERABILITY_REFID"
  },
  "triggerJson": "string"
}

Properties

Name Type Required Restrictions Description
conditionTypeId string false none none
conditionIndex integer(int32) false none none
summary string false none none
reason string false none none
reference TriggerReference false none none
triggerJson string false none none

ConstraintFact

{
  "constraintId": "string",
  "constraintName": "string",
  "operatorName": "string",
  "conditionFacts": [
    {
      "conditionTypeId": "string",
      "conditionIndex": 0,
      "summary": "string",
      "reason": "string",
      "reference": {
        "value": "string",
        "type": "SECURITY_VULNERABILITY_REFID"
      },
      "triggerJson": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
constraintId string false none none
constraintName string false none none
operatorName string false none none
conditionFacts [ConditionFact] false none none

ApiComponentChangeActionDTO

{
  "component": {
    "packageUrl": "string",
    "hash": "string",
    "sha256": "string",
    "componentIdentifier": {
      "format": "string",
      "coordinates": {
        "property1": "string",
        "property2": "string"
      }
    },
    "displayName": "string",
    "proprietary": true,
    "thirdParty": true
  }
}

Properties

Name Type Required Restrictions Description
component ApiComponentDTOV2 false none none

ApiComponentRemediationDTO

{
  "remediation": {
    "versionChanges": [
      {
        "type": "next-no-violations",
        "data": {
          "component": {
            "packageUrl": "string",
            "hash": "string",
            "sha256": "string",
            "componentIdentifier": {
              "format": "string",
              "coordinates": {
                "property1": "string",
                "property2": "string"
              }
            },
            "displayName": "string",
            "proprietary": true,
            "thirdParty": true
          }
        }
      }
    ]
  }
}

Properties

Name Type Required Restrictions Description
remediation ApiComponentRemediationValueDTO false none none

ApiComponentRemediationValueDTO

{
  "versionChanges": [
    {
      "type": "next-no-violations",
      "data": {
        "component": {
          "packageUrl": "string",
          "hash": "string",
          "sha256": "string",
          "componentIdentifier": {
            "format": "string",
            "coordinates": {
              "property1": "string",
              "property2": "string"
            }
          },
          "displayName": "string",
          "proprietary": true,
          "thirdParty": true
        }
      }
    }
  ]
}

Properties

Name Type Required Restrictions Description
versionChanges [ApiVersionChangeOptionDTO] false none none

ApiVersionChangeOptionDTO

{
  "type": "next-no-violations",
  "data": {
    "component": {
      "packageUrl": "string",
      "hash": "string",
      "sha256": "string",
      "componentIdentifier": {
        "format": "string",
        "coordinates": {
          "property1": "string",
          "property2": "string"
        }
      },
      "displayName": "string",
      "proprietary": true,
      "thirdParty": true
    }
  }
}

Properties

Name Type Required Restrictions Description
type string false none none
data ApiComponentChangeActionDTO false none none

Enumerated Values

Property Value
type next-no-violations
type next-non-failing
type next-no-violations-with-dependencies
type next-non-failing-with-dependencies

ApiComponentOrPurlIdentifierDTOV2

{
  "format": "string",
  "coordinates": {
    "property1": "string",
    "property2": "string"
  },
  "packageUrl": "string"
}

Properties

Name Type Required Restrictions Description
format string false none none
coordinates object false none none
» additionalProperties string false none none
packageUrl string false none none

ApiComponentsInQuarantineDTO

{
  "componentsInQuarantine": [
    {
      "repository": {
        "repositoryId": "string",
        "publicId": "string",
        "format": "string",
        "type": "string",
        "auditEnabled": true,
        "quarantineEnabled": true,
        "policyCompliantComponentSelectionEnabled": true,
        "namespaceConfusionProtectionEnabled": true
      },
      "components": [
        {
          "component": {
            "packageUrl": "string",
            "hash": "string",
            "sha256": "string",
            "componentIdentifier": {
              "format": "string",
              "coordinates": {
                "property1": "string",
                "property2": "string"
              }
            },
            "displayName": "string",
            "thirdParty": true,
            "quarantineId": "string",
            "quarantineTime": "2019-08-24T14:15:22Z",
            "quarantineReleaseTime": "2019-08-24T14:15:22Z"
          },
          "waivedPolicyViolations": [
            {
              "policyId": "string",
              "policyName": "string",
              "policyViolationId": "string",
              "threatLevel": 0,
              "constraintViolations": [
                {
                  "constraintId": "string",
                  "constraintName": "string",
                  "reasons": [
                    {}
                  ]
                }
              ],
              "policyWaiver": {
                "policyWaiverId": "string",
                "policyViolationId": "string",
                "comment": "string",
                "createTime": "2019-08-24T14:15:22Z",
                "expiryTime": "2019-08-24T14:15:22Z",
                "isObsolete": true,
                "scopeOwnerType": "string",
                "scopeOwnerId": "string",
                "scopeOwnerName": "string",
                "hash": "string",
                "policyId": "string",
                "vulnerabilityId": "string",
                "policyName": "string",
                "constraintFacts": [
                  {
                    "constraintId": "string",
                    "constraintName": "string",
                    "operatorName": "string",
                    "conditionFacts": []
                  }
                ],
                "constraintFactsJson": "string",
                "componentName": "string",
                "creatorId": "string",
                "creatorName": "string",
                "matcherStrategy": "DEFAULT",
                "associatedPackageUrl": "string",
                "componentIdentifier": {
                  "format": "string",
                  "coordinates": {
                    "property1": "string",
                    "property2": "string"
                  }
                },
                "threatLevel": 0,
                "componentUpgradeAvailable": true,
                "displayName": {
                  "parts": [
                    {}
                  ],
                  "name": "string"
                }
              }
            }
          ],
          "policyViolations": [
            {
              "policyId": "string",
              "policyName": "string",
              "policyViolationId": "string",
              "threatLevel": 0,
              "constraintViolations": [
                {
                  "constraintId": "string",
                  "constraintName": "string",
                  "reasons": [
                    {}
                  ]
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

Properties

Name Type Required Restrictions Description
componentsInQuarantine [ApiRepositoryComponentsInQuarantineDTO] false none none

ApiRepositoryComponentsInQuarantineDTO

{
  "repository": {
    "repositoryId": "string",
    "publicId": "string",
    "format": "string",
    "type": "string",
    "auditEnabled": true,
    "quarantineEnabled": true,
    "policyCompliantComponentSelectionEnabled": true,
    "namespaceConfusionProtectionEnabled": true
  },
  "components": [
    {
      "component": {
        "packageUrl": "string",
        "hash": "string",
        "sha256": "string",
        "componentIdentifier": {
          "format": "string",
          "coordinates": {
            "property1": "string",
            "property2": "string"
          }
        },
        "displayName": "string",
        "thirdParty": true,
        "quarantineId": "string",
        "quarantineTime": "2019-08-24T14:15:22Z",
        "quarantineReleaseTime": "2019-08-24T14:15:22Z"
      },
      "waivedPolicyViolations": [
        {
          "policyId": "string",
          "policyName": "string",
          "policyViolationId": "string",
          "threatLevel": 0,
          "constraintViolations": [
            {
              "constraintId": "string",
              "constraintName": "string",
              "reasons": [
                {
                  "reason": "string",
                  "reference": {
                    "value": "string",
                    "type": "SECURITY_VULNERABILITY_REFID"
                  }
                }
              ]
            }
          ],
          "policyWaiver": {
            "policyWaiverId": "string",
            "policyViolationId": "string",
            "comment": "string",
            "createTime": "2019-08-24T14:15:22Z",
            "expiryTime": "2019-08-24T14:15:22Z",
            "isObsolete": true,
            "scopeOwnerType": "string",
            "scopeOwnerId": "string",
            "scopeOwnerName": "string",
            "hash": "string",
            "policyId": "string",
            "vulnerabilityId": "string",
            "policyName": "string",
            "constraintFacts": [
              {
                "constraintId": "string",
                "constraintName": "string",
                "operatorName": "string",
                "conditionFacts": [
                  {
                    "conditionTypeId": "string",
                    "conditionIndex": 0,
                    "summary": "string",
                    "reason": "string",
                    "reference": {},
                    "triggerJson": "string"
                  }
                ]
              }
            ],
            "constraintFactsJson": "string",
            "componentName": "string",
            "creatorId": "string",
            "creatorName": "string",
            "matcherStrategy": "DEFAULT",
            "associatedPackageUrl": "string",
            "componentIdentifier": {
              "format": "string",
              "coordinates": {
                "property1": "string",
                "property2": "string"
              }
            },
            "threatLevel": 0,
            "componentUpgradeAvailable": true,
            "displayName": {
              "parts": [
                {
                  "field": "string",
                  "value": "string"
                }
              ],
              "name": "string"
            }
          }
        }
      ],
      "policyViolations": [
        {
          "policyId": "string",
          "policyName": "string",
          "policyViolationId": "string",
          "threatLevel": 0,
          "constraintViolations": [
            {
              "constraintId": "string",
              "constraintName": "string",
              "reasons": [
                {
                  "reason": "string",
                  "reference": {
                    "value": "string",
                    "type": "SECURITY_VULNERABILITY_REFID"
                  }
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

Properties

Name Type Required Restrictions Description
repository ApiRepositoryDTO false none none
components [ApiRepositoryComponentPolicyViolationDTO] false none none

ApiRepositoryDTO

{
  "repositoryId": "string",
  "publicId": "string",
  "format": "string",
  "type": "string",
  "auditEnabled": true,
  "quarantineEnabled": true,
  "policyCompliantComponentSelectionEnabled": true,
  "namespaceConfusionProtectionEnabled": true
}

Properties

Name Type Required Restrictions Description
repositoryId string false none none
publicId string false none none
format string false none none
type string false none none
auditEnabled boolean false none none
quarantineEnabled boolean false none none
policyCompliantComponentSelectionEnabled boolean false none none
namespaceConfusionProtectionEnabled boolean false none none

ApiApplicationBaseDTO

{
  "id": "string",
  "publicId": "string",
  "name": "string",
  "organizationId": "string",
  "contactUserName": "string"
}

Properties

Name Type Required Restrictions Description
id string false none none
publicId string false none none
name string false none none
organizationId string false none none
contactUserName string false none none

ApiApplicationWaiverDTO

{
  "application": {
    "id": "string",
    "publicId": "string",
    "name": "string",
    "organizationId": "string",
    "contactUserName": "string"
  },
  "stages": [
    {
      "stageId": "string",
      "componentPolicyViolations": [
        {
          "component": {
            "packageUrl": "string",
            "hash": "string",
            "sha256": "string",
            "componentIdentifier": {
              "format": "string",
              "coordinates": {
                "property1": "string",
                "property2": "string"
              }
            },
            "displayName": "string",
            "proprietary": true,
            "thirdParty": true
          },
          "waivedPolicyViolations": [
            {
              "policyId": "string",
              "policyName": "string",
              "policyViolationId": "string",
              "threatLevel": 0,
              "constraintViolations": [
                {
                  "constraintId": "string",
                  "constraintName": "string",
                  "reasons": [
                    {}
                  ]
                }
              ],
              "policyWaiver": {
                "policyWaiverId": "string",
                "policyViolationId": "string",
                "comment": "string",
                "createTime": "2019-08-24T14:15:22Z",
                "expiryTime": "2019-08-24T14:15:22Z",
                "isObsolete": true,
                "scopeOwnerType": "string",
                "scopeOwnerId": "string",
                "scopeOwnerName": "string",
                "hash": "string",
                "policyId": "string",
                "vulnerabilityId": "string",
                "policyName": "string",
                "constraintFacts": [
                  {
                    "constraintId": "string",
                    "constraintName": "string",
                    "operatorName": "string",
                    "conditionFacts": []
                  }
                ],
                "constraintFactsJson": "string",
                "componentName": "string",
                "creatorId": "string",
                "creatorName": "string",
                "matcherStrategy": "DEFAULT",
                "associatedPackageUrl": "string",
                "componentIdentifier": {
                  "format": "string",
                  "coordinates": {
                    "property1": "string",
                    "property2": "string"
                  }
                },
                "threatLevel": 0,
                "componentUpgradeAvailable": true,
                "displayName": {
                  "parts": [
                    {}
                  ],
                  "name": "string"
                }
              }
            }
          ]
        }
      ]
    }
  ]
}

Properties

Name Type Required Restrictions Description
application ApiApplicationBaseDTO false none none
stages [ApiPolicyViolationStageDTO] false none none

ApiComponentPolicyViolationDTO

{
  "component": {
    "packageUrl": "string",
    "hash": "string",
    "sha256": "string",
    "componentIdentifier": {
      "format": "string",
      "coordinates": {
        "property1": "string",
        "property2": "string"
      }
    },
    "displayName": "string",
    "proprietary": true,
    "thirdParty": true
  },
  "waivedPolicyViolations": [
    {
      "policyId": "string",
      "policyName": "string",
      "policyViolationId": "string",
      "threatLevel": 0,
      "constraintViolations": [
        {
          "constraintId": "string",
          "constraintName": "string",
          "reasons": [
            {
              "reason": "string",
              "reference": {
                "value": "string",
                "type": "SECURITY_VULNERABILITY_REFID"
              }
            }
          ]
        }
      ],
      "policyWaiver": {
        "policyWaiverId": "string",
        "policyViolationId": "string",
        "comment": "string",
        "createTime": "2019-08-24T14:15:22Z",
        "expiryTime": "2019-08-24T14:15:22Z",
        "isObsolete": true,
        "scopeOwnerType": "string",
        "scopeOwnerId": "string",
        "scopeOwnerName": "string",
        "hash": "string",
        "policyId": "string",
        "vulnerabilityId": "string",
        "policyName": "string",
        "constraintFacts": [
          {
            "constraintId": "string",
            "constraintName": "string",
            "operatorName": "string",
            "conditionFacts": [
              {
                "conditionTypeId": "string",
                "conditionIndex": 0,
                "summary": "string",
                "reason": "string",
                "reference": {
                  "value": "string",
                  "type": "SECURITY_VULNERABILITY_REFID"
                },
                "triggerJson": "string"
              }
            ]
          }
        ],
        "constraintFactsJson": "string",
        "componentName": "string",
        "creatorId": "string",
        "creatorName": "string",
        "matcherStrategy": "DEFAULT",
        "associatedPackageUrl": "string",
        "componentIdentifier": {
          "format": "string",
          "coordinates": {
            "property1": "string",
            "property2": "string"
          }
        },
        "threatLevel": 0,
        "componentUpgradeAvailable": true,
        "displayName": {
          "parts": [
            {
              "field": "string",
              "value": "string"
            }
          ],
          "name": "string"
        }
      }
    }
  ]
}

Properties

Name Type Required Restrictions Description
component ApiComponentDTOV2 false none none
waivedPolicyViolations [ApiWaivedPolicyViolationDTO] false none none

ApiComponentWaiversDTO

{
  "applicationWaivers": [
    {
      "application": {
        "id": "string",
        "publicId": "string",
        "name": "string",
        "organizationId": "string",
        "contactUserName": "string"
      },
      "stages": [
        {
          "stageId": "string",
          "componentPolicyViolations": [
            {
              "component": {
                "packageUrl": "string",
                "hash": "string",
                "sha256": "string",
                "componentIdentifier": {
                  "format": "string",
                  "coordinates": {
                    "property1": "string",
                    "property2": "string"
                  }
                },
                "displayName": "string",
                "proprietary": true,
                "thirdParty": true
              },
              "waivedPolicyViolations": [
                {
                  "policyId": "string",
                  "policyName": "string",
                  "policyViolationId": "string",
                  "threatLevel": 0,
                  "constraintViolations": [
                    {}
                  ],
                  "policyWaiver": {
                    "policyWaiverId": "string",
                    "policyViolationId": "string",
                    "comment": "string",
                    "createTime": "2019-08-24T14:15:22Z",
                    "expiryTime": "2019-08-24T14:15:22Z",
                    "isObsolete": true,
                    "scopeOwnerType": "string",
                    "scopeOwnerId": "string",
                    "scopeOwnerName": "string",
                    "hash": "string",
                    "policyId": "string",
                    "vulnerabilityId": "string",
                    "policyName": "string",
                    "constraintFacts": [],
                    "constraintFactsJson": "string",
                    "componentName": "string",
                    "creatorId": "string",
                    "creatorName": "string",
                    "matcherStrategy": "DEFAULT",
                    "associatedPackageUrl": "string",
                    "componentIdentifier": {},
                    "threatLevel": 0,
                    "componentUpgradeAvailable": true,
                    "displayName": {}
                  }
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "repositoryWaivers": [
    {
      "repository": {
        "repositoryId": "string",
        "publicId": "string",
        "format": "string",
        "type": "string",
        "auditEnabled": true,
        "quarantineEnabled": true,
        "policyCompliantComponentSelectionEnabled": true,
        "namespaceConfusionProtectionEnabled": true
      },
      "stages": [
        {
          "stageId": "string",
          "componentPolicyViolations": [
            {
              "component": {
                "packageUrl": "string",
                "hash": "string",
                "sha256": "string",
                "componentIdentifier": {
                  "format": "string",
                  "coordinates": {
                    "property1": "string",
                    "property2": "string"
                  }
                },
                "displayName": "string",
                "proprietary": true,
                "thirdParty": true
              },
              "waivedPolicyViolations": [
                {
                  "policyId": "string",
                  "policyName": "string",
                  "policyViolationId": "string",
                  "threatLevel": 0,
                  "constraintViolations": [
                    {}
                  ],
                  "policyWaiver": {
                    "policyWaiverId": "string",
                    "policyViolationId": "string",
                    "comment": "string",
                    "createTime": "2019-08-24T14:15:22Z",
                    "expiryTime": "2019-08-24T14:15:22Z",
                    "isObsolete": true,
                    "scopeOwnerType": "string",
                    "scopeOwnerId": "string",
                    "scopeOwnerName": "string",
                    "hash": "string",
                    "policyId": "string",
                    "vulnerabilityId": "string",
                    "policyName": "string",
                    "constraintFacts": [],
                    "constraintFactsJson": "string",
                    "componentName": "string",
                    "creatorId": "string",
                    "creatorName": "string",
                    "matcherStrategy": "DEFAULT",
                    "associatedPackageUrl": "string",
                    "componentIdentifier": {},
                    "threatLevel": 0,
                    "componentUpgradeAvailable": true,
                    "displayName": {}
                  }
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

Properties

Name Type Required Restrictions Description
applicationWaivers [ApiApplicationWaiverDTO] false none none
repositoryWaivers [ApiRepositoryWaiverDTO] false none none

ApiPolicyViolationStageDTO

{
  "stageId": "string",
  "componentPolicyViolations": [
    {
      "component": {
        "packageUrl": "string",
        "hash": "string",
        "sha256": "string",
        "componentIdentifier": {
          "format": "string",
          "coordinates": {
            "property1": "string",
            "property2": "string"
          }
        },
        "displayName": "string",
        "proprietary": true,
        "thirdParty": true
      },
      "waivedPolicyViolations": [
        {
          "policyId": "string",
          "policyName": "string",
          "policyViolationId": "string",
          "threatLevel": 0,
          "constraintViolations": [
            {
              "constraintId": "string",
              "constraintName": "string",
              "reasons": [
                {
                  "reason": "string",
                  "reference": {
                    "value": "string",
                    "type": "SECURITY_VULNERABILITY_REFID"
                  }
                }
              ]
            }
          ],
          "policyWaiver": {
            "policyWaiverId": "string",
            "policyViolationId": "string",
            "comment": "string",
            "createTime": "2019-08-24T14:15:22Z",
            "expiryTime": "2019-08-24T14:15:22Z",
            "isObsolete": true,
            "scopeOwnerType": "string",
            "scopeOwnerId": "string",
            "scopeOwnerName": "string",
            "hash": "string",
            "policyId": "string",
            "vulnerabilityId": "string",
            "policyName": "string",
            "constraintFacts": [
              {
                "constraintId": "string",
                "constraintName": "string",
                "operatorName": "string",
                "conditionFacts": [
                  {
                    "conditionTypeId": "string",
                    "conditionIndex": 0,
                    "summary": "string",
                    "reason": "string",
                    "reference": {},
                    "triggerJson": "string"
                  }
                ]
              }
            ],
            "constraintFactsJson": "string",
            "componentName": "string",
            "creatorId": "string",
            "creatorName": "string",
            "matcherStrategy": "DEFAULT",
            "associatedPackageUrl": "string",
            "componentIdentifier": {
              "format": "string",
              "coordinates": {
                "property1": "string",
                "property2": "string"
              }
            },
            "threatLevel": 0,
            "componentUpgradeAvailable": true,
            "displayName": {
              "parts": [
                {
                  "field": "string",
                  "value": "string"
                }
              ],
              "name": "string"
            }
          }
        }
      ]
    }
  ]
}

Properties

Name Type Required Restrictions Description
stageId string false none none
componentPolicyViolations [ApiComponentPolicyViolationDTO] false none none

ApiRepositoryWaiverDTO

{
  "repository": {
    "repositoryId": "string",
    "publicId": "string",
    "format": "string",
    "type": "string",
    "auditEnabled": true,
    "quarantineEnabled": true,
    "policyCompliantComponentSelectionEnabled": true,
    "namespaceConfusionProtectionEnabled": true
  },
  "stages": [
    {
      "stageId": "string",
      "componentPolicyViolations": [
        {
          "component": {
            "packageUrl": "string",
            "hash": "string",
            "sha256": "string",
            "componentIdentifier": {
              "format": "string",
              "coordinates": {
                "property1": "string",
                "property2": "string"
              }
            },
            "displayName": "string",
            "proprietary": true,
            "thirdParty": true
          },
          "waivedPolicyViolations": [
            {
              "policyId": "string",
              "policyName": "string",
              "policyViolationId": "string",
              "threatLevel": 0,
              "constraintViolations": [
                {
                  "constraintId": "string",
                  "constraintName": "string",
                  "reasons": [
                    {}
                  ]
                }
              ],
              "policyWaiver": {
                "policyWaiverId": "string",
                "policyViolationId": "string",
                "comment": "string",
                "createTime": "2019-08-24T14:15:22Z",
                "expiryTime": "2019-08-24T14:15:22Z",
                "isObsolete": true,
                "scopeOwnerType": "string",
                "scopeOwnerId": "string",
                "scopeOwnerName": "string",
                "hash": "string",
                "policyId": "string",
                "vulnerabilityId": "string",
                "policyName": "string",
                "constraintFacts": [
                  {
                    "constraintId": "string",
                    "constraintName": "string",
                    "operatorName": "string",
                    "conditionFacts": []
                  }
                ],
                "constraintFactsJson": "string",
                "componentName": "string",
                "creatorId": "string",
                "creatorName": "string",
                "matcherStrategy": "DEFAULT",
                "associatedPackageUrl": "string",
                "componentIdentifier": {
                  "format": "string",
                  "coordinates": {
                    "property1": "string",
                    "property2": "string"
                  }
                },
                "threatLevel": 0,
                "componentUpgradeAvailable": true,
                "displayName": {
                  "parts": [
                    {}
                  ],
                  "name": "string"
                }
              }
            }
          ]
        }
      ]
    }
  ]
}

Properties

Name Type Required Restrictions Description
repository ApiRepositoryDTO false none none
stages [ApiPolicyViolationStageDTO] false none none

ConfigurationValidationResult

{
  "configurationComplete": {
    "valid": true,
    "message": "string"
  },
  "repoPrivate": {
    "valid": true,
    "message": "string"
  },
  "tokenPermissions": {
    "valid": true,
    "message": "string"
  },
  "sshConfiguration": {
    "valid": true,
    "message": "string"
  }
}

Properties

Name Type Required Restrictions Description
configurationComplete ValidationResult false none none
repoPrivate ValidationResult false none none
tokenPermissions ValidationResult false none none
sshConfiguration ValidationResult false none none

ValidationResult

{
  "valid": true,
  "message": "string"
}

Properties

Name Type Required Restrictions Description
valid boolean false none none
message string false none none

ApiCompositeSourceControlDTO

{
  "id": "string",
  "ownerId": "string",
  "repositoryUrl": "string",
  "provider": {
    "value": "string",
    "parentValue": "string",
    "parentName": "string"
  },
  "username": {
    "value": "string",
    "parentValue": "string",
    "parentName": "string"
  },
  "token": {
    "value": "string",
    "parentValue": "string",
    "parentName": "string"
  },
  "baseBranch": {
    "value": "string",
    "parentValue": "string",
    "parentName": "string"
  },
  "remediationPullRequestsEnabled": {
    "value": true,
    "parentValue": true,
    "parentName": "string"
  },
  "statusChecksEnabled": {
    "value": true,
    "parentValue": true,
    "parentName": "string"
  },
  "pullRequestCommentingEnabled": {
    "value": true,
    "parentValue": true,
    "parentName": "string"
  },
  "sourceControlEvaluationsEnabled": {
    "value": true,
    "parentValue": true,
    "parentName": "string"
  },
  "sourceControlScanTarget": {
    "value": "string",
    "parentValue": "string",
    "parentName": "string"
  },
  "sshEnabled": {
    "value": true,
    "parentValue": true,
    "parentName": "string"
  },
  "commitStatusEnabled": {
    "value": true,
    "parentValue": true,
    "parentName": "string"
  }
}

Properties

Name Type Required Restrictions Description
id string false none none
ownerId string false none none
repositoryUrl string false none none
provider ApiCompositeValueDTOString false none none
username ApiCompositeValueDTOString false none none
token ApiCompositeValueDTOString false none none
baseBranch ApiCompositeValueDTOString false none none
remediationPullRequestsEnabled ApiCompositeValueDTOBoolean false none none
statusChecksEnabled ApiCompositeValueDTOBoolean false none none
pullRequestCommentingEnabled ApiCompositeValueDTOBoolean false none none
sourceControlEvaluationsEnabled ApiCompositeValueDTOBoolean false none none
sourceControlScanTarget ApiCompositeValueDTOString false none none
sshEnabled ApiCompositeValueDTOBoolean false none none
commitStatusEnabled ApiCompositeValueDTOBoolean false none none

ApiCompositeValueDTOBoolean

{
  "value": true,
  "parentValue": true,
  "parentName": "string"
}

Properties

Name Type Required Restrictions Description
value boolean false none none
parentValue boolean false none none
parentName string false none none

ApiCompositeValueDTOString

{
  "value": "string",
  "parentValue": "string",
  "parentName": "string"
}

Properties

Name Type Required Restrictions Description
value string false none none
parentValue string false none none
parentName string false none none

ApiCrowdConfigurationDTO

{
  "serverUrl": "string",
  "applicationName": "string",
  "applicationPassword": [
    "string"
  ]
}

Properties

Name Type Required Restrictions Description
serverUrl string false none none
applicationName string false none none
applicationPassword [string] false none none

ApiStatusDTO

{
  "code": 0,
  "message": "string"
}

Properties

Name Type Required Restrictions Description
code integer(int32) false none none
message string false none none

ApiDataRetentionPoliciesDTO

{
  "applicationReports": {
    "stages": {
      "property1": {
        "inheritPolicy": true,
        "enablePurging": true,
        "maxCount": 0,
        "maxAge": "string"
      },
      "property2": {
        "inheritPolicy": true,
        "enablePurging": true,
        "maxCount": 0,
        "maxAge": "string"
      }
    }
  },
  "successMetrics": {
    "inheritPolicy": true,
    "enablePurging": true,
    "maxAge": "string"
  }
}

Properties

Name Type Required Restrictions Description
applicationReports ApiReportRetentionPoliciesDTO false none none
successMetrics ApiSuccessMetricsRetentionPolicyDTO false none none

ApiReportRetentionPoliciesDTO

{
  "stages": {
    "property1": {
      "inheritPolicy": true,
      "enablePurging": true,
      "maxCount": 0,
      "maxAge": "string"
    },
    "property2": {
      "inheritPolicy": true,
      "enablePurging": true,
      "maxCount": 0,
      "maxAge": "string"
    }
  }
}

Properties

Name Type Required Restrictions Description
stages object false none none
» additionalProperties ApiReportRetentionPolicyDTO false none none

ApiReportRetentionPolicyDTO

{
  "inheritPolicy": true,
  "enablePurging": true,
  "maxCount": 0,
  "maxAge": "string"
}

Properties

Name Type Required Restrictions Description
inheritPolicy boolean false none none
enablePurging boolean false none none
maxCount integer(int32) false none none
maxAge string false none none

ApiSuccessMetricsRetentionPolicyDTO

{
  "inheritPolicy": true,
  "enablePurging": true,
  "maxAge": "string"
}

Properties

Name Type Required Restrictions Description
inheritPolicy boolean false none none
enablePurging boolean false none none
maxAge string false none none

ApiComponentEvaluationTicketDTOV2

{
  "resultId": "string",
  "submittedDate": "2019-08-24T14:15:22Z",
  "applicationId": "string",
  "resultsUrl": "string"
}

Properties

Name Type Required Restrictions Description
resultId string false none none
submittedDate string(date-time) false none none
applicationId string false none none
resultsUrl string false none none

ApiComponentEvaluationRequestDTOV2

{
  "components": [
    {
      "packageUrl": "string",
      "hash": "string",
      "sha256": "string",
      "componentIdentifier": {
        "format": "string",
        "coordinates": {
          "property1": "string",
          "property2": "string"
        }
      },
      "displayName": "string",
      "proprietary": true,
      "thirdParty": true
    }
  ]
}

Properties

Name Type Required Restrictions Description
components [ApiComponentDTOV2] false none none

ApiApplicationEvaluationStatusDTOV2

{
  "statusUrl": "string"
}

Properties

Name Type Required Restrictions Description
statusUrl string false none none

ApiSourceControlEvaluationRequestDTO

{
  "stageId": "string",
  "branchName": "string",
  "scanTargets": [
    "string"
  ]
}

Properties

Name Type Required Restrictions Description
stageId string false none none
branchName string false none none
scanTargets [string] false none none

ApiApplicationEvaluationResultDTOV2

{
  "status": "string",
  "reason": "string",
  "reportHtmlUrl": "string",
  "embeddableReportHtmlUrl": "string",
  "reportPdfUrl": "string",
  "reportDataUrl": "string"
}

Properties

Name Type Required Restrictions Description
status string false none none
reason string false none none
reportHtmlUrl string false none none
embeddableReportHtmlUrl string false none none
reportPdfUrl string false none none
reportDataUrl string false none none

ApiComponentEvaluationResultDTOV2

{
  "submittedDate": "2019-08-24T14:15:22Z",
  "evaluationDate": "2019-08-24T14:15:22Z",
  "applicationId": "string",
  "results": [
    {
      "component": {
        "packageUrl": "string",
        "hash": "string",
        "sha256": "string",
        "componentIdentifier": {
          "format": "string",
          "coordinates": {
            "property1": "string",
            "property2": "string"
          }
        },
        "displayName": "string",
        "proprietary": true,
        "thirdParty": true
      },
      "matchState": "string",
      "catalogDate": "2019-08-24T14:15:22Z",
      "relativePopularity": 0,
      "licenseData": {
        "declaredLicenses": [
          {
            "licenseId": "string",
            "licenseName": "string"
          }
        ],
        "observedLicenses": [
          {
            "licenseId": "string",
            "licenseName": "string"
          }
        ],
        "effectiveLicenses": [
          {
            "licenseId": "string",
            "licenseName": "string"
          }
        ],
        "overriddenLicenses": [
          {
            "licenseId": "string",
            "licenseName": "string"
          }
        ],
        "status": "string"
      },
      "integrityRating": "string",
      "hygieneRating": "string",
      "securityData": {
        "securityIssues": [
          {
            "source": "string",
            "reference": "string",
            "severity": 0.1,
            "status": "string",
            "url": "string",
            "threatCategory": "string",
            "cwe": "string",
            "cvssVector": "string",
            "cvssVectorSource": "string",
            "analysis": {
              "state": "string",
              "justification": "string",
              "response": "string",
              "detail": "string"
            }
          }
        ]
      },
      "policyData": {
        "policyViolations": [
          {
            "policyId": "string",
            "policyName": "string",
            "policyViolationId": "string",
            "threatLevel": 0,
            "constraintViolations": [
              {
                "constraintId": "string",
                "constraintName": "string",
                "reasons": [
                  {
                    "reason": "string",
                    "reference": {}
                  }
                ]
              }
            ]
          }
        ]
      },
      "projectData": {
        "firstReleaseDate": "2019-08-24T14:15:22Z",
        "lastReleaseDate": "2019-08-24T14:15:22Z",
        "projectMetadata": {
          "description": "string",
          "organization": "string"
        },
        "sourceControlManagement": {
          "scmUrl": "string",
          "scmMetadata": {
            "stars": 0,
            "forks": 0
          },
          "scmDetails": {
            "commitsPerMonth": 0,
            "uniqueDevsPerMonth": 0
          }
        }
      }
    }
  ],
  "isError": true,
  "errorMessage": "string"
}

Properties

Name Type Required Restrictions Description
submittedDate string(date-time) false none none
evaluationDate string(date-time) false none none
applicationId string false none none
results [ApiComponentDetailsDTOV2] false none none
isError boolean false none none
errorMessage string false none none

ApiPromoteScanRequestDTOV2

{
  "scanId": "string",
  "sourceStageId": "string",
  "targetStageId": "string"
}

Properties

Name Type Required Restrictions Description
scanId string false none none
sourceStageId string false none none
targetStageId string false none none

ApiFirewallMetricsResultDTO

{
  "firewallMetricsValue": 0,
  "latestUpdatedTime": "2019-08-24T14:15:22Z"
}

Properties

Name Type Required Restrictions Description
firewallMetricsValue integer(int32) false none none
latestUpdatedTime string(date-time) false none none

ApiRepositoryManagerDTO

{
  "id": "string",
  "name": "string",
  "instanceId": "string",
  "productName": "string",
  "productVersion": "string"
}

Properties

Name Type Required Restrictions Description
id string false none none
name string false none none
instanceId string false none none
productName string false none none
productVersion string false none none

ApiRepositoryListDTO

{
  "repositories": [
    {
      "repositoryId": "string",
      "publicId": "string",
      "format": "string",
      "type": "string",
      "auditEnabled": true,
      "quarantineEnabled": true,
      "policyCompliantComponentSelectionEnabled": true,
      "namespaceConfusionProtectionEnabled": true
    }
  ]
}

Properties

Name Type Required Restrictions Description
repositories [ApiRepositoryDTO] false none none

ApiRepositoryComponentEvaluationRequest

{
  "pathname": "string",
  "hash": "string",
  "packageUrl": "string"
}

Properties

Name Type Required Restrictions Description
pathname string false none none
hash string false none none
packageUrl string false none none

ApiRepositoryComponentEvaluationResult

{
  "quarantined": true,
  "quarantineDate": "2019-08-24T14:15:22Z",
  "component": {
    "pathname": "string",
    "hash": "string",
    "packageUrl": "string"
  },
  "catalogDate": "2019-08-24T14:15:22Z",
  "policyViolations": [
    {
      "policyId": "string",
      "policyName": "string",
      "policyViolationId": "string",
      "threatLevel": 0,
      "constraintViolations": [
        {
          "constraintId": "string",
          "constraintName": "string",
          "reasons": [
            {
              "reason": "string",
              "reference": {
                "value": "string",
                "type": "SECURITY_VULNERABILITY_REFID"
              }
            }
          ]
        }
      ]
    }
  ]
}

Properties

Name Type Required Restrictions Description
quarantined boolean false none none
quarantineDate string(date-time) false none none
component ApiRepositoryComponentEvaluationRequest false none none
catalogDate string(date-time) false none none
policyViolations [ApiPolicyViolationDTOV2] false none none

ApiRepositoryComponentEvaluationResultList

{
  "repositoryManagerId": "string",
  "repositoryId": "string",
  "repositoryPublicId": "string",
  "repositoryType": "string",
  "results": [
    {
      "quarantined": true,
      "quarantineDate": "2019-08-24T14:15:22Z",
      "component": {
        "pathname": "string",
        "hash": "string",
        "packageUrl": "string"
      },
      "catalogDate": "2019-08-24T14:15:22Z",
      "policyViolations": [
        {
          "policyId": "string",
          "policyName": "string",
          "policyViolationId": "string",
          "threatLevel": 0,
          "constraintViolations": [
            {
              "constraintId": "string",
              "constraintName": "string",
              "reasons": [
                {
                  "reason": "string",
                  "reference": {
                    "value": "string",
                    "type": "SECURITY_VULNERABILITY_REFID"
                  }
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

Properties

Name Type Required Restrictions Description
repositoryManagerId string false none none
repositoryId string false none none
repositoryPublicId string false none none
repositoryType string false none none
results [ApiRepositoryComponentEvaluationResult] false none none

ApiRepositoryComponentEvaluationRequestList

{
  "format": "string",
  "components": [
    {
      "pathname": "string",
      "hash": "string",
      "packageUrl": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
format string false none none
components [ApiRepositoryComponentEvaluationRequest] false none none

ApiFirewallReleaseQuarantineConfigDTO

{
  "id": "string",
  "name": "string",
  "autoReleaseQuarantineEnabled": true
}

Properties

Name Type Required Restrictions Description
id string false none none
name string false none none
autoReleaseQuarantineEnabled boolean false none none

ApiFirewallReleaseQuarantineSummaryDTO

{
  "autoReleaseQuarantineCountMTD": 0,
  "autoReleaseQuarantineCountYTD": 0
}

Properties

Name Type Required Restrictions Description
autoReleaseQuarantineCountMTD integer(int64) false none none
autoReleaseQuarantineCountYTD integer(int64) false none none

ApiFirewallQuarantineSummaryDTO

{
  "repositoryCount": 0,
  "quarantineEnabledRepositoryCount": 0,
  "quarantineEnabled": true,
  "totalComponentCount": 0,
  "quarantinedComponentCount": 0
}

Properties

Name Type Required Restrictions Description
repositoryCount integer(int64) false none none
quarantineEnabledRepositoryCount integer(int64) false none none
quarantineEnabled boolean false none none
totalComponentCount integer(int64) false none none
quarantinedComponentCount integer(int64) false none none

ApiRepositoryContainerDTO

{
  "id": "string",
  "name": "string"
}

Properties

Name Type Required Restrictions Description
id string false none none
name string false none none

ApiRepositoryManagerListDTO

{
  "repositoryManagers": [
    {
      "id": "string",
      "name": "string",
      "instanceId": "string",
      "productName": "string",
      "productVersion": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
repositoryManagers [ApiRepositoryManagerDTO] false none none

ApiHashComponentIdentifierDTO

{
  "hash": "string",
  "comment": "string",
  "createTime": "2019-08-24T14:15:22Z",
  "componentIdentifier": {
    "format": "string",
    "coordinates": {
      "property1": "string",
      "property2": "string"
    }
  },
  "packageUrl": "string"
}

Properties

Name Type Required Restrictions Description
hash string false none none
comment string false none none
createTime string(date-time) false none none
componentIdentifier ApiComponentIdentifierDTOV2 false none none
packageUrl string false none none

ApiHashComponentIdentifiersDTO

{
  "componentClaims": [
    {
      "hash": "string",
      "comment": "string",
      "createTime": "2019-08-24T14:15:22Z",
      "componentIdentifier": {
        "format": "string",
        "coordinates": {
          "property1": "string",
          "property2": "string"
        }
      },
      "packageUrl": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
componentClaims [ApiHashComponentIdentifierDTO] false none none

ApiJiraConfigurationDTO

{
  "url": "string",
  "username": "string",
  "password": [
    "string"
  ],
  "customFields": {
    "property1": {},
    "property2": {}
  }
}

Properties

Name Type Required Restrictions Description
url string false none none
username string false none none
password [string] false none none
customFields object false none none
» additionalProperties object false none none

JsonNode

{}

Properties

None

ApiLabelDTO

{
  "id": "string",
  "label": "string",
  "description": "string",
  "color": "string",
  "ownerId": "string",
  "ownerType": "string"
}

Properties

Name Type Required Restrictions Description
id string false none none
label string false none none
description string false none none
color string false none none
ownerId string false none none
ownerType string false none none

ApplicableContext

{
  "id": "string",
  "name": "string",
  "type": "application",
  "children": [
    {
      "id": "string",
      "name": "string",
      "type": "application",
      "children": []
    }
  ]
}

Properties

Name Type Required Restrictions Description
id string false none none
name string false none none
type string false none none
children [ApplicableContext] false none none

Enumerated Values

Property Value
type application
type organization
type repository_container
type repository_manager
type repository
type global

ApplicableLabels

{
  "labelsByOwner": [
    {
      "ownerId": "string",
      "ownerName": "string",
      "ownerType": "application",
      "labels": [
        {
          "id": "string",
          "label": "string",
          "description": "string",
          "color": "string",
          "ownerId": "string",
          "ownerType": "string"
        }
      ]
    }
  ]
}

Properties

Name Type Required Restrictions Description
labelsByOwner [LabelsByOwner] false none none

LabelsByOwner

{
  "ownerId": "string",
  "ownerName": "string",
  "ownerType": "application",
  "labels": [
    {
      "id": "string",
      "label": "string",
      "description": "string",
      "color": "string",
      "ownerId": "string",
      "ownerType": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
ownerId string false none none
ownerName string false none none
ownerType string false none none
labels [ApiLabelDTO] false none none

Enumerated Values

Property Value
ownerType application
ownerType organization
ownerType repository_container
ownerType repository_manager
ownerType repository
ownerType global

AttributionReportTemplateDTO

{
  "id": "string",
  "templateName": "string",
  "documentTitle": "string",
  "header": "string",
  "footer": "string",
  "includeTableOfContents": true,
  "includeAppendix": true,
  "includeStandardLicenseTexts": true,
  "includeSonatypeSpecialLicenses": true,
  "lastUpdatedAt": "2019-08-24T14:15:22Z",
  "includeInnerSource": true
}

Properties

Name Type Required Restrictions Description
id string false none none
templateName string false none none
documentTitle string false none none
header string false none none
footer string false none none
includeTableOfContents boolean false none none
includeAppendix boolean false none none
includeStandardLicenseTexts boolean false none none
includeSonatypeSpecialLicenses boolean false none none
lastUpdatedAt string(date-time) false none none
includeInnerSource boolean false none none

ApiLicenseLegalApplicationReportDTO

{
  "components": [
    {
      "packageUrl": "string",
      "hash": "string",
      "componentIdentifier": {
        "format": "string",
        "coordinates": {
          "property1": "string",
          "property2": "string"
        }
      },
      "displayName": "string",
      "licenseLegalData": {
        "declaredLicenses": [
          "string"
        ],
        "observedLicenses": [
          "string"
        ],
        "effectiveLicenses": [
          "string"
        ],
        "highestEffectiveLicenseThreatGroup": {
          "licenseThreatGroupName": "string",
          "licenseThreatGroupLevel": 0,
          "licenseThreatGroupCategory": "string"
        },
        "copyrights": [
          {
            "id": "string",
            "content": "string",
            "originalContentHash": "string",
            "status": "enabled"
          }
        ],
        "licenseFiles": [
          {
            "id": "string",
            "relPath": "string",
            "content": "string",
            "originalContentHash": "string",
            "status": "enabled"
          }
        ],
        "noticeFiles": [
          {
            "id": "string",
            "relPath": "string",
            "content": "string",
            "originalContentHash": "string",
            "status": "enabled"
          }
        ],
        "obligations": [
          {
            "id": "string",
            "name": "string",
            "status": "OPEN",
            "comment": "string",
            "componentIdentifier": {
              "format": "string",
              "coordinates": {
                "property1": "string",
                "property2": "string"
              }
            },
            "packageUrl": "string",
            "ownerId": "string",
            "lastUpdatedAt": "2019-08-24T14:15:22Z",
            "lastUpdatedByUsername": "string"
          }
        ],
        "attributions": [
          {
            "id": "string",
            "componentIdentifier": {
              "format": "string",
              "coordinates": {
                "property1": "string",
                "property2": "string"
              }
            },
            "packageUrl": "string",
            "ownerId": "string",
            "obligationName": "string",
            "content": "string",
            "lastUpdatedAt": "2019-08-24T14:15:22Z",
            "lastUpdatedByUsername": "string"
          }
        ],
        "sourceLinks": [
          {
            "id": "string",
            "content": "string",
            "originalContent": "string",
            "status": "enabled"
          }
        ],
        "effectiveLicenseStatus": "string",
        "componentCopyrightId": "string",
        "componentCopyrightScopeOwnerId": "string",
        "componentCopyrightLastUpdatedByUsername": "string",
        "componentCopyrightLastUpdatedAt": "2019-08-24T14:15:22Z",
        "componentLicensesId": "string",
        "componentLicensesScopeOwnerId": "string",
        "componentLicensesLastUpdatedByUsername": "string",
        "componentLicensesLastUpdatedAt": "2019-08-24T14:15:22Z",
        "componentNoticesId": "string",
        "componentNoticesScopeOwnerId": "string",
        "componentNoticesLastUpdatedByUsername": "string",
        "componentNoticesLastUpdatedAt": "2019-08-24T14:15:22Z"
      },
      "stageScans": [
        {
          "stageName": "string",
          "scanId": "string",
          "scanDate": "2019-08-24T14:15:22Z"
        }
      ]
    }
  ],
  "licenseLegalMetadata": [
    {
      "licenseId": "string",
      "licenseName": "string",
      "licenseText": "string",
      "obligations": [
        {
          "name": "string",
          "obligationTexts": [
            "string"
          ]
        }
      ],
      "threatGroup": {
        "name": "string",
        "threatLevel": 0
      },
      "isMulti": true,
      "singleLicenseIds": [
        "string"
      ]
    }
  ]
}

Properties

Name Type Required Restrictions Description
components [ApiLicenseLegalComponentDTO] false none none
licenseLegalMetadata [ApiLicenseLegalMetadataDTO] false none none

ApiLicenseLegalComponentDTO

{
  "packageUrl": "string",
  "hash": "string",
  "componentIdentifier": {
    "format": "string",
    "coordinates": {
      "property1": "string",
      "property2": "string"
    }
  },
  "displayName": "string",
  "licenseLegalData": {
    "declaredLicenses": [
      "string"
    ],
    "observedLicenses": [
      "string"
    ],
    "effectiveLicenses": [
      "string"
    ],
    "highestEffectiveLicenseThreatGroup": {
      "licenseThreatGroupName": "string",
      "licenseThreatGroupLevel": 0,
      "licenseThreatGroupCategory": "string"
    },
    "copyrights": [
      {
        "id": "string",
        "content": "string",
        "originalContentHash": "string",
        "status": "enabled"
      }
    ],
    "licenseFiles": [
      {
        "id": "string",
        "relPath": "string",
        "content": "string",
        "originalContentHash": "string",
        "status": "enabled"
      }
    ],
    "noticeFiles": [
      {
        "id": "string",
        "relPath": "string",
        "content": "string",
        "originalContentHash": "string",
        "status": "enabled"
      }
    ],
    "obligations": [
      {
        "id": "string",
        "name": "string",
        "status": "OPEN",
        "comment": "string",
        "componentIdentifier": {
          "format": "string",
          "coordinates": {
            "property1": "string",
            "property2": "string"
          }
        },
        "packageUrl": "string",
        "ownerId": "string",
        "lastUpdatedAt": "2019-08-24T14:15:22Z",
        "lastUpdatedByUsername": "string"
      }
    ],
    "attributions": [
      {
        "id": "string",
        "componentIdentifier": {
          "format": "string",
          "coordinates": {
            "property1": "string",
            "property2": "string"
          }
        },
        "packageUrl": "string",
        "ownerId": "string",
        "obligationName": "string",
        "content": "string",
        "lastUpdatedAt": "2019-08-24T14:15:22Z",
        "lastUpdatedByUsername": "string"
      }
    ],
    "sourceLinks": [
      {
        "id": "string",
        "content": "string",
        "originalContent": "string",
        "status": "enabled"
      }
    ],
    "effectiveLicenseStatus": "string",
    "componentCopyrightId": "string",
    "componentCopyrightScopeOwnerId": "string",
    "componentCopyrightLastUpdatedByUsername": "string",
    "componentCopyrightLastUpdatedAt": "2019-08-24T14:15:22Z",
    "componentLicensesId": "string",
    "componentLicensesScopeOwnerId": "string",
    "componentLicensesLastUpdatedByUsername": "string",
    "componentLicensesLastUpdatedAt": "2019-08-24T14:15:22Z",
    "componentNoticesId": "string",
    "componentNoticesScopeOwnerId": "string",
    "componentNoticesLastUpdatedByUsername": "string",
    "componentNoticesLastUpdatedAt": "2019-08-24T14:15:22Z"
  },
  "stageScans": [
    {
      "stageName": "string",
      "scanId": "string",
      "scanDate": "2019-08-24T14:15:22Z"
    }
  ]
}

Properties

Name Type Required Restrictions Description
packageUrl string false none none
hash string false none none
componentIdentifier ApiComponentIdentifierDTOV2 false none none
displayName string false none none
licenseLegalData ApiLicenseLegalDataDTO false none none
stageScans [ApiLicenseLegalStageScanDTO] false none none

ApiLicenseLegalCopyrightDTO

{
  "id": "string",
  "content": "string",
  "originalContentHash": "string",
  "status": "enabled"
}

Properties

Name Type Required Restrictions Description
id string false none none
content string false none none
originalContentHash string false none none
status string false none none

Enumerated Values

Property Value
status enabled
status disabled

ApiLicenseLegalDataDTO

{
  "declaredLicenses": [
    "string"
  ],
  "observedLicenses": [
    "string"
  ],
  "effectiveLicenses": [
    "string"
  ],
  "highestEffectiveLicenseThreatGroup": {
    "licenseThreatGroupName": "string",
    "licenseThreatGroupLevel": 0,
    "licenseThreatGroupCategory": "string"
  },
  "copyrights": [
    {
      "id": "string",
      "content": "string",
      "originalContentHash": "string",
      "status": "enabled"
    }
  ],
  "licenseFiles": [
    {
      "id": "string",
      "relPath": "string",
      "content": "string",
      "originalContentHash": "string",
      "status": "enabled"
    }
  ],
  "noticeFiles": [
    {
      "id": "string",
      "relPath": "string",
      "content": "string",
      "originalContentHash": "string",
      "status": "enabled"
    }
  ],
  "obligations": [
    {
      "id": "string",
      "name": "string",
      "status": "OPEN",
      "comment": "string",
      "componentIdentifier": {
        "format": "string",
        "coordinates": {
          "property1": "string",
          "property2": "string"
        }
      },
      "packageUrl": "string",
      "ownerId": "string",
      "lastUpdatedAt": "2019-08-24T14:15:22Z",
      "lastUpdatedByUsername": "string"
    }
  ],
  "attributions": [
    {
      "id": "string",
      "componentIdentifier": {
        "format": "string",
        "coordinates": {
          "property1": "string",
          "property2": "string"
        }
      },
      "packageUrl": "string",
      "ownerId": "string",
      "obligationName": "string",
      "content": "string",
      "lastUpdatedAt": "2019-08-24T14:15:22Z",
      "lastUpdatedByUsername": "string"
    }
  ],
  "sourceLinks": [
    {
      "id": "string",
      "content": "string",
      "originalContent": "string",
      "status": "enabled"
    }
  ],
  "effectiveLicenseStatus": "string",
  "componentCopyrightId": "string",
  "componentCopyrightScopeOwnerId": "string",
  "componentCopyrightLastUpdatedByUsername": "string",
  "componentCopyrightLastUpdatedAt": "2019-08-24T14:15:22Z",
  "componentLicensesId": "string",
  "componentLicensesScopeOwnerId": "string",
  "componentLicensesLastUpdatedByUsername": "string",
  "componentLicensesLastUpdatedAt": "2019-08-24T14:15:22Z",
  "componentNoticesId": "string",
  "componentNoticesScopeOwnerId": "string",
  "componentNoticesLastUpdatedByUsername": "string",
  "componentNoticesLastUpdatedAt": "2019-08-24T14:15:22Z"
}

Properties

Name Type Required Restrictions Description
declaredLicenses [string] false none none
observedLicenses [string] false none none
effectiveLicenses [string] false none none
highestEffectiveLicenseThreatGroup ApiLicenseThreatDTOV2 false none none
copyrights [ApiLicenseLegalCopyrightDTO] false none none
licenseFiles [ApiLicenseLegalFileDTO] false none none
noticeFiles [ApiLicenseLegalFileDTO] false none none
obligations [ApiLicenseLegalObligationDTO] false none none
attributions [ComponentObligationAttributionDTO] false none none
sourceLinks [LegalSourceLinkDTO] false none none
effectiveLicenseStatus string false none none
componentCopyrightId string false none none
componentCopyrightScopeOwnerId string false none none
componentCopyrightLastUpdatedByUsername string false none none
componentCopyrightLastUpdatedAt string(date-time) false none none
componentLicensesId string false none none
componentLicensesScopeOwnerId string false none none
componentLicensesLastUpdatedByUsername string false none none
componentLicensesLastUpdatedAt string(date-time) false none none
componentNoticesId string false none none
componentNoticesScopeOwnerId string false none none
componentNoticesLastUpdatedByUsername string false none none
componentNoticesLastUpdatedAt string(date-time) false none none

ApiLicenseLegalFileDTO

{
  "id": "string",
  "relPath": "string",
  "content": "string",
  "originalContentHash": "string",
  "status": "enabled"
}

Properties

Name Type Required Restrictions Description
id string false none none
relPath string false none none
content string false none none
originalContentHash string false none none
status string false none none

Enumerated Values

Property Value
status enabled
status disabled

ApiLicenseLegalMetadataDTO

{
  "licenseId": "string",
  "licenseName": "string",
  "licenseText": "string",
  "obligations": [
    {
      "name": "string",
      "obligationTexts": [
        "string"
      ]
    }
  ],
  "threatGroup": {
    "name": "string",
    "threatLevel": 0
  },
  "isMulti": true,
  "singleLicenseIds": [
    "string"
  ]
}

Properties

Name Type Required Restrictions Description
licenseId string false none none
licenseName string false none none
licenseText string false none none
obligations [LicenseObligationDTO] false none none
threatGroup LicenseThreatGroupDTO false none none
isMulti boolean false none none
singleLicenseIds [string] false none none

ApiLicenseLegalObligationDTO

{
  "id": "string",
  "name": "string",
  "status": "OPEN",
  "comment": "string",
  "componentIdentifier": {
    "format": "string",
    "coordinates": {
      "property1": "string",
      "property2": "string"
    }
  },
  "packageUrl": "string",
  "ownerId": "string",
  "lastUpdatedAt": "2019-08-24T14:15:22Z",
  "lastUpdatedByUsername": "string"
}

Properties

Name Type Required Restrictions Description
id string false none none
name string false none none
status string false none none
comment string false none none
componentIdentifier ApiComponentIdentifierDTOV2 false none none
packageUrl string false none none
ownerId string false none none
lastUpdatedAt string(date-time) false none none
lastUpdatedByUsername string false none none

Enumerated Values

Property Value
status OPEN
status IGNORED
status FLAGGED
status FULFILLED

ApiLicenseLegalStageScanDTO

{
  "stageName": "string",
  "scanId": "string",
  "scanDate": "2019-08-24T14:15:22Z"
}

Properties

Name Type Required Restrictions Description
stageName string false none none
scanId string false none none
scanDate string(date-time) false none none

ApiLicenseThreatDTOV2

{
  "licenseThreatGroupName": "string",
  "licenseThreatGroupLevel": 0,
  "licenseThreatGroupCategory": "string"
}

Properties

Name Type Required Restrictions Description
licenseThreatGroupName string false none none
licenseThreatGroupLevel integer(int32) false none none
licenseThreatGroupCategory string false none none

ComponentObligationAttributionDTO

{
  "id": "string",
  "componentIdentifier": {
    "format": "string",
    "coordinates": {
      "property1": "string",
      "property2": "string"
    }
  },
  "packageUrl": "string",
  "ownerId": "string",
  "obligationName": "string",
  "content": "string",
  "lastUpdatedAt": "2019-08-24T14:15:22Z",
  "lastUpdatedByUsername": "string"
}

Properties

Name Type Required Restrictions Description
id string false none none
componentIdentifier ApiComponentIdentifierDTOV2 false none none
packageUrl string false none none
ownerId string false none none
obligationName string false none none
content string false none none
lastUpdatedAt string(date-time) false none none
lastUpdatedByUsername string false none none

LegalSourceLinkDTO

{
  "id": "string",
  "content": "string",
  "originalContent": "string",
  "status": "enabled"
}

Properties

Name Type Required Restrictions Description
id string false none none
content string false none none
originalContent string false none none
status string false none none

Enumerated Values

Property Value
status enabled
status disabled

LicenseObligationDTO

{
  "name": "string",
  "obligationTexts": [
    "string"
  ]
}

Properties

Name Type Required Restrictions Description
name string false none none
obligationTexts [string] false none none

LicenseThreatGroupDTO

{
  "name": "string",
  "threatLevel": 0
}

Properties

Name Type Required Restrictions Description
name string false none none
threatLevel integer(int32) false none none

ApiLicenseLegalComponentReportDTO

{
  "component": {
    "packageUrl": "string",
    "hash": "string",
    "componentIdentifier": {
      "format": "string",
      "coordinates": {
        "property1": "string",
        "property2": "string"
      }
    },
    "displayName": "string",
    "licenseLegalData": {
      "declaredLicenses": [
        "string"
      ],
      "observedLicenses": [
        "string"
      ],
      "effectiveLicenses": [
        "string"
      ],
      "highestEffectiveLicenseThreatGroup": {
        "licenseThreatGroupName": "string",
        "licenseThreatGroupLevel": 0,
        "licenseThreatGroupCategory": "string"
      },
      "copyrights": [
        {
          "id": "string",
          "content": "string",
          "originalContentHash": "string",
          "status": "enabled"
        }
      ],
      "licenseFiles": [
        {
          "id": "string",
          "relPath": "string",
          "content": "string",
          "originalContentHash": "string",
          "status": "enabled"
        }
      ],
      "noticeFiles": [
        {
          "id": "string",
          "relPath": "string",
          "content": "string",
          "originalContentHash": "string",
          "status": "enabled"
        }
      ],
      "obligations": [
        {
          "id": "string",
          "name": "string",
          "status": "OPEN",
          "comment": "string",
          "componentIdentifier": {
            "format": "string",
            "coordinates": {
              "property1": "string",
              "property2": "string"
            }
          },
          "packageUrl": "string",
          "ownerId": "string",
          "lastUpdatedAt": "2019-08-24T14:15:22Z",
          "lastUpdatedByUsername": "string"
        }
      ],
      "attributions": [
        {
          "id": "string",
          "componentIdentifier": {
            "format": "string",
            "coordinates": {
              "property1": "string",
              "property2": "string"
            }
          },
          "packageUrl": "string",
          "ownerId": "string",
          "obligationName": "string",
          "content": "string",
          "lastUpdatedAt": "2019-08-24T14:15:22Z",
          "lastUpdatedByUsername": "string"
        }
      ],
      "sourceLinks": [
        {
          "id": "string",
          "content": "string",
          "originalContent": "string",
          "status": "enabled"
        }
      ],
      "effectiveLicenseStatus": "string",
      "componentCopyrightId": "string",
      "componentCopyrightScopeOwnerId": "string",
      "componentCopyrightLastUpdatedByUsername": "string",
      "componentCopyrightLastUpdatedAt": "2019-08-24T14:15:22Z",
      "componentLicensesId": "string",
      "componentLicensesScopeOwnerId": "string",
      "componentLicensesLastUpdatedByUsername": "string",
      "componentLicensesLastUpdatedAt": "2019-08-24T14:15:22Z",
      "componentNoticesId": "string",
      "componentNoticesScopeOwnerId": "string",
      "componentNoticesLastUpdatedByUsername": "string",
      "componentNoticesLastUpdatedAt": "2019-08-24T14:15:22Z"
    },
    "stageScans": [
      {
        "stageName": "string",
        "scanId": "string",
        "scanDate": "2019-08-24T14:15:22Z"
      }
    ]
  },
  "licenseLegalMetadata": [
    {
      "licenseId": "string",
      "licenseName": "string",
      "licenseText": "string",
      "obligations": [
        {
          "name": "string",
          "obligationTexts": [
            "string"
          ]
        }
      ],
      "threatGroup": {
        "name": "string",
        "threatLevel": 0
      },
      "isMulti": true,
      "singleLicenseIds": [
        "string"
      ]
    }
  ]
}

Properties

Name Type Required Restrictions Description
component ApiLicenseLegalComponentDTO false none none
licenseLegalMetadata [ApiLicenseLegalMetadataDTO] false none none

ComponentIdentifier

{
  "format": "string",
  "coordinates": {
    "property1": "string",
    "property2": "string"
  }
}

Properties

Name Type Required Restrictions Description
format string false none none
coordinates object false none none
» additionalProperties string false none none

BodyPart

{
  "contentDisposition": {
    "type": "string",
    "parameters": {
      "property1": "string",
      "property2": "string"
    },
    "fileName": "string",
    "creationDate": "2019-08-24T14:15:22Z",
    "modificationDate": "2019-08-24T14:15:22Z",
    "readDate": "2019-08-24T14:15:22Z",
    "size": 0
  },
  "entity": {},
  "headers": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  },
  "mediaType": {
    "type": "string",
    "subtype": "string",
    "parameters": {
      "property1": "string",
      "property2": "string"
    },
    "wildcardType": true,
    "wildcardSubtype": true
  },
  "messageBodyWorkers": {},
  "parent": {
    "contentDisposition": {
      "type": "string",
      "parameters": {
        "property1": "string",
        "property2": "string"
      },
      "fileName": "string",
      "creationDate": "2019-08-24T14:15:22Z",
      "modificationDate": "2019-08-24T14:15:22Z",
      "readDate": "2019-08-24T14:15:22Z",
      "size": 0
    },
    "entity": {},
    "headers": {
      "property1": [
        "string"
      ],
      "property2": [
        "string"
      ]
    },
    "mediaType": {
      "type": "string",
      "subtype": "string",
      "parameters": {
        "property1": "string",
        "property2": "string"
      },
      "wildcardType": true,
      "wildcardSubtype": true
    },
    "messageBodyWorkers": {},
    "parent": {},
    "providers": {},
    "bodyParts": [
      {
        "contentDisposition": {
          "type": "string",
          "parameters": {
            "property1": "string",
            "property2": "string"
          },
          "fileName": "string",
          "creationDate": "2019-08-24T14:15:22Z",
          "modificationDate": "2019-08-24T14:15:22Z",
          "readDate": "2019-08-24T14:15:22Z",
          "size": 0
        },
        "entity": {},
        "headers": {
          "property1": [
            "string"
          ],
          "property2": [
            "string"
          ]
        },
        "mediaType": {
          "type": "string",
          "subtype": "string",
          "parameters": {
            "property1": "string",
            "property2": "string"
          },
          "wildcardType": true,
          "wildcardSubtype": true
        },
        "messageBodyWorkers": {},
        "parent": {},
        "providers": {},
        "parameterizedHeaders": {
          "property1": [
            {
              "value": "string",
              "parameters": {
                "property1": "string",
                "property2": "string"
              }
            }
          ],
          "property2": [
            {
              "value": "string",
              "parameters": {
                "property1": "string",
                "property2": "string"
              }
            }
          ]
        }
      }
    ],
    "parameterizedHeaders": {
      "property1": [
        {
          "value": "string",
          "parameters": {
            "property1": "string",
            "property2": "string"
          }
        }
      ],
      "property2": [
        {
          "value": "string",
          "parameters": {
            "property1": "string",
            "property2": "string"
          }
        }
      ]
    }
  },
  "providers": {},
  "parameterizedHeaders": {
    "property1": [
      {
        "value": "string",
        "parameters": {
          "property1": "string",
          "property2": "string"
        }
      }
    ],
    "property2": [
      {
        "value": "string",
        "parameters": {
          "property1": "string",
          "property2": "string"
        }
      }
    ]
  }
}

Properties

Name Type Required Restrictions Description
contentDisposition ContentDisposition false none none
entity object false none none
headers object false none none
» additionalProperties [string] false none none
mediaType object false none none
» type string false none none
» subtype string false none none
» parameters object false none none
»» additionalProperties string false none none
» wildcardType boolean false none none
» wildcardSubtype boolean false none none
messageBodyWorkers MessageBodyWorkers false none none
parent MultiPart false none none
providers object false none none
parameterizedHeaders object false none none
» additionalProperties [ParameterizedHeader] false none none

ContentDisposition

{
  "type": "string",
  "parameters": {
    "property1": "string",
    "property2": "string"
  },
  "fileName": "string",
  "creationDate": "2019-08-24T14:15:22Z",
  "modificationDate": "2019-08-24T14:15:22Z",
  "readDate": "2019-08-24T14:15:22Z",
  "size": 0
}

Properties

Name Type Required Restrictions Description
type string false none none
parameters object false none none
» additionalProperties string false none none
fileName string false none none
creationDate string(date-time) false none none
modificationDate string(date-time) false none none
readDate string(date-time) false none none
size integer(int64) false none none

FormDataBodyPart

{
  "contentDisposition": {
    "type": "string",
    "parameters": {
      "property1": "string",
      "property2": "string"
    },
    "fileName": "string",
    "creationDate": "2019-08-24T14:15:22Z",
    "modificationDate": "2019-08-24T14:15:22Z",
    "readDate": "2019-08-24T14:15:22Z",
    "size": 0
  },
  "entity": {},
  "headers": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  },
  "mediaType": {
    "type": "string",
    "subtype": "string",
    "parameters": {
      "property1": "string",
      "property2": "string"
    },
    "wildcardType": true,
    "wildcardSubtype": true
  },
  "messageBodyWorkers": {},
  "parent": {
    "contentDisposition": {
      "type": "string",
      "parameters": {
        "property1": "string",
        "property2": "string"
      },
      "fileName": "string",
      "creationDate": "2019-08-24T14:15:22Z",
      "modificationDate": "2019-08-24T14:15:22Z",
      "readDate": "2019-08-24T14:15:22Z",
      "size": 0
    },
    "entity": {},
    "headers": {
      "property1": [
        "string"
      ],
      "property2": [
        "string"
      ]
    },
    "mediaType": {
      "type": "string",
      "subtype": "string",
      "parameters": {
        "property1": "string",
        "property2": "string"
      },
      "wildcardType": true,
      "wildcardSubtype": true
    },
    "messageBodyWorkers": {},
    "parent": {},
    "providers": {},
    "bodyParts": [
      {
        "contentDisposition": {
          "type": "string",
          "parameters": {
            "property1": "string",
            "property2": "string"
          },
          "fileName": "string",
          "creationDate": "2019-08-24T14:15:22Z",
          "modificationDate": "2019-08-24T14:15:22Z",
          "readDate": "2019-08-24T14:15:22Z",
          "size": 0
        },
        "entity": {},
        "headers": {
          "property1": [
            "string"
          ],
          "property2": [
            "string"
          ]
        },
        "mediaType": {
          "type": "string",
          "subtype": "string",
          "parameters": {
            "property1": "string",
            "property2": "string"
          },
          "wildcardType": true,
          "wildcardSubtype": true
        },
        "messageBodyWorkers": {},
        "parent": {},
        "providers": {},
        "parameterizedHeaders": {
          "property1": [
            {
              "value": "string",
              "parameters": {
                "property1": "string",
                "property2": "string"
              }
            }
          ],
          "property2": [
            {
              "value": "string",
              "parameters": {
                "property1": "string",
                "property2": "string"
              }
            }
          ]
        }
      }
    ],
    "parameterizedHeaders": {
      "property1": [
        {
          "value": "string",
          "parameters": {
            "property1": "string",
            "property2": "string"
          }
        }
      ],
      "property2": [
        {
          "value": "string",
          "parameters": {
            "property1": "string",
            "property2": "string"
          }
        }
      ]
    }
  },
  "providers": {},
  "simple": true,
  "name": "string",
  "value": "string",
  "formDataContentDisposition": {
    "type": "string",
    "parameters": {
      "property1": "string",
      "property2": "string"
    },
    "fileName": "string",
    "creationDate": "2019-08-24T14:15:22Z",
    "modificationDate": "2019-08-24T14:15:22Z",
    "readDate": "2019-08-24T14:15:22Z",
    "size": 0,
    "name": "string"
  },
  "parameterizedHeaders": {
    "property1": [
      {
        "value": "string",
        "parameters": {
          "property1": "string",
          "property2": "string"
        }
      }
    ],
    "property2": [
      {
        "value": "string",
        "parameters": {
          "property1": "string",
          "property2": "string"
        }
      }
    ]
  }
}

Properties

Name Type Required Restrictions Description
contentDisposition ContentDisposition false none none
entity object false none none
headers object false none none
» additionalProperties [string] false none none
mediaType object false none none
» type string false none none
» subtype string false none none
» parameters object false none none
»» additionalProperties string false none none
» wildcardType boolean false none none
» wildcardSubtype boolean false none none
messageBodyWorkers MessageBodyWorkers false none none
parent MultiPart false none none
providers object false none none
simple boolean false none none
name string false none none
value string false none none
formDataContentDisposition FormDataContentDisposition false none none
parameterizedHeaders object false none none
» additionalProperties [ParameterizedHeader] false none none

FormDataContentDisposition

{
  "type": "string",
  "parameters": {
    "property1": "string",
    "property2": "string"
  },
  "fileName": "string",
  "creationDate": "2019-08-24T14:15:22Z",
  "modificationDate": "2019-08-24T14:15:22Z",
  "readDate": "2019-08-24T14:15:22Z",
  "size": 0,
  "name": "string"
}

Properties

Name Type Required Restrictions Description
type string false none none
parameters object false none none
» additionalProperties string false none none
fileName string false none none
creationDate string(date-time) false none none
modificationDate string(date-time) false none none
readDate string(date-time) false none none
size integer(int64) false none none
name string false none none

FormDataMultiPart

{
  "contentDisposition": {
    "type": "string",
    "parameters": {
      "property1": "string",
      "property2": "string"
    },
    "fileName": "string",
    "creationDate": "2019-08-24T14:15:22Z",
    "modificationDate": "2019-08-24T14:15:22Z",
    "readDate": "2019-08-24T14:15:22Z",
    "size": 0
  },
  "entity": {},
  "headers": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  },
  "mediaType": {
    "type": "string",
    "subtype": "string",
    "parameters": {
      "property1": "string",
      "property2": "string"
    },
    "wildcardType": true,
    "wildcardSubtype": true
  },
  "messageBodyWorkers": {},
  "parent": {
    "contentDisposition": {
      "type": "string",
      "parameters": {
        "property1": "string",
        "property2": "string"
      },
      "fileName": "string",
      "creationDate": "2019-08-24T14:15:22Z",
      "modificationDate": "2019-08-24T14:15:22Z",
      "readDate": "2019-08-24T14:15:22Z",
      "size": 0
    },
    "entity": {},
    "headers": {
      "property1": [
        "string"
      ],
      "property2": [
        "string"
      ]
    },
    "mediaType": {
      "type": "string",
      "subtype": "string",
      "parameters": {
        "property1": "string",
        "property2": "string"
      },
      "wildcardType": true,
      "wildcardSubtype": true
    },
    "messageBodyWorkers": {},
    "parent": {},
    "providers": {},
    "bodyParts": [
      {
        "contentDisposition": {
          "type": "string",
          "parameters": {
            "property1": "string",
            "property2": "string"
          },
          "fileName": "string",
          "creationDate": "2019-08-24T14:15:22Z",
          "modificationDate": "2019-08-24T14:15:22Z",
          "readDate": "2019-08-24T14:15:22Z",
          "size": 0
        },
        "entity": {},
        "headers": {
          "property1": [
            "string"
          ],
          "property2": [
            "string"
          ]
        },
        "mediaType": {
          "type": "string",
          "subtype": "string",
          "parameters": {
            "property1": "string",
            "property2": "string"
          },
          "wildcardType": true,
          "wildcardSubtype": true
        },
        "messageBodyWorkers": {},
        "parent": {},
        "providers": {},
        "parameterizedHeaders": {
          "property1": [
            {
              "value": "string",
              "parameters": {
                "property1": "string",
                "property2": "string"
              }
            }
          ],
          "property2": [
            {
              "value": "string",
              "parameters": {
                "property1": "string",
                "property2": "string"
              }
            }
          ]
        }
      }
    ],
    "parameterizedHeaders": {
      "property1": [
        {
          "value": "string",
          "parameters": {
            "property1": "string",
            "property2": "string"
          }
        }
      ],
      "property2": [
        {
          "value": "string",
          "parameters": {
            "property1": "string",
            "property2": "string"
          }
        }
      ]
    }
  },
  "providers": {},
  "bodyParts": [
    {
      "contentDisposition": {
        "type": "string",
        "parameters": {
          "property1": "string",
          "property2": "string"
        },
        "fileName": "string",
        "creationDate": "2019-08-24T14:15:22Z",
        "modificationDate": "2019-08-24T14:15:22Z",
        "readDate": "2019-08-24T14:15:22Z",
        "size": 0
      },
      "entity": {},
      "headers": {
        "property1": [
          "string"
        ],
        "property2": [
          "string"
        ]
      },
      "mediaType": {
        "type": "string",
        "subtype": "string",
        "parameters": {
          "property1": "string",
          "property2": "string"
        },
        "wildcardType": true,
        "wildcardSubtype": true
      },
      "messageBodyWorkers": {},
      "parent": {
        "contentDisposition": {
          "type": "string",
          "parameters": {
            "property1": "string",
            "property2": "string"
          },
          "fileName": "string",
          "creationDate": "2019-08-24T14:15:22Z",
          "modificationDate": "2019-08-24T14:15:22Z",
          "readDate": "2019-08-24T14:15:22Z",
          "size": 0
        },
        "entity": {},
        "headers": {
          "property1": [
            "string"
          ],
          "property2": [
            "string"
          ]
        },
        "mediaType": {
          "type": "string",
          "subtype": "string",
          "parameters": {
            "property1": "string",
            "property2": "string"
          },
          "wildcardType": true,
          "wildcardSubtype": true
        },
        "messageBodyWorkers": {},
        "parent": {},
        "providers": {},
        "bodyParts": [
          {}
        ],
        "parameterizedHeaders": {
          "property1": [
            {
              "value": "string",
              "parameters": {
                "property1": "string",
                "property2": "string"
              }
            }
          ],
          "property2": [
            {
              "value": "string",
              "parameters": {
                "property1": "string",
                "property2": "string"
              }
            }
          ]
        }
      },
      "providers": {},
      "parameterizedHeaders": {
        "property1": [
          {
            "value": "string",
            "parameters": {
              "property1": "string",
              "property2": "string"
            }
          }
        ],
        "property2": [
          {
            "value": "string",
            "parameters": {
              "property1": "string",
              "property2": "string"
            }
          }
        ]
      }
    }
  ],
  "fields": {
    "property1": [
      {
        "contentDisposition": {
          "type": "string",
          "parameters": {
            "property1": "string",
            "property2": "string"
          },
          "fileName": "string",
          "creationDate": "2019-08-24T14:15:22Z",
          "modificationDate": "2019-08-24T14:15:22Z",
          "readDate": "2019-08-24T14:15:22Z",
          "size": 0
        },
        "entity": {},
        "headers": {
          "property1": [
            "string"
          ],
          "property2": [
            "string"
          ]
        },
        "mediaType": {
          "type": "string",
          "subtype": "string",
          "parameters": {
            "property1": "string",
            "property2": "string"
          },
          "wildcardType": true,
          "wildcardSubtype": true
        },
        "messageBodyWorkers": {},
        "parent": {
          "contentDisposition": {
            "type": "string",
            "parameters": {
              "property1": "string",
              "property2": "string"
            },
            "fileName": "string",
            "creationDate": "2019-08-24T14:15:22Z",
            "modificationDate": "2019-08-24T14:15:22Z",
            "readDate": "2019-08-24T14:15:22Z",
            "size": 0
          },
          "entity": {},
          "headers": {
            "property1": [
              "string"
            ],
            "property2": [
              "string"
            ]
          },
          "mediaType": {
            "type": "string",
            "subtype": "string",
            "parameters": {
              "property1": "string",
              "property2": "string"
            },
            "wildcardType": true,
            "wildcardSubtype": true
          },
          "messageBodyWorkers": {},
          "parent": {},
          "providers": {},
          "bodyParts": [
            {
              "contentDisposition": {
                "type": "string",
                "parameters": {
                  "property1": "string",
                  "property2": "string"
                },
                "fileName": "string",
                "creationDate": "2019-08-24T14:15:22Z",
                "modificationDate": "2019-08-24T14:15:22Z",
                "readDate": "2019-08-24T14:15:22Z",
                "size": 0
              },
              "entity": {},
              "headers": {
                "property1": [
                  "string"
                ],
                "property2": [
                  "string"
                ]
              },
              "mediaType": {
                "type": "string",
                "subtype": "string",
                "parameters": {
                  "property1": "string",
                  "property2": "string"
                },
                "wildcardType": true,
                "wildcardSubtype": true
              },
              "messageBodyWorkers": {},
              "parent": {},
              "providers": {},
              "parameterizedHeaders": {
                "property1": [
                  {
                    "value": "string",
                    "parameters": {}
                  }
                ],
                "property2": [
                  {
                    "value": "string",
                    "parameters": {}
                  }
                ]
              }
            }
          ],
          "parameterizedHeaders": {
            "property1": [
              {
                "value": "string",
                "parameters": {
                  "property1": "string",
                  "property2": "string"
                }
              }
            ],
            "property2": [
              {
                "value": "string",
                "parameters": {
                  "property1": "string",
                  "property2": "string"
                }
              }
            ]
          }
        },
        "providers": {},
        "simple": true,
        "name": "string",
        "value": "string",
        "formDataContentDisposition": {
          "type": "string",
          "parameters": {
            "property1": "string",
            "property2": "string"
          },
          "fileName": "string",
          "creationDate": "2019-08-24T14:15:22Z",
          "modificationDate": "2019-08-24T14:15:22Z",
          "readDate": "2019-08-24T14:15:22Z",
          "size": 0,
          "name": "string"
        },
        "parameterizedHeaders": {
          "property1": [
            {
              "value": "string",
              "parameters": {
                "property1": "string",
                "property2": "string"
              }
            }
          ],
          "property2": [
            {
              "value": "string",
              "parameters": {
                "property1": "string",
                "property2": "string"
              }
            }
          ]
        }
      }
    ],
    "property2": [
      {
        "contentDisposition": {
          "type": "string",
          "parameters": {
            "property1": "string",
            "property2": "string"
          },
          "fileName": "string",
          "creationDate": "2019-08-24T14:15:22Z",
          "modificationDate": "2019-08-24T14:15:22Z",
          "readDate": "2019-08-24T14:15:22Z",
          "size": 0
        },
        "entity": {},
        "headers": {
          "property1": [
            "string"
          ],
          "property2": [
            "string"
          ]
        },
        "mediaType": {
          "type": "string",
          "subtype": "string",
          "parameters": {
            "property1": "string",
            "property2": "string"
          },
          "wildcardType": true,
          "wildcardSubtype": true
        },
        "messageBodyWorkers": {},
        "parent": {
          "contentDisposition": {
            "type": "string",
            "parameters": {
              "property1": "string",
              "property2": "string"
            },
            "fileName": "string",
            "creationDate": "2019-08-24T14:15:22Z",
            "modificationDate": "2019-08-24T14:15:22Z",
            "readDate": "2019-08-24T14:15:22Z",
            "size": 0
          },
          "entity": {},
          "headers": {
            "property1": [
              "string"
            ],
            "property2": [
              "string"
            ]
          },
          "mediaType": {
            "type": "string",
            "subtype": "string",
            "parameters": {
              "property1": "string",
              "property2": "string"
            },
            "wildcardType": true,
            "wildcardSubtype": true
          },
          "messageBodyWorkers": {},
          "parent": {},
          "providers": {},
          "bodyParts": [
            {
              "contentDisposition": {
                "type": "string",
                "parameters": {
                  "property1": "string",
                  "property2": "string"
                },
                "fileName": "string",
                "creationDate": "2019-08-24T14:15:22Z",
                "modificationDate": "2019-08-24T14:15:22Z",
                "readDate": "2019-08-24T14:15:22Z",
                "size": 0
              },
              "entity": {},
              "headers": {
                "property1": [
                  "string"
                ],
                "property2": [
                  "string"
                ]
              },
              "mediaType": {
                "type": "string",
                "subtype": "string",
                "parameters": {
                  "property1": "string",
                  "property2": "string"
                },
                "wildcardType": true,
                "wildcardSubtype": true
              },
              "messageBodyWorkers": {},
              "parent": {},
              "providers": {},
              "parameterizedHeaders": {
                "property1": [
                  {
                    "value": "string",
                    "parameters": {}
                  }
                ],
                "property2": [
                  {
                    "value": "string",
                    "parameters": {}
                  }
                ]
              }
            }
          ],
          "parameterizedHeaders": {
            "property1": [
              {
                "value": "string",
                "parameters": {
                  "property1": "string",
                  "property2": "string"
                }
              }
            ],
            "property2": [
              {
                "value": "string",
                "parameters": {
                  "property1": "string",
                  "property2": "string"
                }
              }
            ]
          }
        },
        "providers": {},
        "simple": true,
        "name": "string",
        "value": "string",
        "formDataContentDisposition": {
          "type": "string",
          "parameters": {
            "property1": "string",
            "property2": "string"
          },
          "fileName": "string",
          "creationDate": "2019-08-24T14:15:22Z",
          "modificationDate": "2019-08-24T14:15:22Z",
          "readDate": "2019-08-24T14:15:22Z",
          "size": 0,
          "name": "string"
        },
        "parameterizedHeaders": {
          "property1": [
            {
              "value": "string",
              "parameters": {
                "property1": "string",
                "property2": "string"
              }
            }
          ],
          "property2": [
            {
              "value": "string",
              "parameters": {
                "property1": "string",
                "property2": "string"
              }
            }
          ]
        }
      }
    ]
  },
  "parameterizedHeaders": {
    "property1": [
      {
        "value": "string",
        "parameters": {
          "property1": "string",
          "property2": "string"
        }
      }
    ],
    "property2": [
      {
        "value": "string",
        "parameters": {
          "property1": "string",
          "property2": "string"
        }
      }
    ]
  }
}

Properties

Name Type Required Restrictions Description
contentDisposition ContentDisposition false none none
entity object false none none
headers object false none none
» additionalProperties [string] false none none
mediaType object false none none
» type string false none none
» subtype string false none none
» parameters object false none none
»» additionalProperties string false none none
» wildcardType boolean false none none
» wildcardSubtype boolean false none none
messageBodyWorkers MessageBodyWorkers false none none
parent MultiPart false none none
providers object false none none
bodyParts [BodyPart] false none none
fields object false none none
» additionalProperties [FormDataBodyPart] false none none
parameterizedHeaders object false none none
» additionalProperties [ParameterizedHeader] false none none

MessageBodyWorkers

{}

Properties

None

MultiPart

{
  "contentDisposition": {
    "type": "string",
    "parameters": {
      "property1": "string",
      "property2": "string"
    },
    "fileName": "string",
    "creationDate": "2019-08-24T14:15:22Z",
    "modificationDate": "2019-08-24T14:15:22Z",
    "readDate": "2019-08-24T14:15:22Z",
    "size": 0
  },
  "entity": {},
  "headers": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  },
  "mediaType": {
    "type": "string",
    "subtype": "string",
    "parameters": {
      "property1": "string",
      "property2": "string"
    },
    "wildcardType": true,
    "wildcardSubtype": true
  },
  "messageBodyWorkers": {},
  "parent": {
    "contentDisposition": {
      "type": "string",
      "parameters": {
        "property1": "string",
        "property2": "string"
      },
      "fileName": "string",
      "creationDate": "2019-08-24T14:15:22Z",
      "modificationDate": "2019-08-24T14:15:22Z",
      "readDate": "2019-08-24T14:15:22Z",
      "size": 0
    },
    "entity": {},
    "headers": {
      "property1": [
        "string"
      ],
      "property2": [
        "string"
      ]
    },
    "mediaType": {
      "type": "string",
      "subtype": "string",
      "parameters": {
        "property1": "string",
        "property2": "string"
      },
      "wildcardType": true,
      "wildcardSubtype": true
    },
    "messageBodyWorkers": {},
    "parent": {},
    "providers": {},
    "bodyParts": [
      {
        "contentDisposition": {
          "type": "string",
          "parameters": {
            "property1": "string",
            "property2": "string"
          },
          "fileName": "string",
          "creationDate": "2019-08-24T14:15:22Z",
          "modificationDate": "2019-08-24T14:15:22Z",
          "readDate": "2019-08-24T14:15:22Z",
          "size": 0
        },
        "entity": {},
        "headers": {
          "property1": [
            "string"
          ],
          "property2": [
            "string"
          ]
        },
        "mediaType": {
          "type": "string",
          "subtype": "string",
          "parameters": {
            "property1": "string",
            "property2": "string"
          },
          "wildcardType": true,
          "wildcardSubtype": true
        },
        "messageBodyWorkers": {},
        "parent": {},
        "providers": {},
        "parameterizedHeaders": {
          "property1": [
            {
              "value": "string",
              "parameters": {
                "property1": "string",
                "property2": "string"
              }
            }
          ],
          "property2": [
            {
              "value": "string",
              "parameters": {
                "property1": "string",
                "property2": "string"
              }
            }
          ]
        }
      }
    ],
    "parameterizedHeaders": {
      "property1": [
        {
          "value": "string",
          "parameters": {
            "property1": "string",
            "property2": "string"
          }
        }
      ],
      "property2": [
        {
          "value": "string",
          "parameters": {
            "property1": "string",
            "property2": "string"
          }
        }
      ]
    }
  },
  "providers": {},
  "bodyParts": [
    {
      "contentDisposition": {
        "type": "string",
        "parameters": {
          "property1": "string",
          "property2": "string"
        },
        "fileName": "string",
        "creationDate": "2019-08-24T14:15:22Z",
        "modificationDate": "2019-08-24T14:15:22Z",
        "readDate": "2019-08-24T14:15:22Z",
        "size": 0
      },
      "entity": {},
      "headers": {
        "property1": [
          "string"
        ],
        "property2": [
          "string"
        ]
      },
      "mediaType": {
        "type": "string",
        "subtype": "string",
        "parameters": {
          "property1": "string",
          "property2": "string"
        },
        "wildcardType": true,
        "wildcardSubtype": true
      },
      "messageBodyWorkers": {},
      "parent": {
        "contentDisposition": {
          "type": "string",
          "parameters": {
            "property1": "string",
            "property2": "string"
          },
          "fileName": "string",
          "creationDate": "2019-08-24T14:15:22Z",
          "modificationDate": "2019-08-24T14:15:22Z",
          "readDate": "2019-08-24T14:15:22Z",
          "size": 0
        },
        "entity": {},
        "headers": {
          "property1": [
            "string"
          ],
          "property2": [
            "string"
          ]
        },
        "mediaType": {
          "type": "string",
          "subtype": "string",
          "parameters": {
            "property1": "string",
            "property2": "string"
          },
          "wildcardType": true,
          "wildcardSubtype": true
        },
        "messageBodyWorkers": {},
        "parent": {},
        "providers": {},
        "bodyParts": [],
        "parameterizedHeaders": {
          "property1": [
            {
              "value": "string",
              "parameters": {
                "property1": "string",
                "property2": "string"
              }
            }
          ],
          "property2": [
            {
              "value": "string",
              "parameters": {
                "property1": "string",
                "property2": "string"
              }
            }
          ]
        }
      },
      "providers": {},
      "parameterizedHeaders": {
        "property1": [
          {
            "value": "string",
            "parameters": {
              "property1": "string",
              "property2": "string"
            }
          }
        ],
        "property2": [
          {
            "value": "string",
            "parameters": {
              "property1": "string",
              "property2": "string"
            }
          }
        ]
      }
    }
  ],
  "parameterizedHeaders": {
    "property1": [
      {
        "value": "string",
        "parameters": {
          "property1": "string",
          "property2": "string"
        }
      }
    ],
    "property2": [
      {
        "value": "string",
        "parameters": {
          "property1": "string",
          "property2": "string"
        }
      }
    ]
  }
}

Properties

Name Type Required Restrictions Description
contentDisposition ContentDisposition false none none
entity object false none none
headers object false none none
» additionalProperties [string] false none none
mediaType object false none none
» type string false none none
» subtype string false none none
» parameters object false none none
»» additionalProperties string false none none
» wildcardType boolean false none none
» wildcardSubtype boolean false none none
messageBodyWorkers MessageBodyWorkers false none none
parent MultiPart false none none
providers object false none none
bodyParts [BodyPart] false none none
parameterizedHeaders object false none none
» additionalProperties [ParameterizedHeader] false none none

ParameterizedHeader

{
  "value": "string",
  "parameters": {
    "property1": "string",
    "property2": "string"
  }
}

Properties

Name Type Required Restrictions Description
value string false none none
parameters object false none none
» additionalProperties string false none none

ApiMailConfigurationDTO

{
  "hostname": "string",
  "port": 0,
  "username": "string",
  "password": [
    "string"
  ],
  "passwordIsIncluded": true,
  "sslEnabled": true,
  "startTlsEnabled": true,
  "systemEmail": "string"
}

Properties

Name Type Required Restrictions Description
hostname string false none none
port integer(int32) false none none
username string false none none
password [string] false none none
passwordIsIncluded boolean false none none
sslEnabled boolean false none none
startTlsEnabled boolean false none none
systemEmail string false none none

ApiMetricsReportingQueryDTOV2

{
  "timePeriod": "WEEK",
  "firstTimePeriod": "string",
  "lastTimePeriod": "string",
  "applicationIds": [
    "string"
  ],
  "organizationIds": [
    "string"
  ]
}

Properties

Name Type Required Restrictions Description
timePeriod string false none none
firstTimePeriod string false none none
lastTimePeriod string false none none
applicationIds [string] false none none
organizationIds [string] false none none

Enumerated Values

Property Value
timePeriod WEEK
timePeriod MONTH

ApiOrganizationDTO

{
  "id": "string",
  "name": "string",
  "parentOrganizationId": "string",
  "tags": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "color": "white"
    }
  ]
}

Properties

Name Type Required Restrictions Description
id string false none none
name string false none none
parentOrganizationId string false none none
tags [ApiTagDTO] false none none

ApiTagDTO

{
  "id": "string",
  "name": "string",
  "description": "string",
  "color": "white"
}

Properties

Name Type Required Restrictions Description
id string false none none
name string false none none
description string false none none
color string false none none

Enumerated Values

Property Value
color white
color grey
color black
color green
color yellow
color orange
color red
color blue
color light-red
color light-green
color light-blue
color light-purple
color dark-red
color dark-green
color dark-blue
color dark-purple

ApiOrganizationListDTO

{
  "organizations": [
    {
      "id": "string",
      "name": "string",
      "parentOrganizationId": "string",
      "tags": [
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "color": "white"
        }
      ]
    }
  ]
}

Properties

Name Type Required Restrictions Description
organizations [ApiOrganizationDTO] false none none

ApiPolicyDTO

{
  "id": "string",
  "name": "string",
  "ownerId": "string",
  "ownerType": "APPLICATION",
  "threatLevel": 0,
  "policyType": "string"
}

Properties

Name Type Required Restrictions Description
id string false none none
name string false none none
ownerId string false none none
ownerType string false none none
threatLevel integer(int32) false none none
policyType string false none none

Enumerated Values

Property Value
ownerType APPLICATION
ownerType ORGANIZATION

ApiPolicyListDTO

{
  "policies": [
    {
      "id": "string",
      "name": "string",
      "ownerId": "string",
      "ownerType": "APPLICATION",
      "threatLevel": 0,
      "policyType": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
policies [ApiPolicyDTO] false none none

ApiPolicyWaiversApplicableToViolationDTO

{
  "activeWaivers": [
    {
      "policyWaiverId": "string",
      "policyViolationId": "string",
      "comment": "string",
      "createTime": "2019-08-24T14:15:22Z",
      "expiryTime": "2019-08-24T14:15:22Z",
      "isObsolete": true,
      "scopeOwnerType": "string",
      "scopeOwnerId": "string",
      "scopeOwnerName": "string",
      "hash": "string",
      "policyId": "string",
      "vulnerabilityId": "string",
      "policyName": "string",
      "constraintFacts": [
        {
          "constraintId": "string",
          "constraintName": "string",
          "operatorName": "string",
          "conditionFacts": [
            {
              "conditionTypeId": "string",
              "conditionIndex": 0,
              "summary": "string",
              "reason": "string",
              "reference": {
                "value": "string",
                "type": "SECURITY_VULNERABILITY_REFID"
              },
              "triggerJson": "string"
            }
          ]
        }
      ],
      "constraintFactsJson": "string",
      "componentName": "string",
      "creatorId": "string",
      "creatorName": "string",
      "matcherStrategy": "DEFAULT",
      "associatedPackageUrl": "string",
      "componentIdentifier": {
        "format": "string",
        "coordinates": {
          "property1": "string",
          "property2": "string"
        }
      },
      "threatLevel": 0,
      "componentUpgradeAvailable": true,
      "displayName": {
        "parts": [
          {
            "field": "string",
            "value": "string"
          }
        ],
        "name": "string"
      }
    }
  ],
  "expiredWaivers": [
    {
      "policyWaiverId": "string",
      "policyViolationId": "string",
      "comment": "string",
      "createTime": "2019-08-24T14:15:22Z",
      "expiryTime": "2019-08-24T14:15:22Z",
      "isObsolete": true,
      "scopeOwnerType": "string",
      "scopeOwnerId": "string",
      "scopeOwnerName": "string",
      "hash": "string",
      "policyId": "string",
      "vulnerabilityId": "string",
      "policyName": "string",
      "constraintFacts": [
        {
          "constraintId": "string",
          "constraintName": "string",
          "operatorName": "string",
          "conditionFacts": [
            {
              "conditionTypeId": "string",
              "conditionIndex": 0,
              "summary": "string",
              "reason": "string",
              "reference": {
                "value": "string",
                "type": "SECURITY_VULNERABILITY_REFID"
              },
              "triggerJson": "string"
            }
          ]
        }
      ],
      "constraintFactsJson": "string",
      "componentName": "string",
      "creatorId": "string",
      "creatorName": "string",
      "matcherStrategy": "DEFAULT",
      "associatedPackageUrl": "string",
      "componentIdentifier": {
        "format": "string",
        "coordinates": {
          "property1": "string",
          "property2": "string"
        }
      },
      "threatLevel": 0,
      "componentUpgradeAvailable": true,
      "displayName": {
        "parts": [
          {
            "field": "string",
            "value": "string"
          }
        ],
        "name": "string"
      }
    }
  ]
}

Properties

Name Type Required Restrictions Description
activeWaivers [ApiPolicyWaiverDTO] false none none
expiredWaivers [ApiPolicyWaiverDTO] false none none

ApiCrossStageViolationDTOV2

{
  "policyId": "string",
  "policyName": "string",
  "policyViolationId": "string",
  "threatLevel": 0,
  "constraintViolations": [
    {
      "constraintId": "string",
      "constraintName": "string",
      "reasons": [
        {
          "reason": "string",
          "reference": {
            "value": "string",
            "type": "SECURITY_VULNERABILITY_REFID"
          }
        }
      ]
    }
  ],
  "applicationPublicId": "string",
  "applicationName": "string",
  "organizationName": "string",
  "openTime": "2019-08-24T14:15:22Z",
  "fixTime": "2019-08-24T14:15:22Z",
  "hash": "string",
  "policyThreatCategory": "string",
  "displayName": {
    "parts": [
      {
        "field": "string",
        "value": "string"
      }
    ],
    "name": "string"
  },
  "componentIdentifier": {
    "format": "string",
    "coordinates": {
      "property1": "string",
      "property2": "string"
    }
  },
  "filename": "string",
  "stageData": {
    "property1": {
      "mostRecentEvaluationTime": "2019-08-24T14:15:22Z",
      "mostRecentScanId": "string",
      "actionTypeId": "string"
    },
    "property2": {
      "mostRecentEvaluationTime": "2019-08-24T14:15:22Z",
      "mostRecentScanId": "string",
      "actionTypeId": "string"
    }
  },
  "policyOwner": {
    "ownerPublicId": "string",
    "ownerId": "string",
    "ownerName": "string",
    "ownerType": "string"
  }
}

Properties

Name Type Required Restrictions Description
policyId string false none none
policyName string false none none
policyViolationId string false none none
threatLevel integer(int32) false none none
constraintViolations [ApiConstraintViolationDTO] false none none
applicationPublicId string false none none
applicationName string false none none
organizationName string false none none
openTime string(date-time) false none none
fixTime string(date-time) false none none
hash string false none none
policyThreatCategory string false none none
displayName ComponentDisplayName false none none
componentIdentifier ApiComponentIdentifierDTOV2 false none none
filename string false none none
stageData object false none none
» additionalProperties StageData false none none
policyOwner PolicyOwner false none none

PolicyOwner

{
  "ownerPublicId": "string",
  "ownerId": "string",
  "ownerName": "string",
  "ownerType": "string"
}

Properties

Name Type Required Restrictions Description
ownerPublicId string false none none
ownerId string false none none
ownerName string false none none
ownerType string false none none

StageData

{
  "mostRecentEvaluationTime": "2019-08-24T14:15:22Z",
  "mostRecentScanId": "string",
  "actionTypeId": "string"
}

Properties

Name Type Required Restrictions Description
mostRecentEvaluationTime string(date-time) false none none
mostRecentScanId string false none none
actionTypeId string false none none

ApiApplicationViolationDTOV2

{
  "application": {
    "id": "string",
    "publicId": "string",
    "name": "string",
    "organizationId": "string",
    "contactUserName": "string"
  },
  "policyViolations": [
    {
      "policyId": "string",
      "policyName": "string",
      "policyViolationId": "string",
      "threatLevel": 0,
      "constraintViolations": [
        {
          "constraintId": "string",
          "constraintName": "string",
          "reasons": [
            {
              "reason": "string",
              "reference": {
                "value": "string",
                "type": "SECURITY_VULNERABILITY_REFID"
              }
            }
          ]
        }
      ],
      "stageId": "string",
      "reportId": "string",
      "reportUrl": "string",
      "openTime": "2019-08-24T14:15:22Z",
      "component": {
        "packageUrl": "string",
        "hash": "string",
        "sha256": "string",
        "componentIdentifier": {
          "format": "string",
          "coordinates": {
            "property1": "string",
            "property2": "string"
          }
        },
        "displayName": "string",
        "proprietary": true,
        "thirdParty": true
      }
    }
  ]
}

Properties

Name Type Required Restrictions Description
application ApiApplicationBaseDTO false none none
policyViolations [ApiEnhancedPolicyViolationDTOV2] false none none

ApiApplicationViolationListDTOV2

{
  "applicationViolations": [
    {
      "application": {
        "id": "string",
        "publicId": "string",
        "name": "string",
        "organizationId": "string",
        "contactUserName": "string"
      },
      "policyViolations": [
        {
          "policyId": "string",
          "policyName": "string",
          "policyViolationId": "string",
          "threatLevel": 0,
          "constraintViolations": [
            {
              "constraintId": "string",
              "constraintName": "string",
              "reasons": [
                {
                  "reason": "string",
                  "reference": {
                    "value": "string",
                    "type": "SECURITY_VULNERABILITY_REFID"
                  }
                }
              ]
            }
          ],
          "stageId": "string",
          "reportId": "string",
          "reportUrl": "string",
          "openTime": "2019-08-24T14:15:22Z",
          "component": {
            "packageUrl": "string",
            "hash": "string",
            "sha256": "string",
            "componentIdentifier": {
              "format": "string",
              "coordinates": {
                "property1": "string",
                "property2": "string"
              }
            },
            "displayName": "string",
            "proprietary": true,
            "thirdParty": true
          }
        }
      ]
    }
  ]
}

Properties

Name Type Required Restrictions Description
applicationViolations [ApiApplicationViolationDTOV2] false none none

ApiEnhancedPolicyViolationDTOV2

{
  "policyId": "string",
  "policyName": "string",
  "policyViolationId": "string",
  "threatLevel": 0,
  "constraintViolations": [
    {
      "constraintId": "string",
      "constraintName": "string",
      "reasons": [
        {
          "reason": "string",
          "reference": {
            "value": "string",
            "type": "SECURITY_VULNERABILITY_REFID"
          }
        }
      ]
    }
  ],
  "stageId": "string",
  "reportId": "string",
  "reportUrl": "string",
  "openTime": "2019-08-24T14:15:22Z",
  "component": {
    "packageUrl": "string",
    "hash": "string",
    "sha256": "string",
    "componentIdentifier": {
      "format": "string",
      "coordinates": {
        "property1": "string",
        "property2": "string"
      }
    },
    "displayName": "string",
    "proprietary": true,
    "thirdParty": true
  }
}

Properties

Name Type Required Restrictions Description
policyId string false none none
policyName string false none none
policyViolationId string false none none
threatLevel integer(int32) false none none
constraintViolations [ApiConstraintViolationDTO] false none none
stageId string false none none
reportId string false none none
reportUrl string false none none
openTime string(date-time) false none none
component ApiComponentDTOV2 false none none

ApiComponentTransitivePolicyViolationsDTO

{
  "componentIdentifier": {
    "format": "string",
    "coordinates": {
      "property1": "string",
      "property2": "string"
    }
  },
  "packageUrl": "string",
  "hash": "string",
  "displayName": "string",
  "isInnerSource": true,
  "transitivePolicyViolations": [
    {
      "policyId": "string",
      "policyName": "string",
      "threatLevel": 0,
      "threatCategory": "string",
      "policyViolationId": "string",
      "action": "string",
      "componentIdentifier": {
        "format": "string",
        "coordinates": {
          "property1": "string",
          "property2": "string"
        }
      },
      "packageUrl": "string",
      "hash": "string",
      "displayName": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
componentIdentifier ApiComponentIdentifierDTOV2 false none none
packageUrl string false none none
hash string false none none
displayName string false none none
isInnerSource boolean false none none
transitivePolicyViolations [ApiStagePolicyViolationComponentDTO] false none none

ApiStagePolicyViolationComponentDTO

{
  "policyId": "string",
  "policyName": "string",
  "threatLevel": 0,
  "threatCategory": "string",
  "policyViolationId": "string",
  "action": "string",
  "componentIdentifier": {
    "format": "string",
    "coordinates": {
      "property1": "string",
      "property2": "string"
    }
  },
  "packageUrl": "string",
  "hash": "string",
  "displayName": "string"
}

Properties

Name Type Required Restrictions Description
policyId string false none none
policyName string false none none
threatLevel integer(int32) false none none
threatCategory string false none none
policyViolationId string false none none
action string false none none
componentIdentifier ApiComponentIdentifierDTOV2 false none none
packageUrl string false none none
hash string false none none
displayName string false none none

ApiWaiverOptionsDTO

{
  "comment": "string",
  "applyToAllComponents": true,
  "matcherStrategy": "DEFAULT",
  "expiryTime": "2019-08-24T14:15:22Z"
}

Properties

Name Type Required Restrictions Description
comment string false none none
applyToAllComponents boolean false none none
matcherStrategy string false none none
expiryTime string(date-time) false none none

Enumerated Values

Property Value
matcherStrategy DEFAULT
matcherStrategy EXACT_COMPONENT
matcherStrategy ALL_COMPONENTS
matcherStrategy ALL_VERSIONS

ApiComponentPolicyWaiversDTO

{
  "componentPolicyWaivers": [
    {
      "policyWaiverId": "string",
      "policyViolationId": "string",
      "comment": "string",
      "createTime": "2019-08-24T14:15:22Z",
      "expiryTime": "2019-08-24T14:15:22Z",
      "isObsolete": true,
      "scopeOwnerType": "string",
      "scopeOwnerId": "string",
      "scopeOwnerName": "string",
      "hash": "string",
      "policyId": "string",
      "vulnerabilityId": "string",
      "policyName": "string",
      "constraintFacts": [
        {
          "constraintId": "string",
          "constraintName": "string",
          "operatorName": "string",
          "conditionFacts": [
            {
              "conditionTypeId": "string",
              "conditionIndex": 0,
              "summary": "string",
              "reason": "string",
              "reference": {
                "value": "string",
                "type": "SECURITY_VULNERABILITY_REFID"
              },
              "triggerJson": "string"
            }
          ]
        }
      ],
      "constraintFactsJson": "string",
      "componentName": "string",
      "creatorId": "string",
      "creatorName": "string",
      "matcherStrategy": "DEFAULT",
      "associatedPackageUrl": "string",
      "componentIdentifier": {
        "format": "string",
        "coordinates": {
          "property1": "string",
          "property2": "string"
        }
      },
      "threatLevel": 0,
      "componentUpgradeAvailable": true,
      "displayName": {
        "parts": [
          {
            "field": "string",
            "value": "string"
          }
        ],
        "name": "string"
      }
    }
  ]
}

Properties

Name Type Required Restrictions Description
componentPolicyWaivers [ApiPolicyWaiverDTO] false none none

ApiRequestPolicyWaiverDTO

{
  "comment": "string",
  "policyViolationLink": "string",
  "addWaiverLink": "string"
}

Properties

Name Type Required Restrictions Description
comment string false none none
policyViolationLink string false none none
addWaiverLink string false none none

ApiProxyServerConfigurationDTO

{
  "hostname": "string",
  "port": 0,
  "username": "string",
  "password": [
    "string"
  ],
  "passwordIsIncluded": true,
  "excludeHosts": [
    "string"
  ]
}

Properties

Name Type Required Restrictions Description
hostname string false none none
port integer(int32) false none none
username string false none none
password [string] false none none
passwordIsIncluded boolean false none none
excludeHosts [string] false none none

ApiDependencyTreeNodeDTO

{
  "packageUrl": "string",
  "componentIdentifier": {
    "format": "string",
    "coordinates": {
      "property1": "string",
      "property2": "string"
    }
  },
  "children": [
    {
      "packageUrl": "string",
      "componentIdentifier": {
        "format": "string",
        "coordinates": {
          "property1": "string",
          "property2": "string"
        }
      },
      "children": [],
      "direct": true
    }
  ],
  "direct": true
}

Properties

Name Type Required Restrictions Description
packageUrl string false none none
componentIdentifier ApiComponentIdentifierDTOV2 false none none
children [ApiDependencyTreeNodeDTO] false none none
direct boolean false none none

ApiDependencyTreeResponseDTO

{
  "dependencyTree": {
    "packageUrl": "string",
    "componentIdentifier": {
      "format": "string",
      "coordinates": {
        "property1": "string",
        "property2": "string"
      }
    },
    "children": [
      {}
    ],
    "direct": true
  }
}

Properties

Name Type Required Restrictions Description
dependencyTree ApiDependencyTreeNodeDTO false none none

ApiApplicationEvaluationCommitDTO

{
  "commitHash": "string",
  "scanId": "string",
  "reportUrl": "string",
  "scanTime": "2019-08-24T14:15:22Z"
}

Properties

Name Type Required Restrictions Description
commitHash string false none none
scanId string false none none
reportUrl string false none none
scanTime string(date-time) false none none

ApiPolicyViolationDiffDTO

{
  "application": {
    "id": "string",
    "publicId": "string",
    "name": "string",
    "organizationId": "string",
    "contactUserName": "string",
    "applicationTags": [
      {
        "id": "string",
        "tagId": "string",
        "applicationId": "string"
      }
    ]
  },
  "fromCommit": {
    "commitHash": "string",
    "scanId": "string",
    "reportUrl": "string",
    "scanTime": "2019-08-24T14:15:22Z"
  },
  "toCommit": {
    "commitHash": "string",
    "scanId": "string",
    "reportUrl": "string",
    "scanTime": "2019-08-24T14:15:22Z"
  },
  "diffTime": "2019-08-24T14:15:22Z",
  "addedViolations": [
    {
      "policyId": "string",
      "policyName": "string",
      "policyViolationId": "string",
      "threatLevel": 0,
      "constraintViolations": [
        {
          "constraintId": "string",
          "constraintName": "string",
          "reasons": [
            {
              "reason": "string",
              "reference": {
                "value": "string",
                "type": "SECURITY_VULNERABILITY_REFID"
              }
            }
          ]
        }
      ],
      "component": {
        "packageUrl": "string",
        "hash": "string",
        "sha256": "string",
        "componentIdentifier": {
          "format": "string",
          "coordinates": {
            "property1": "string",
            "property2": "string"
          }
        },
        "displayName": "string",
        "proprietary": true,
        "thirdParty": true
      }
    }
  ],
  "sameViolations": [
    {
      "policyId": "string",
      "policyName": "string",
      "policyViolationId": "string",
      "threatLevel": 0,
      "constraintViolations": [
        {
          "constraintId": "string",
          "constraintName": "string",
          "reasons": [
            {
              "reason": "string",
              "reference": {
                "value": "string",
                "type": "SECURITY_VULNERABILITY_REFID"
              }
            }
          ]
        }
      ],
      "component": {
        "packageUrl": "string",
        "hash": "string",
        "sha256": "string",
        "componentIdentifier": {
          "format": "string",
          "coordinates": {
            "property1": "string",
            "property2": "string"
          }
        },
        "displayName": "string",
        "proprietary": true,
        "thirdParty": true
      }
    }
  ],
  "removedViolations": [
    {
      "policyId": "string",
      "policyName": "string",
      "policyViolationId": "string",
      "threatLevel": 0,
      "constraintViolations": [
        {
          "constraintId": "string",
          "constraintName": "string",
          "reasons": [
            {
              "reason": "string",
              "reference": {
                "value": "string",
                "type": "SECURITY_VULNERABILITY_REFID"
              }
            }
          ]
        }
      ],
      "component": {
        "packageUrl": "string",
        "hash": "string",
        "sha256": "string",
        "componentIdentifier": {
          "format": "string",
          "coordinates": {
            "property1": "string",
            "property2": "string"
          }
        },
        "displayName": "string",
        "proprietary": true,
        "thirdParty": true
      }
    }
  ]
}

Properties

Name Type Required Restrictions Description
application ApiApplicationDTO false none none
fromCommit ApiApplicationEvaluationCommitDTO false none none
toCommit ApiApplicationEvaluationCommitDTO false none none
diffTime string(date-time) false none none
addedViolations [ApiPolicyViolationForDiffDTO] false none none
sameViolations [ApiPolicyViolationForDiffDTO] false none none
removedViolations [ApiPolicyViolationForDiffDTO] false none none

ApiPolicyViolationForDiffDTO

{
  "policyId": "string",
  "policyName": "string",
  "policyViolationId": "string",
  "threatLevel": 0,
  "constraintViolations": [
    {
      "constraintId": "string",
      "constraintName": "string",
      "reasons": [
        {
          "reason": "string",
          "reference": {
            "value": "string",
            "type": "SECURITY_VULNERABILITY_REFID"
          }
        }
      ]
    }
  ],
  "component": {
    "packageUrl": "string",
    "hash": "string",
    "sha256": "string",
    "componentIdentifier": {
      "format": "string",
      "coordinates": {
        "property1": "string",
        "property2": "string"
      }
    },
    "displayName": "string",
    "proprietary": true,
    "thirdParty": true
  }
}

Properties

Name Type Required Restrictions Description
policyId string false none none
policyName string false none none
policyViolationId string false none none
threatLevel integer(int32) false none none
constraintViolations [ApiConstraintViolationDTO] false none none
component ApiComponentDTOV2 false none none

ApiDependencyDataDTO

{
  "directDependency": true,
  "innerSource": true,
  "parentComponentPurls": [
    "string"
  ],
  "innerSourceData": [
    {
      "ownerApplicationName": "string",
      "ownerApplicationId": "string",
      "innerSourceComponentPurl": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
directDependency boolean false none none
innerSource boolean false none none
parentComponentPurls [string] false none none
innerSourceData [InnerSourceData] false none none

ApiReportComponentPolicyViolationsDTOV2

{
  "packageUrl": "string",
  "hash": "string",
  "sha256": "string",
  "componentIdentifier": {
    "format": "string",
    "coordinates": {
      "property1": "string",
      "property2": "string"
    }
  },
  "displayName": "string",
  "proprietary": true,
  "thirdParty": true,
  "matchState": "string",
  "pathnames": [
    "string"
  ],
  "dependencyData": {
    "directDependency": true,
    "innerSource": true,
    "parentComponentPurls": [
      "string"
    ],
    "innerSourceData": [
      {
        "ownerApplicationName": "string",
        "ownerApplicationId": "string",
        "innerSourceComponentPurl": "string"
      }
    ]
  },
  "violations": [
    {
      "policyId": "string",
      "policyName": "string",
      "policyThreatCategory": "string",
      "policyThreatLevel": 0,
      "policyViolationId": "string",
      "waived": true,
      "grandfathered": true,
      "legacyViolation": true,
      "constraints": [
        {
          "constraintId": "string",
          "constraintName": "string",
          "conditions": [
            {
              "conditionSummary": "string",
              "conditionReason": "string"
            }
          ]
        }
      ]
    }
  ]
}

Properties

Name Type Required Restrictions Description
packageUrl string false none none
hash string false none none
sha256 string false none none
componentIdentifier ApiComponentIdentifierDTOV2 false none none
displayName string false none none
proprietary boolean false none none
thirdParty boolean false none none
matchState string false none none
pathnames [string] false none none
dependencyData ApiDependencyDataDTO false none none
violations [ApiReportPolicyViolationDTOV2] false none none

ApiReportConstraintConditionDTOV2

{
  "conditionSummary": "string",
  "conditionReason": "string"
}

Properties

Name Type Required Restrictions Description
conditionSummary string false none none
conditionReason string false none none

ApiReportConstraintViolationDTOV2

{
  "constraintId": "string",
  "constraintName": "string",
  "conditions": [
    {
      "conditionSummary": "string",
      "conditionReason": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
constraintId string false none none
constraintName string false none none
conditions [ApiReportConstraintConditionDTOV2] false none none

ApiReportPolicyDataDTOV2

{
  "reportTime": "2019-08-24T14:15:22Z",
  "reportTitle": "string",
  "commitHash": "string",
  "initiator": "string",
  "application": {
    "id": "string",
    "publicId": "string",
    "name": "string",
    "organizationId": "string",
    "contactUserName": "string"
  },
  "counts": {
    "property1": 0,
    "property2": 0
  },
  "components": [
    {
      "packageUrl": "string",
      "hash": "string",
      "sha256": "string",
      "componentIdentifier": {
        "format": "string",
        "coordinates": {
          "property1": "string",
          "property2": "string"
        }
      },
      "displayName": "string",
      "proprietary": true,
      "thirdParty": true,
      "matchState": "string",
      "pathnames": [
        "string"
      ],
      "dependencyData": {
        "directDependency": true,
        "innerSource": true,
        "parentComponentPurls": [
          "string"
        ],
        "innerSourceData": [
          {
            "ownerApplicationName": "string",
            "ownerApplicationId": "string",
            "innerSourceComponentPurl": "string"
          }
        ]
      },
      "violations": [
        {
          "policyId": "string",
          "policyName": "string",
          "policyThreatCategory": "string",
          "policyThreatLevel": 0,
          "policyViolationId": "string",
          "waived": true,
          "grandfathered": true,
          "legacyViolation": true,
          "constraints": [
            {
              "constraintId": "string",
              "constraintName": "string",
              "conditions": [
                {
                  "conditionSummary": "string",
                  "conditionReason": "string"
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

Properties

Name Type Required Restrictions Description
reportTime string(date-time) false none none
reportTitle string false none none
commitHash string false none none
initiator string false none none
application ApiApplicationBaseDTO false none none
counts object false none none
» additionalProperties integer(int32) false none none
components [ApiReportComponentPolicyViolationsDTOV2] false none none

ApiReportPolicyViolationDTOV2

{
  "policyId": "string",
  "policyName": "string",
  "policyThreatCategory": "string",
  "policyThreatLevel": 0,
  "policyViolationId": "string",
  "waived": true,
  "grandfathered": true,
  "legacyViolation": true,
  "constraints": [
    {
      "constraintId": "string",
      "constraintName": "string",
      "conditions": [
        {
          "conditionSummary": "string",
          "conditionReason": "string"
        }
      ]
    }
  ]
}

Properties

Name Type Required Restrictions Description
policyId string false none none
policyName string false none none
policyThreatCategory string false none none
policyThreatLevel integer(int32) false none none
policyViolationId string false none none
waived boolean false none none
grandfathered boolean false none none
legacyViolation boolean false none none
constraints [ApiReportConstraintViolationDTOV2] false none none

InnerSourceData

{
  "ownerApplicationName": "string",
  "ownerApplicationId": "string",
  "innerSourceComponentPurl": "string"
}

Properties

Name Type Required Restrictions Description
ownerApplicationName string false none none
ownerApplicationId string false none none
innerSourceComponentPurl string false none none

ApiGlobalInformationDTOV2

{
  "dataVersionDate": "string"
}

Properties

Name Type Required Restrictions Description
dataVersionDate string false none none

ApiLicenseDataDTOV2

{
  "declaredLicenses": [
    {
      "licenseId": "string",
      "licenseName": "string"
    }
  ],
  "observedLicenses": [
    {
      "licenseId": "string",
      "licenseName": "string"
    }
  ],
  "effectiveLicenses": [
    {
      "licenseId": "string",
      "licenseName": "string"
    }
  ],
  "overriddenLicenses": [
    {
      "licenseId": "string",
      "licenseName": "string"
    }
  ],
  "status": "string",
  "effectiveLicenseThreats": [
    {
      "licenseThreatGroupName": "string",
      "licenseThreatGroupLevel": 0,
      "licenseThreatGroupCategory": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
declaredLicenses [ApiLicenseDTO] false none none
observedLicenses [ApiLicenseDTO] false none none
effectiveLicenses [ApiLicenseDTO] false none none
overriddenLicenses [ApiLicenseDTO] false none none
status string false none none
effectiveLicenseThreats [ApiLicenseThreatDTOV2] false none none

ApiMatchStateSummaryDTOV2

{
  "totalComponentCount": 0,
  "knownComponentCount": 0
}

Properties

Name Type Required Restrictions Description
totalComponentCount integer(int32) false none none
knownComponentCount integer(int32) false none none

ApiReportComponentDTOV2

{
  "packageUrl": "string",
  "hash": "string",
  "sha256": "string",
  "componentIdentifier": {
    "format": "string",
    "coordinates": {
      "property1": "string",
      "property2": "string"
    }
  },
  "displayName": "string",
  "proprietary": true,
  "thirdParty": true,
  "matchState": "string",
  "pathnames": [
    "string"
  ],
  "identificationSource": "string",
  "licenseData": {
    "declaredLicenses": [
      {
        "licenseId": "string",
        "licenseName": "string"
      }
    ],
    "observedLicenses": [
      {
        "licenseId": "string",
        "licenseName": "string"
      }
    ],
    "effectiveLicenses": [
      {
        "licenseId": "string",
        "licenseName": "string"
      }
    ],
    "overriddenLicenses": [
      {
        "licenseId": "string",
        "licenseName": "string"
      }
    ],
    "status": "string",
    "effectiveLicenseThreats": [
      {
        "licenseThreatGroupName": "string",
        "licenseThreatGroupLevel": 0,
        "licenseThreatGroupCategory": "string"
      }
    ]
  },
  "securityData": {
    "securityIssues": [
      {
        "source": "string",
        "reference": "string",
        "severity": 0.1,
        "status": "string",
        "url": "string",
        "threatCategory": "string",
        "cwe": "string",
        "cvssVector": "string",
        "cvssVectorSource": "string",
        "analysis": {
          "state": "string",
          "justification": "string",
          "response": "string",
          "detail": "string"
        }
      }
    ]
  },
  "dependencyData": {
    "directDependency": true,
    "innerSource": true,
    "parentComponentPurls": [
      "string"
    ],
    "innerSourceData": [
      {
        "ownerApplicationName": "string",
        "ownerApplicationId": "string",
        "innerSourceComponentPurl": "string"
      }
    ]
  },
  "cpe": "string",
  "swid": {
    "tagId": "string",
    "name": "string",
    "version": "string",
    "tagVersion": 0,
    "patch": true,
    "text": {
      "encoding": "string",
      "contentType": "string",
      "content": "string"
    }
  }
}

Properties

Name Type Required Restrictions Description
packageUrl string false none none
hash string false none none
sha256 string false none none
componentIdentifier ApiComponentIdentifierDTOV2 false none none
displayName string false none none
proprietary boolean false none none
thirdParty boolean false none none
matchState string false none none
pathnames [string] false none none
identificationSource string false none none
licenseData ApiLicenseDataDTOV2 false none none
securityData ApiSecurityDataDTO false none none
dependencyData ApiDependencyDataDTO false none none
cpe string false none none
swid Swid false none none

ApiReportRawDataDTOV2

{
  "components": [
    {
      "packageUrl": "string",
      "hash": "string",
      "sha256": "string",
      "componentIdentifier": {
        "format": "string",
        "coordinates": {
          "property1": "string",
          "property2": "string"
        }
      },
      "displayName": "string",
      "proprietary": true,
      "thirdParty": true,
      "matchState": "string",
      "pathnames": [
        "string"
      ],
      "identificationSource": "string",
      "licenseData": {
        "declaredLicenses": [
          {
            "licenseId": "string",
            "licenseName": "string"
          }
        ],
        "observedLicenses": [
          {
            "licenseId": "string",
            "licenseName": "string"
          }
        ],
        "effectiveLicenses": [
          {
            "licenseId": "string",
            "licenseName": "string"
          }
        ],
        "overriddenLicenses": [
          {
            "licenseId": "string",
            "licenseName": "string"
          }
        ],
        "status": "string",
        "effectiveLicenseThreats": [
          {
            "licenseThreatGroupName": "string",
            "licenseThreatGroupLevel": 0,
            "licenseThreatGroupCategory": "string"
          }
        ]
      },
      "securityData": {
        "securityIssues": [
          {
            "source": "string",
            "reference": "string",
            "severity": 0.1,
            "status": "string",
            "url": "string",
            "threatCategory": "string",
            "cwe": "string",
            "cvssVector": "string",
            "cvssVectorSource": "string",
            "analysis": {
              "state": "string",
              "justification": "string",
              "response": "string",
              "detail": "string"
            }
          }
        ]
      },
      "dependencyData": {
        "directDependency": true,
        "innerSource": true,
        "parentComponentPurls": [
          "string"
        ],
        "innerSourceData": [
          {
            "ownerApplicationName": "string",
            "ownerApplicationId": "string",
            "innerSourceComponentPurl": "string"
          }
        ]
      },
      "cpe": "string",
      "swid": {
        "tagId": "string",
        "name": "string",
        "version": "string",
        "tagVersion": 0,
        "patch": true,
        "text": {
          "encoding": "string",
          "contentType": "string",
          "content": "string"
        }
      }
    }
  ],
  "matchSummary": {
    "totalComponentCount": 0,
    "knownComponentCount": 0
  },
  "globalInformation": {
    "dataVersionDate": "string"
  }
}

Properties

Name Type Required Restrictions Description
components [ApiReportComponentDTOV2] false none none
matchSummary ApiMatchStateSummaryDTOV2 false none none
globalInformation ApiGlobalInformationDTOV2 false none none

AttachmentText

{
  "encoding": "string",
  "contentType": "string",
  "content": "string"
}

Properties

Name Type Required Restrictions Description
encoding string false none none
contentType string false none none
content string false none none

Swid

{
  "tagId": "string",
  "name": "string",
  "version": "string",
  "tagVersion": 0,
  "patch": true,
  "text": {
    "encoding": "string",
    "contentType": "string",
    "content": "string"
  }
}

Properties

Name Type Required Restrictions Description
tagId string false none none
name string false none none
version string false none none
tagVersion integer(int32) false none none
patch boolean false none none
text AttachmentText false none none

ApiApplicationReportDTOV2

{
  "stage": "string",
  "applicationId": "string",
  "evaluationDate": "2019-08-24T14:15:22Z",
  "latestReportHtmlUrl": "string",
  "reportHtmlUrl": "string",
  "embeddableReportHtmlUrl": "string",
  "reportPdfUrl": "string",
  "reportDataUrl": "string"
}

Properties

Name Type Required Restrictions Description
stage string false none none
applicationId string false none none
evaluationDate string(date-time) false none none
latestReportHtmlUrl string false none none
reportHtmlUrl string false none none
embeddableReportHtmlUrl string false none none
reportPdfUrl string false none none
reportDataUrl string false none none

Action

{
  "actionTypeId": "string",
  "target": "string",
  "targetType": "string"
}

Properties

Name Type Required Restrictions Description
actionTypeId string false none none
target string false none none
targetType string false none none

ApiReportHistoryDTO

{
  "applicationId": "string",
  "reports": [
    {
      "stage": "string",
      "applicationId": "string",
      "evaluationDate": "2019-08-24T14:15:22Z",
      "latestReportHtmlUrl": "string",
      "reportHtmlUrl": "string",
      "embeddableReportHtmlUrl": "string",
      "reportPdfUrl": "string",
      "reportDataUrl": "string",
      "policyEvaluationId": "string",
      "scanId": "string",
      "isReevaluation": true,
      "isForMonitoring": true,
      "commitHash": "string",
      "scanTriggerType": "string",
      "policyEvaluationResult": {
        "alerts": [
          {
            "trigger": {
              "policyId": "string",
              "policyName": "string",
              "threatLevel": 0,
              "policyViolationId": "string",
              "componentFacts": [
                {
                  "componentIdentifier": {
                    "format": "string",
                    "coordinates": {}
                  },
                  "hash": "string",
                  "constraintFacts": [
                    {}
                  ],
                  "pathnames": [
                    "string"
                  ],
                  "displayName": {
                    "parts": [],
                    "name": "string"
                  }
                }
              ]
            },
            "actions": [
              {
                "actionTypeId": "string",
                "target": "string",
                "targetType": "string"
              }
            ]
          }
        ],
        "affectedComponentCount": 0,
        "criticalComponentCount": 0,
        "severeComponentCount": 0,
        "moderateComponentCount": 0,
        "criticalPolicyViolationCount": 0,
        "severePolicyViolationCount": 0,
        "moderatePolicyViolationCount": 0,
        "legacyViolationCount": 0,
        "totalComponentCount": 0,
        "grandfatheredPolicyViolationCount": 0
      }
    }
  ]
}

Properties

Name Type Required Restrictions Description
applicationId string false none none
reports [ApiReportResultsDTO] false none none

ApiReportResultsDTO

{
  "stage": "string",
  "applicationId": "string",
  "evaluationDate": "2019-08-24T14:15:22Z",
  "latestReportHtmlUrl": "string",
  "reportHtmlUrl": "string",
  "embeddableReportHtmlUrl": "string",
  "reportPdfUrl": "string",
  "reportDataUrl": "string",
  "policyEvaluationId": "string",
  "scanId": "string",
  "isReevaluation": true,
  "isForMonitoring": true,
  "commitHash": "string",
  "scanTriggerType": "string",
  "policyEvaluationResult": {
    "alerts": [
      {
        "trigger": {
          "policyId": "string",
          "policyName": "string",
          "threatLevel": 0,
          "policyViolationId": "string",
          "componentFacts": [
            {
              "componentIdentifier": {
                "format": "string",
                "coordinates": {
                  "property1": "string",
                  "property2": "string"
                }
              },
              "hash": "string",
              "constraintFacts": [
                {
                  "constraintId": "string",
                  "constraintName": "string",
                  "operatorName": "string",
                  "conditionFacts": [
                    {}
                  ]
                }
              ],
              "pathnames": [
                "string"
              ],
              "displayName": {
                "parts": [
                  {
                    "field": "string",
                    "value": "string"
                  }
                ],
                "name": "string"
              }
            }
          ]
        },
        "actions": [
          {
            "actionTypeId": "string",
            "target": "string",
            "targetType": "string"
          }
        ]
      }
    ],
    "affectedComponentCount": 0,
    "criticalComponentCount": 0,
    "severeComponentCount": 0,
    "moderateComponentCount": 0,
    "criticalPolicyViolationCount": 0,
    "severePolicyViolationCount": 0,
    "moderatePolicyViolationCount": 0,
    "legacyViolationCount": 0,
    "totalComponentCount": 0,
    "grandfatheredPolicyViolationCount": 0
  }
}

Properties

Name Type Required Restrictions Description
stage string false none none
applicationId string false none none
evaluationDate string(date-time) false none none
latestReportHtmlUrl string false none none
reportHtmlUrl string false none none
embeddableReportHtmlUrl string false none none
reportPdfUrl string false none none
reportDataUrl string false none none
policyEvaluationId string false none none
scanId string false none none
isReevaluation boolean false none none
isForMonitoring boolean false none none
commitHash string false none none
scanTriggerType string false none none
policyEvaluationResult PolicyEvaluationResult false none none

ComponentFact

{
  "componentIdentifier": {
    "format": "string",
    "coordinates": {
      "property1": "string",
      "property2": "string"
    }
  },
  "hash": "string",
  "constraintFacts": [
    {
      "constraintId": "string",
      "constraintName": "string",
      "operatorName": "string",
      "conditionFacts": [
        {
          "conditionTypeId": "string",
          "conditionIndex": 0,
          "summary": "string",
          "reason": "string",
          "reference": {
            "value": "string",
            "type": "SECURITY_VULNERABILITY_REFID"
          },
          "triggerJson": "string"
        }
      ]
    }
  ],
  "pathnames": [
    "string"
  ],
  "displayName": {
    "parts": [
      {
        "field": "string",
        "value": "string"
      }
    ],
    "name": "string"
  }
}

Properties

Name Type Required Restrictions Description
componentIdentifier ComponentIdentifier false none none
hash string false none none
constraintFacts [ConstraintFact] false none none
pathnames [string] false none none
displayName ComponentDisplayName false none none

PolicyAlert

{
  "trigger": {
    "policyId": "string",
    "policyName": "string",
    "threatLevel": 0,
    "policyViolationId": "string",
    "componentFacts": [
      {
        "componentIdentifier": {
          "format": "string",
          "coordinates": {
            "property1": "string",
            "property2": "string"
          }
        },
        "hash": "string",
        "constraintFacts": [
          {
            "constraintId": "string",
            "constraintName": "string",
            "operatorName": "string",
            "conditionFacts": [
              {
                "conditionTypeId": "string",
                "conditionIndex": 0,
                "summary": "string",
                "reason": "string",
                "reference": {
                  "value": "string",
                  "type": "SECURITY_VULNERABILITY_REFID"
                },
                "triggerJson": "string"
              }
            ]
          }
        ],
        "pathnames": [
          "string"
        ],
        "displayName": {
          "parts": [
            {
              "field": "string",
              "value": "string"
            }
          ],
          "name": "string"
        }
      }
    ]
  },
  "actions": [
    {
      "actionTypeId": "string",
      "target": "string",
      "targetType": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
trigger PolicyFact false none none
actions [Action] false none none

PolicyEvaluationResult

{
  "alerts": [
    {
      "trigger": {
        "policyId": "string",
        "policyName": "string",
        "threatLevel": 0,
        "policyViolationId": "string",
        "componentFacts": [
          {
            "componentIdentifier": {
              "format": "string",
              "coordinates": {
                "property1": "string",
                "property2": "string"
              }
            },
            "hash": "string",
            "constraintFacts": [
              {
                "constraintId": "string",
                "constraintName": "string",
                "operatorName": "string",
                "conditionFacts": [
                  {
                    "conditionTypeId": "string",
                    "conditionIndex": 0,
                    "summary": "string",
                    "reason": "string",
                    "reference": {},
                    "triggerJson": "string"
                  }
                ]
              }
            ],
            "pathnames": [
              "string"
            ],
            "displayName": {
              "parts": [
                {
                  "field": "string",
                  "value": "string"
                }
              ],
              "name": "string"
            }
          }
        ]
      },
      "actions": [
        {
          "actionTypeId": "string",
          "target": "string",
          "targetType": "string"
        }
      ]
    }
  ],
  "affectedComponentCount": 0,
  "criticalComponentCount": 0,
  "severeComponentCount": 0,
  "moderateComponentCount": 0,
  "criticalPolicyViolationCount": 0,
  "severePolicyViolationCount": 0,
  "moderatePolicyViolationCount": 0,
  "legacyViolationCount": 0,
  "totalComponentCount": 0,
  "grandfatheredPolicyViolationCount": 0
}

Properties

Name Type Required Restrictions Description
alerts [PolicyAlert] false none none
affectedComponentCount integer(int32) false none none
criticalComponentCount integer(int32) false none none
severeComponentCount integer(int32) false none none
moderateComponentCount integer(int32) false none none
criticalPolicyViolationCount integer(int32) false none none
severePolicyViolationCount integer(int32) false none none
moderatePolicyViolationCount integer(int32) false none none
legacyViolationCount integer(int32) false none none
totalComponentCount integer(int32) false none none
grandfatheredPolicyViolationCount integer(int32) false none none

PolicyFact

{
  "policyId": "string",
  "policyName": "string",
  "threatLevel": 0,
  "policyViolationId": "string",
  "componentFacts": [
    {
      "componentIdentifier": {
        "format": "string",
        "coordinates": {
          "property1": "string",
          "property2": "string"
        }
      },
      "hash": "string",
      "constraintFacts": [
        {
          "constraintId": "string",
          "constraintName": "string",
          "operatorName": "string",
          "conditionFacts": [
            {
              "conditionTypeId": "string",
              "conditionIndex": 0,
              "summary": "string",
              "reason": "string",
              "reference": {
                "value": "string",
                "type": "SECURITY_VULNERABILITY_REFID"
              },
              "triggerJson": "string"
            }
          ]
        }
      ],
      "pathnames": [
        "string"
      ],
      "displayName": {
        "parts": [
          {
            "field": "string",
            "value": "string"
          }
        ],
        "name": "string"
      }
    }
  ]
}

Properties

Name Type Required Restrictions Description
policyId string false none none
policyName string false none none
threatLevel integer(int32) false none none
policyViolationId string false none none
componentFacts [ComponentFact] false none none

ApiRepositoryComponentPath

{
  "pathname": "string",
  "quarantine": true
}

Properties

Name Type Required Restrictions Description
pathname string false none none
quarantine boolean false none none

ApiRepositoryPathResponseDTO

{
  "pathVersions": [
    {
      "requestIndex": 0,
      "repositoryComponentPaths": [
        {
          "pathname": "string",
          "quarantine": true
        }
      ]
    }
  ]
}

Properties

Name Type Required Restrictions Description
pathVersions [ApiRepositoryPathVersions] false none none

ApiRepositoryPathVersions

{
  "requestIndex": 0,
  "repositoryComponentPaths": [
    {
      "pathname": "string",
      "quarantine": true
    }
  ]
}

Properties

Name Type Required Restrictions Description
requestIndex integer(int32) false none none
repositoryComponentPaths [ApiRepositoryComponentPath] false none none

ApiReverseProxyAuthenticationConfigurationDTO

{
  "enabled": true,
  "usernameHeader": "string",
  "csrfProtectionDisabled": true,
  "logoutUrl": "string"
}

Properties

Name Type Required Restrictions Description
enabled boolean false none none
usernameHeader string false none none
csrfProtectionDisabled boolean false none none
logoutUrl string false none none

ApiMemberDTO

{
  "ownerId": "string",
  "ownerType": "string",
  "type": "USER",
  "userOrGroupName": "string"
}

Properties

Name Type Required Restrictions Description
ownerId string false none none
ownerType string false none none
type string false none none
userOrGroupName string false none none

Enumerated Values

Property Value
type USER
type GROUP

ApiRoleMemberMappingDTO

{
  "roleId": "string",
  "members": [
    {
      "ownerId": "string",
      "ownerType": "string",
      "type": "USER",
      "userOrGroupName": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
roleId string false none none
members [ApiMemberDTO] false none none

ApiRoleMemberMappingListDTO

{
  "memberMappings": [
    {
      "roleId": "string",
      "members": [
        {
          "ownerId": "string",
          "ownerType": "string",
          "type": "USER",
          "userOrGroupName": "string"
        }
      ]
    }
  ]
}

Properties

Name Type Required Restrictions Description
memberMappings [ApiRoleMemberMappingDTO] false none none

ApiRoleDTO

{
  "id": "string",
  "name": "string",
  "description": "string"
}

Properties

Name Type Required Restrictions Description
id string false none none
name string false none none
description string false none none

ApiRoleListDTO

{
  "roles": [
    {
      "id": "string",
      "name": "string",
      "description": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
roles [ApiRoleDTO] false none none

ApiSamlConfigurationResponseDTO

{
  "identityProviderName": "string",
  "entityId": "string",
  "firstNameAttributeName": "string",
  "lastNameAttributeName": "string",
  "emailAttributeName": "string",
  "usernameAttributeName": "string",
  "groupsAttributeName": "string",
  "validateResponseSignature": true,
  "validateAssertionSignature": true,
  "identityProviderMetadataXml": "string"
}

Properties

Name Type Required Restrictions Description
identityProviderName string false none none
entityId string false none none
firstNameAttributeName string false none none
lastNameAttributeName string false none none
emailAttributeName string false none none
usernameAttributeName string false none none
groupsAttributeName string false none none
validateResponseSignature boolean false none none
validateAssertionSignature boolean false none none
identityProviderMetadataXml string false none none

ApiSamlConfigurationDTO

{
  "identityProviderName": "string",
  "entityId": "string",
  "firstNameAttributeName": "string",
  "lastNameAttributeName": "string",
  "emailAttributeName": "string",
  "usernameAttributeName": "string",
  "groupsAttributeName": "string",
  "validateResponseSignature": true,
  "validateAssertionSignature": true
}

Properties

Name Type Required Restrictions Description
identityProviderName string false none none
entityId string false none none
firstNameAttributeName string false none none
lastNameAttributeName string false none none
emailAttributeName string false none none
usernameAttributeName string false none none
groupsAttributeName string false none none
validateResponseSignature boolean false none none
validateAssertionSignature boolean false none none

ApiSbomApplicationsHistoryMetricDTO

{
  "totalScannedApplications": 0,
  "applicationsUpdatedLastYear": 0,
  "applicationsUpdatedLastMonth": 0,
  "applicationsUpdatedLastWeek": 0
}

Properties

Name Type Required Restrictions Description
totalScannedApplications integer(int64) false none none
applicationsUpdatedLastYear integer(int64) false none none
applicationsUpdatedLastMonth integer(int64) false none none
applicationsUpdatedLastWeek integer(int64) false none none

SbomsAnalyzedMetricsDTO

{
  "total": 0,
  "threshold": 0
}

Properties

Name Type Required Restrictions Description
total integer(int64) false none none
threshold integer(int64) false none none

VulnerabilitiesThreadLevelMetricDTO

{
  "low": 0,
  "lowAnnotated": 0,
  "lowUnannotated": 0,
  "medium": 0,
  "mediumAnnotated": 0,
  "mediumUnannotated": 0,
  "high": 0,
  "highAnnotated": 0,
  "highUnannotated": 0,
  "critical": 0,
  "criticalAnnotated": 0,
  "criticalUnannotated": 0,
  "totalVulnerabilities": 0,
  "totalVulnerabilitiesAnnotated": 0,
  "totalVulnerabilitiesUnannotated": 0
}

Properties

Name Type Required Restrictions Description
low integer(int64) false none none
lowAnnotated integer(int64) false none none
lowUnannotated integer(int64) false none none
medium integer(int64) false none none
mediumAnnotated integer(int64) false none none
mediumUnannotated integer(int64) false none none
high integer(int64) false none none
highAnnotated integer(int64) false none none
highUnannotated integer(int64) false none none
critical integer(int64) false none none
criticalAnnotated integer(int64) false none none
criticalUnannotated integer(int64) false none none
totalVulnerabilities integer(int64) false none none
totalVulnerabilitiesAnnotated integer(int64) false none none
totalVulnerabilitiesUnannotated integer(int64) false none none

ApiSbomStatusDTO

{
  "downloadUrl": "string",
  "applicationId": "string",
  "version": "string",
  "isError": true,
  "errorMessage": "string"
}

Properties

Name Type Required Restrictions Description
downloadUrl string false none none
applicationId string false none none
version string false none none
isError boolean false none none
errorMessage string false none none

License

{
  "licenseId": "string",
  "licenseName": "string"
}

Properties

Name Type Required Restrictions Description
licenseId string false none none
licenseName string false none none

SbomComponentDTO

{
  "hash": "string",
  "packageUrl": "string",
  "name": "string",
  "version": "string",
  "dependencyType": "string",
  "componentIdentifier": {
    "format": "string",
    "coordinates": {
      "property1": "string",
      "property2": "string"
    }
  },
  "displayName": "string",
  "licenses": [
    {
      "licenseId": "string",
      "licenseName": "string"
    }
  ],
  "vulnerabilitySeverityNoneCount": 0,
  "vulnerabilitySeverityLowCount": 0,
  "vulnerabilitySeverityMediumCount": 0,
  "vulnerabilitySeverityHighCount": 0,
  "vulnerabilitySeverityCriticalCount": 0,
  "percentageAnnotated": 0.1
}

Properties

Name Type Required Restrictions Description
hash string false none none
packageUrl string false none none
name string false none none
version string false none none
dependencyType string false none none
componentIdentifier ComponentIdentifier false none none
displayName string false none none
licenses [License] false none none
vulnerabilitySeverityNoneCount integer(int32) false none none
vulnerabilitySeverityLowCount integer(int32) false none none
vulnerabilitySeverityMediumCount integer(int32) false none none
vulnerabilitySeverityHighCount integer(int32) false none none
vulnerabilitySeverityCriticalCount integer(int32) false none none
percentageAnnotated number(double) false none none

SbomComponentListDTO

{
  "totalResultsCount": 0,
  "results": [
    {
      "hash": "string",
      "packageUrl": "string",
      "name": "string",
      "version": "string",
      "dependencyType": "string",
      "componentIdentifier": {
        "format": "string",
        "coordinates": {
          "property1": "string",
          "property2": "string"
        }
      },
      "displayName": "string",
      "licenses": [
        {
          "licenseId": "string",
          "licenseName": "string"
        }
      ],
      "vulnerabilitySeverityNoneCount": 0,
      "vulnerabilitySeverityLowCount": 0,
      "vulnerabilitySeverityMediumCount": 0,
      "vulnerabilitySeverityHighCount": 0,
      "vulnerabilitySeverityCriticalCount": 0,
      "percentageAnnotated": 0.1
    }
  ]
}

Properties

Name Type Required Restrictions Description
totalResultsCount integer(int32) false none none
results [SbomComponentDTO] false none none

ThirdPartySbomMetadataSummaryDTO

{
  "applicationVersion": "string",
  "spec": "string",
  "specVersion": "string",
  "importDate": "2019-08-24T14:15:22Z",
  "none": 0,
  "low": 0,
  "medium": 0,
  "high": 0,
  "critical": 0
}

Properties

Name Type Required Restrictions Description
applicationVersion string false none none
spec string false none none
specVersion string false none none
importDate string(date-time) false none none
none integer(int32) false none none
low integer(int32) false none none
medium integer(int32) false none none
high integer(int32) false none none
critical integer(int32) false none none

ThirdPartySbomMetadataSummaryListDTO

{
  "totalResultsCount": 0,
  "results": [
    {
      "applicationVersion": "string",
      "spec": "string",
      "specVersion": "string",
      "importDate": "2019-08-24T14:15:22Z",
      "none": 0,
      "low": 0,
      "medium": 0,
      "high": 0,
      "critical": 0
    }
  ]
}

Properties

Name Type Required Restrictions Description
totalResultsCount integer(int32) false none none
results [ThirdPartySbomMetadataSummaryDTO] false none none

vulnerabilityAnalysis

{
  "state": "resolved",
  "justification": "code_not_present",
  "response": "can_not_fix",
  "detail": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "lastUpdatedOn": "2019-08-24T14:15:22Z",
  "lastUpdatedBy": "string"
}

Vulnerability analysis details.

Properties

Name Type Required Restrictions Description
state string true none Vulnerability analysis state.
justification string true none The rationale of why the impact analysis state was asserted
response string true none Vulnerability analysis response by an author, supplier or manufacturer for the affected component.
detail string true none Detailed description of the impact including methods used during assessment
createdOn string(date-time) false read-only none
lastUpdatedOn string(date-time) false read-only none
lastUpdatedBy string false read-only none

Enumerated Values

Property Value
state resolved
state resolved_with_pedigree
state exploitable
state in_triage
state false_positive
state not_affected
justification code_not_present
justification code_not_reachable
justification requires_configuration
justification requires_dependency
justification requires_environment
justification protected_by_compiler
justification protected_at_runtime
justification protected_at_perimeter
justification protected_by_mitigating_control
response can_not_fix
response will_not_fix
response update
response rollback
response workaround_available

SBOM vulnerability analysis request

{
  "componentLocator": {
    "hash": "string",
    "packageUrl": "string"
  },
  "vulnerabilityAnalysis": {
    "state": "resolved",
    "justification": "code_not_present",
    "response": "can_not_fix",
    "detail": "string",
    "createdOn": "2019-08-24T14:15:22Z",
    "lastUpdatedOn": "2019-08-24T14:15:22Z",
    "lastUpdatedBy": "string"
  }
}

Properties

Name Type Required Restrictions Description
componentLocator componentLocator true none Component details about the vulnerable component. Either hash or package URL must be provided
vulnerabilityAnalysis vulnerabilityAnalysis true none Vulnerability analysis details.

componentLocator

{
  "hash": "string",
  "packageUrl": "string"
}

Component details about the vulnerable component. Either hash or package URL must be provided

Properties

Name Type Required Restrictions Description
hash string false none Component hash
packageUrl string false none Component package URL

ApiSearchCriteriaDTOV2

{
  "stageId": "string",
  "hash": "string",
  "componentIdentifier": {
    "format": "string",
    "coordinates": {
      "property1": "string",
      "property2": "string"
    }
  },
  "packageUrl": "string"
}

Properties

Name Type Required Restrictions Description
stageId string false none none
hash string false none none
componentIdentifier ApiComponentIdentifierDTOV2 false none none
packageUrl string false none none

ApiSearchResultDTOV2

{
  "applicationId": "string",
  "applicationName": "string",
  "reportHtmlUrl": "string",
  "reportUrl": "string",
  "hash": "string",
  "componentIdentifier": {
    "format": "string",
    "coordinates": {
      "property1": "string",
      "property2": "string"
    }
  },
  "packageUrl": "string",
  "threatLevel": 0,
  "dependencyData": {
    "directDependency": true,
    "innerSource": true,
    "parentComponentPurls": [
      "string"
    ],
    "innerSourceData": [
      {
        "ownerApplicationName": "string",
        "ownerApplicationId": "string",
        "innerSourceComponentPurl": "string"
      }
    ]
  }
}

Properties

Name Type Required Restrictions Description
applicationId string false none none
applicationName string false none none
reportHtmlUrl string false none none
reportUrl string false none none
hash string false none none
componentIdentifier ApiComponentIdentifierDTOV2 false none none
packageUrl string false none none
threatLevel integer(int32) false none none
dependencyData ApiDependencyDataDTO false none none

ApiSearchResultsDTOV2

{
  "criteria": {
    "stageId": "string",
    "hash": "string",
    "componentIdentifier": {
      "format": "string",
      "coordinates": {
        "property1": "string",
        "property2": "string"
      }
    },
    "packageUrl": "string"
  },
  "results": [
    {
      "applicationId": "string",
      "applicationName": "string",
      "reportHtmlUrl": "string",
      "reportUrl": "string",
      "hash": "string",
      "componentIdentifier": {
        "format": "string",
        "coordinates": {
          "property1": "string",
          "property2": "string"
        }
      },
      "packageUrl": "string",
      "threatLevel": 0,
      "dependencyData": {
        "directDependency": true,
        "innerSource": true,
        "parentComponentPurls": [
          "string"
        ],
        "innerSourceData": [
          {
            "ownerApplicationName": "string",
            "ownerApplicationId": "string",
            "innerSourceComponentPurl": "string"
          }
        ]
      }
    }
  ]
}

Properties

Name Type Required Restrictions Description
criteria ApiSearchCriteriaDTOV2 false none none
results [ApiSearchResultDTOV2] false none none

ApiOwnerDTO

{
  "ownerPublicId": "string",
  "ownerId": "string",
  "ownerName": "string",
  "ownerType": "string"
}

Properties

Name Type Required Restrictions Description
ownerPublicId string false none none
ownerId string false none none
ownerName string false none none
ownerType string false none none

ApiSecurityVulnerabilityOverrideDTOV2

{
  "securityOverrideId": "string",
  "hash": "string",
  "referenceId": "string",
  "status": "string",
  "comment": "string",
  "owner": {
    "ownerPublicId": "string",
    "ownerId": "string",
    "ownerName": "string",
    "ownerType": "string"
  },
  "currentlyAffectedComponents": [
    {
      "packageUrl": "string",
      "hash": "string",
      "sha256": "string",
      "componentIdentifier": {
        "format": "string",
        "coordinates": {
          "property1": "string",
          "property2": "string"
        }
      },
      "displayName": "string",
      "proprietary": true,
      "thirdParty": true
    }
  ]
}

Properties

Name Type Required Restrictions Description
securityOverrideId string false none none
hash string false none none
referenceId string false none none
status string false none none
comment string false none none
owner ApiOwnerDTO false none none
currentlyAffectedComponents [ApiComponentDTOV2] false none none

ApiSecurityVulnerabilityOverrideResponseDTOV2

{
  "securityOverrides": [
    {
      "securityOverrideId": "string",
      "hash": "string",
      "referenceId": "string",
      "status": "string",
      "comment": "string",
      "owner": {
        "ownerPublicId": "string",
        "ownerId": "string",
        "ownerName": "string",
        "ownerType": "string"
      },
      "currentlyAffectedComponents": [
        {
          "packageUrl": "string",
          "hash": "string",
          "sha256": "string",
          "componentIdentifier": {
            "format": "string",
            "coordinates": {
              "property1": "string",
              "property2": "string"
            }
          },
          "displayName": "string",
          "proprietary": true,
          "thirdParty": true
        }
      ]
    }
  ]
}

Properties

Name Type Required Restrictions Description
securityOverrides [ApiSecurityVulnerabilityOverrideDTOV2] false none none

ApiSourceControlConfigurationDTO

{
  "cloneDirectory": "string",
  "gitImplementation": "native",
  "prCommentPurgeWindow": 0,
  "prEventPurgeWindow": 0,
  "gitExecutable": "string",
  "gitTimeoutSeconds": 0,
  "commitUsername": "string",
  "commitEmail": "string",
  "useUsernameInRepositoryCloneUrl": true,
  "defaultBranchMonitoringStartTime": "string",
  "defaultBranchMonitoringIntervalHours": 0,
  "pullRequestMonitoringIntervalSeconds": 0
}

Properties

Name Type Required Restrictions Description
cloneDirectory string false none none
gitImplementation string false none none
prCommentPurgeWindow integer(int32) false none none
prEventPurgeWindow integer(int32) false none none
gitExecutable string false none none
gitTimeoutSeconds integer(int32) false none none
commitUsername string false none none
commitEmail string false none none
useUsernameInRepositoryCloneUrl boolean false none none
defaultBranchMonitoringStartTime string false none none
defaultBranchMonitoringIntervalHours integer(int32) false none none
pullRequestMonitoringIntervalSeconds integer(int32) false none none

Enumerated Values

Property Value
gitImplementation native
gitImplementation java

ApiPullRequestResult

{
  "startTime": "2019-08-24T14:15:22Z",
  "title": "string",
  "exceptionThrown": true,
  "successful": true,
  "totalTime": 0,
  "reasoning": "string"
}

Properties

Name Type Required Restrictions Description
startTime string(date-time) false none none
title string false none none
exceptionThrown boolean false none none
successful boolean false none none
totalTime integer(int64) false none none
reasoning string false none none

ApiPullRequestResults

{
  "results": [
    {
      "startTime": "2019-08-24T14:15:22Z",
      "title": "string",
      "exceptionThrown": true,
      "successful": true,
      "totalTime": 0,
      "reasoning": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
results [ApiPullRequestResult] false none none

ApiSourceControlDTO

{
  "id": "string",
  "ownerId": "string",
  "repositoryUrl": "string",
  "username": "string",
  "token": "string",
  "provider": "string",
  "baseBranch": "string",
  "enablePullRequests": true,
  "remediationPullRequestsEnabled": true,
  "enableStatusChecks": true,
  "statusChecksEnabled": true,
  "pullRequestCommentingEnabled": true,
  "sourceControlEvaluationsEnabled": true,
  "sourceControlScanTarget": "string",
  "sshEnabled": true,
  "commitStatusEnabled": true
}

Properties

Name Type Required Restrictions Description
id string false none none
ownerId string false none none
repositoryUrl string false none none
username string false none none
token string false none none
provider string false none none
baseBranch string false none none
enablePullRequests boolean false none none
remediationPullRequestsEnabled boolean false none none
enableStatusChecks boolean false none none
statusChecksEnabled boolean false none none
pullRequestCommentingEnabled boolean false none none
sourceControlEvaluationsEnabled boolean false none none
sourceControlScanTarget string false none none
sshEnabled boolean false none none
commitStatusEnabled boolean false none none

ApiConditionFactReasonDTO

{
  "reason": "string"
}

Properties

Name Type Required Restrictions Description
reason string false none none

ApiConstraintFactDTO

{
  "constraintName": "string",
  "constraintId": "string",
  "reasons": [
    {
      "reason": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
constraintName string false none none
constraintId string false none none
reasons [ApiConditionFactReasonDTO] false none none

ApiStaleApplicationEvaluationDTO

{
  "application": {
    "id": "string",
    "publicId": "string",
    "name": "string",
    "organizationId": "string",
    "contactUserName": "string"
  },
  "stages": [
    {
      "stageId": "string",
      "lastEvaluationDate": "2019-08-24T14:15:22Z"
    }
  ]
}

Properties

Name Type Required Restrictions Description
application ApiApplicationBaseDTO false none none
stages [ApiStaleEvaluationStageDTO] false none none

ApiStaleEvaluationStageDTO

{
  "stageId": "string",
  "lastEvaluationDate": "2019-08-24T14:15:22Z"
}

Properties

Name Type Required Restrictions Description
stageId string false none none
lastEvaluationDate string(date-time) false none none

ApiStaleEvaluationsDTO

{
  "applications": [
    {
      "application": {
        "id": "string",
        "publicId": "string",
        "name": "string",
        "organizationId": "string",
        "contactUserName": "string"
      },
      "stages": [
        {
          "stageId": "string",
          "lastEvaluationDate": "2019-08-24T14:15:22Z"
        }
      ]
    }
  ],
  "repositories": [
    {
      "repository": {
        "repositoryId": "string",
        "publicId": "string",
        "format": "string",
        "type": "string",
        "auditEnabled": true,
        "quarantineEnabled": true,
        "policyCompliantComponentSelectionEnabled": true,
        "namespaceConfusionProtectionEnabled": true
      },
      "stages": [
        {
          "stageId": "string",
          "lastEvaluationDate": "2019-08-24T14:15:22Z"
        }
      ]
    }
  ]
}

Properties

Name Type Required Restrictions Description
applications [ApiStaleApplicationEvaluationDTO] false none none
repositories [ApiStaleRepositoryEvaluationDTO] false none none

ApiStaleRepositoryEvaluationDTO

{
  "repository": {
    "repositoryId": "string",
    "publicId": "string",
    "format": "string",
    "type": "string",
    "auditEnabled": true,
    "quarantineEnabled": true,
    "policyCompliantComponentSelectionEnabled": true,
    "namespaceConfusionProtectionEnabled": true
  },
  "stages": [
    {
      "stageId": "string",
      "lastEvaluationDate": "2019-08-24T14:15:22Z"
    }
  ]
}

Properties

Name Type Required Restrictions Description
repository ApiRepositoryDTO false none none
stages [ApiStaleEvaluationStageDTO] false none none

ApiStaleWaiverDTO

{
  "waiverId": "string",
  "policyId": "string",
  "policyName": "string",
  "comment": "string",
  "scopeOwnerType": "string",
  "scopeOwnerId": "string",
  "scopeOwnerName": "string",
  "createTime": "2019-08-24T14:15:22Z",
  "expiryTime": "2019-08-24T14:15:22Z",
  "creatorId": "string",
  "creatorName": "string",
  "constraintFacts": [
    {
      "constraintName": "string",
      "constraintId": "string",
      "reasons": [
        {
          "reason": "string"
        }
      ]
    }
  ],
  "staleEvaluations": {
    "applications": [
      {
        "application": {
          "id": "string",
          "publicId": "string",
          "name": "string",
          "organizationId": "string",
          "contactUserName": "string"
        },
        "stages": [
          {
            "stageId": "string",
            "lastEvaluationDate": "2019-08-24T14:15:22Z"
          }
        ]
      }
    ],
    "repositories": [
      {
        "repository": {
          "repositoryId": "string",
          "publicId": "string",
          "format": "string",
          "type": "string",
          "auditEnabled": true,
          "quarantineEnabled": true,
          "policyCompliantComponentSelectionEnabled": true,
          "namespaceConfusionProtectionEnabled": true
        },
        "stages": [
          {
            "stageId": "string",
            "lastEvaluationDate": "2019-08-24T14:15:22Z"
          }
        ]
      }
    ]
  }
}

Properties

Name Type Required Restrictions Description
waiverId string false none none
policyId string false none none
policyName string false none none
comment string false none none
scopeOwnerType string false none none
scopeOwnerId string false none none
scopeOwnerName string false none none
createTime string(date-time) false none none
expiryTime string(date-time) false none none
creatorId string false none none
creatorName string false none none
constraintFacts [ApiConstraintFactDTO] false none none
staleEvaluations ApiStaleEvaluationsDTO false none none

ApiStaleWaiversResponseDTO

{
  "staleWaivers": [
    {
      "waiverId": "string",
      "policyId": "string",
      "policyName": "string",
      "comment": "string",
      "scopeOwnerType": "string",
      "scopeOwnerId": "string",
      "scopeOwnerName": "string",
      "createTime": "2019-08-24T14:15:22Z",
      "expiryTime": "2019-08-24T14:15:22Z",
      "creatorId": "string",
      "creatorName": "string",
      "constraintFacts": [
        {
          "constraintName": "string",
          "constraintId": "string",
          "reasons": [
            {
              "reason": "string"
            }
          ]
        }
      ],
      "staleEvaluations": {
        "applications": [
          {
            "application": {
              "id": "string",
              "publicId": "string",
              "name": "string",
              "organizationId": "string",
              "contactUserName": "string"
            },
            "stages": [
              {
                "stageId": "string",
                "lastEvaluationDate": "2019-08-24T14:15:22Z"
              }
            ]
          }
        ],
        "repositories": [
          {
            "repository": {
              "repositoryId": "string",
              "publicId": "string",
              "format": "string",
              "type": "string",
              "auditEnabled": true,
              "quarantineEnabled": true,
              "policyCompliantComponentSelectionEnabled": true,
              "namespaceConfusionProtectionEnabled": true
            },
            "stages": [
              {
                "stageId": "string",
                "lastEvaluationDate": "2019-08-24T14:15:22Z"
              }
            ]
          }
        ]
      }
    }
  ]
}

Properties

Name Type Required Restrictions Description
staleWaivers [ApiStaleWaiverDTO] false none none

IdeUsersOverviewDTO

{
  "userCount": 0
}

Properties

Name Type Required Restrictions Description
userCount integer(int64) false none none

ApiEvaluationResultCounterDTO

{
  "critical": 0,
  "severe": 0,
  "moderate": 0
}

Properties

Name Type Required Restrictions Description
critical integer(int32) false none none
severe integer(int32) false none none
moderate integer(int32) false none none

ApiThirdPartyScanResultDTO

{
  "policyAction": "string",
  "reportHtmlUrl": "string",
  "reportPdfUrl": "string",
  "reportDataUrl": "string",
  "embeddableReportHtmlUrl": "string",
  "isError": true,
  "errorMessage": "string",
  "componentsAffected": {
    "critical": 0,
    "severe": 0,
    "moderate": 0
  },
  "openPolicyViolations": {
    "critical": 0,
    "severe": 0,
    "moderate": 0
  },
  "grandfatheredPolicyViolations": 0,
  "legacyViolations": 0
}

Properties

Name Type Required Restrictions Description
policyAction string false none none
reportHtmlUrl string false none none
reportPdfUrl string false none none
reportDataUrl string false none none
embeddableReportHtmlUrl string false none none
isError boolean false none none
errorMessage string false none none
componentsAffected ApiEvaluationResultCounterDTO false none none
openPolicyViolations ApiEvaluationResultCounterDTO false none none
grandfatheredPolicyViolations integer(int32) false none none
legacyViolations integer(int32) false none none

ApiUserDTO

{
  "username": "string",
  "password": "string",
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "realm": "string"
}

Properties

Name Type Required Restrictions Description
username string false none none
password string false none none
firstName string false none none
lastName string false none none
email string false none none
realm string false none none

ApiUserListDTO

{
  "users": [
    {
      "username": "string",
      "password": "string",
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "realm": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
users [ApiUserDTO] false none none

ApiUserTokenDTO

{
  "userCode": "string",
  "passCode": "string",
  "username": "string",
  "realm": "string"
}

Properties

Name Type Required Restrictions Description
userCode string false none none
passCode string false none none
username string false none none
realm string false none none

ApiUserTokenExistsDTO

{
  "userTokenExists": true
}

Properties

Name Type Required Restrictions Description
userTokenExists boolean false none none

CweId

{
  "id": "string",
  "uri": "http://example.com"
}

Properties

Name Type Required Restrictions Description
id string false none none
uri string(uri) false none none 

{
  "referenceType": "string",
  "url": "string"
}

Properties

Name Type Required Restrictions Description
referenceType string false none none
url string false none none

RootCause

{
  "listOfPaths": [
    "string"
  ],
  "versionRange": "string"
}

Properties

Name Type Required Restrictions Description
listOfPaths [string] false none none
versionRange string false none none

SecurityVulnerabilityCustomData

{
  "remediation": "string",
  "cweId": "string",
  "cvssVector": "string",
  "cvssSeverity": 0.1
}

Properties

Name Type Required Restrictions Description
remediation string false none none
cweId string false none none
cvssVector string false none none
cvssSeverity number(float) false none none

SecurityVulnerabilityData

{
  "identifier": "string",
  "vulnIds": [
    "string"
  ],
  "vulnerabilityLink": "http://example.com",
  "source": {
    "shortName": "string",
    "longName": "string"
  },
  "mainSeverity": {
    "source": "string",
    "sourceLabel": "string",
    "score": 0.1,
    "vector": "string"
  },
  "severityScores": [
    {
      "source": "string",
      "sourceLabel": "string",
      "score": 0.1,
      "vector": "string"
    }
  ],
  "weakness": {
    "cweSource": "string",
    "cweIds": [
      {
        "id": "string",
        "uri": "http://example.com"
      }
    ]
  },
  "categories": [
    "string"
  ],
  "description": "string",
  "explanationMarkdown": "string",
  "componentExplanationMarkdown": "string",
  "detectionMarkdown": "string",
  "componentDetectionMarkdown": "string",
  "recommendationMarkdown": "string",
  "componentRecommendationMarkdown": "string",
  "rootCauses": [
    {
      "listOfPaths": [
        "string"
      ],
      "versionRange": "string"
    }
  ],
  "advisories": [
    {
      "referenceType": "string",
      "url": "string"
    }
  ],
  "vulnerableVersionRanges": [
    "string"
  ],
  "researchType": "FAST_TRACK",
  "isAdvancedVulnerabilityDetection": true,
  "customData": {
    "remediation": "string",
    "cweId": "string",
    "cvssVector": "string",
    "cvssSeverity": 0.1
  }
}

Properties

Name Type Required Restrictions Description
identifier string false none none
vulnIds [string] false none none
vulnerabilityLink string(uri) false none none
source VulnerabilitySource false none none
mainSeverity SecurityVulnerabilitySeverity false none none
severityScores [SecurityVulnerabilitySeverity] false none none
weakness SecurityVulnerabilityWeakness false none none
categories [string] false none none
description string false none none
explanationMarkdown string false none none
componentExplanationMarkdown string false none none
detectionMarkdown string false none none
componentDetectionMarkdown string false none none
recommendationMarkdown string false none none
componentRecommendationMarkdown string false none none
rootCauses [RootCause] false none none
advisories [ReferenceLink] false none none
vulnerableVersionRanges [string] false none none
researchType string false none none
isAdvancedVulnerabilityDetection boolean false none none
customData SecurityVulnerabilityCustomData false none none

Enumerated Values

Property Value
researchType FAST_TRACK
researchType DEEP_DIVE

SecurityVulnerabilitySeverity

{
  "source": "string",
  "sourceLabel": "string",
  "score": 0.1,
  "vector": "string"
}

Properties

Name Type Required Restrictions Description
source string false none none
sourceLabel string false none none
score number(float) false none none
vector string false none none

SecurityVulnerabilityWeakness

{
  "cweSource": "string",
  "cweIds": [
    {
      "id": "string",
      "uri": "http://example.com"
    }
  ]
}

Properties

Name Type Required Restrictions Description
cweSource string false none none
cweIds [CweId] false none none

VulnerabilitySource

{
  "shortName": "string",
  "longName": "string"
}

Properties

Name Type Required Restrictions Description
shortName string false none none
longName string false none none

ApiArtifactoryConnectionDTO

{
  "artifactoryConnectionId": "string",
  "ownerType": "application",
  "ownerId": "string",
  "isAnonymous": true,
  "baseUrl": "string",
  "username": "string",
  "password": "string"
}

Properties

Name Type Required Restrictions Description
artifactoryConnectionId string false none none
ownerType string false none none
ownerId string false none none
isAnonymous boolean false none none
baseUrl string false none none
username string false none none
password string false none none

Enumerated Values

Property Value
ownerType application
ownerType organization
ownerType repository_container
ownerType repository_manager
ownerType repository
ownerType global

ApiArtifactoryConnectionStatusResponseDTO

{
  "enabled": true,
  "inheritedFromOrganizationId": "string",
  "inheritedFromOrganizationName": "string",
  "allowOverride": true,
  "inheritedFromOrgEnabled": true,
  "allowChange": true
}

Properties

Name Type Required Restrictions Description
enabled boolean false none none
inheritedFromOrganizationId string false none none
inheritedFromOrganizationName string false none none
allowOverride boolean false none none
inheritedFromOrgEnabled boolean false none none
allowChange boolean false none none

ApiOwnerArtifactoryConnectionDTO

{
  "artifactoryConnection": {
    "artifactoryConnectionId": "string",
    "ownerType": "application",
    "ownerId": "string",
    "isAnonymous": true,
    "baseUrl": "string",
    "username": "string",
    "password": "string"
  },
  "artifactoryConnectionStatus": {
    "enabled": true,
    "inheritedFromOrganizationId": "string",
    "inheritedFromOrganizationName": "string",
    "allowOverride": true,
    "inheritedFromOrgEnabled": true,
    "allowChange": true
  },
  "ownerDTO": {
    "ownerPublicId": "string",
    "ownerId": "string",
    "ownerName": "string",
    "ownerType": "string"
  }
}

Properties

Name Type Required Restrictions Description
artifactoryConnection ApiArtifactoryConnectionDTO false none none
artifactoryConnectionStatus ApiArtifactoryConnectionStatusResponseDTO false none none
ownerDTO ApiOwnerDTO false none none

ApiArtifactoryConnectionStatusRequestDTO

{
  "enabled": true,
  "allowOverride": true
}

Properties

Name Type Required Restrictions Description
enabled boolean false none none
allowOverride boolean false none none
Java Python JavaScript