All URIs are relative to http://localhost/api/v2.0
| Method | HTTP request | Description |
|---|---|---|
| GetReportLog | Get /projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/scan/{report_id}/log | Get the log of the scan report |
| ScanArtifact | Post /projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/scan | Scan the artifact |
| StopScanArtifact | Post /projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/scan/stop | Cancelling a scan job for a particular artifact |
string GetReportLog(ctx, projectName, repositoryName, reference, reportId, optional) Get the log of the scan report
Get the log of the scan report
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| projectName | string | The name of the project | |
| repositoryName | string | The name of the repository. If it contains slash, encode it with URL encoding. e.g. a/b -> a%252Fb | |
| reference | string | The reference of the artifact, can be digest or tag | |
| reportId | string | The report id to get the log | |
| optional | *ScanApiGetReportLogOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a ScanApiGetReportLogOpts struct
| Name | Type | Description | Notes |
|---|
xRequestId | optional.String| An unique ID for the request |
string
- Content-Type: application/json
- Accept: text/plain
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ScanArtifact(ctx, projectName, repositoryName, reference, optional) Scan the artifact
Scan the specified artifact
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| projectName | string | The name of the project | |
| repositoryName | string | The name of the repository. If it contains slash, encode it with URL encoding. e.g. a/b -> a%252Fb | |
| reference | string | The reference of the artifact, can be digest or tag | |
| optional | *ScanApiScanArtifactOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a ScanApiScanArtifactOpts struct
| Name | Type | Description | Notes |
|---|
xRequestId | optional.String| An unique ID for the request |
(empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
StopScanArtifact(ctx, projectName, repositoryName, reference, optional) Cancelling a scan job for a particular artifact
Cancelling a scan job for a particular artifact
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| projectName | string | The name of the project | |
| repositoryName | string | The name of the repository. If it contains slash, encode it with URL encoding. e.g. a/b -> a%252Fb | |
| reference | string | The reference of the artifact, can be digest or tag | |
| optional | *ScanApiStopScanArtifactOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a ScanApiStopScanArtifactOpts struct
| Name | Type | Description | Notes |
|---|
xRequestId | optional.String| An unique ID for the request |
(empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]