All URIs are relative to http://localhost/api/v2.0
| Method | HTTP request | Description |
|---|---|---|
| CreateScanner | Post /scanners | Create a scanner registration |
| DeleteScanner | Delete /scanners/{registration_id} | Delete a scanner registration |
| GetScanner | Get /scanners/{registration_id} | Get a scanner registration details |
| GetScannerMetadata | Get /scanners/{registration_id}/metadata | Get the metadata of the specified scanner registration |
| ListScanners | Get /scanners | List scanner registrations |
| PingScanner | Post /scanners/ping | Tests scanner registration settings |
| SetScannerAsDefault | Patch /scanners/{registration_id} | Set system default scanner registration |
| UpdateScanner | Put /scanners/{registration_id} | Update a scanner registration |
CreateScanner(ctx, registration, optional) Create a scanner registration
Creats a new scanner registration with the given data.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| registration | ScannerRegistrationReq | A scanner registration to be created. | |
| optional | *ScannerApiCreateScannerOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a ScannerApiCreateScannerOpts 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]
ScannerRegistration DeleteScanner(ctx, registrationId, optional) Delete a scanner registration
Deletes the specified scanner registration.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| registrationId | string | The scanner registration identifier. | |
| optional | *ScannerApiDeleteScannerOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a ScannerApiDeleteScannerOpts 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]
ScannerRegistration GetScanner(ctx, registrationId, optional) Get a scanner registration details
Retruns the details of the specified scanner registration.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| registrationId | string | The scanner registration identifer. | |
| optional | *ScannerApiGetScannerOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a ScannerApiGetScannerOpts 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]
ScannerAdapterMetadata GetScannerMetadata(ctx, registrationId, optional) Get the metadata of the specified scanner registration
Get the metadata of the specified scanner registration, including the capabilities and customized properties.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| registrationId | string | The scanner registration identifier. | |
| optional | *ScannerApiGetScannerMetadataOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a ScannerApiGetScannerMetadataOpts 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]
[]ScannerRegistration ListScanners(ctx, optional) List scanner registrations
Returns a list of currently configured scanner registrations.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *ScannerApiListScannersOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a ScannerApiListScannersOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| xRequestId | optional.String | An unique ID for the request | |
| q | optional.String | Query string to query resources. Supported query patterns are "exact match(k=v)", "fuzzy match(k= |
|
| sort | optional.String | Sort the resource list in ascending or descending order. e.g. sort by field1 in ascending orderr and field2 in descending order with "sort=field1,-field2" | |
| page | optional.Int64 | The page number | [default to 1] |
| pageSize | optional.Int64 | The size of per page | [default to 10] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PingScanner(ctx, settings, optional) Tests scanner registration settings
Pings scanner adapter to test endpoint URL and authorization settings.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| settings | ScannerRegistrationSettings | A scanner registration settings to be tested. | |
| optional | *ScannerApiPingScannerOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a ScannerApiPingScannerOpts 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]
SetScannerAsDefault(ctx, registrationId, payload, optional) Set system default scanner registration
Set the specified scanner registration as the system default one.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| registrationId | string | The scanner registration identifier. | |
| payload | IsDefault | ||
| optional | *ScannerApiSetScannerAsDefaultOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a ScannerApiSetScannerAsDefaultOpts 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]
UpdateScanner(ctx, registrationId, registration, optional) Update a scanner registration
Updates the specified scanner registration.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| registrationId | string | The scanner registration identifier. | |
| registration | ScannerRegistrationReq | A scanner registraiton to be updated. | |
| optional | *ScannerApiUpdateScannerOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a ScannerApiUpdateScannerOpts 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]