All URIs are relative to http://localhost/api/v2.0
| Method | HTTP request | Description |
|---|---|---|
| CreateScanAllSchedule | Post /system/scanAll/schedule | Create a schedule or a manual trigger for the scan all job. |
| GetLatestScanAllMetrics | Get /scans/all/metrics | Get the metrics of the latest scan all process |
| GetLatestScheduledScanAllMetrics | Get /scans/schedule/metrics | Get the metrics of the latest scheduled scan all process |
| GetScanAllSchedule | Get /system/scanAll/schedule | Get scan all's schedule. |
| StopScanAll | Post /system/scanAll/stop | Stop scanAll job execution |
| UpdateScanAllSchedule | Put /system/scanAll/schedule | Update scan all's schedule. |
CreateScanAllSchedule(ctx, schedule, optional) Create a schedule or a manual trigger for the scan all job.
This endpoint is for creating a schedule or a manual trigger for the scan all job, which scans all of images in Harbor.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| schedule | Schedule | Create a schedule or a manual trigger for the scan all job. | |
| optional | *ScanAllApiCreateScanAllScheduleOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a ScanAllApiCreateScanAllScheduleOpts 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]
Stats GetLatestScanAllMetrics(ctx, optional) Get the metrics of the latest scan all process
Get the metrics of the latest scan all process
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *ScanAllApiGetLatestScanAllMetricsOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a ScanAllApiGetLatestScanAllMetricsOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| xRequestId | optional.String | An unique ID for the request |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Stats GetLatestScheduledScanAllMetrics(ctx, optional) Get the metrics of the latest scheduled scan all process
Get the metrics of the latest scheduled scan all process
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *ScanAllApiGetLatestScheduledScanAllMetricsOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a ScanAllApiGetLatestScheduledScanAllMetricsOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| xRequestId | optional.String | An unique ID for the request |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Schedule GetScanAllSchedule(ctx, optional) Get scan all's schedule.
This endpoint is for getting a schedule for the scan all job, which scans all of images in Harbor.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *ScanAllApiGetScanAllScheduleOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a ScanAllApiGetScanAllScheduleOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| xRequestId | optional.String | An unique ID for the request |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
StopScanAll(ctx, optional) Stop scanAll job execution
Stop scanAll job execution
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *ScanAllApiStopScanAllOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a ScanAllApiStopScanAllOpts 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]
UpdateScanAllSchedule(ctx, schedule, optional) Update scan all's schedule.
This endpoint is for updating the schedule of scan all job, which scans all of images in Harbor.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| schedule | Schedule | Updates the schedule of scan all job, which scans all of images in Harbor. | |
| optional | *ScanAllApiUpdateScanAllScheduleOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a ScanAllApiUpdateScanAllScheduleOpts 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]