All URIs are relative to http://localhost
| Method | HTTP request | Description |
|---|---|---|
| GetOauthToken | Post /oauth/token | |
| HealthCheck | Get /health | |
| ListFileContentSearchResults | Get /images/{imageDigest}/artifacts/file_content_search | Return a list of analyzer artifacts of the specified type |
| ListRetrievedFiles | Get /images/{imageDigest}/artifacts/retrieved_files | Return a list of analyzer artifacts of the specified type |
| ListSecretSearchResults | Get /images/{imageDigest}/artifacts/secret_search | Return a list of analyzer artifacts of the specified type |
| Ping | Get / | |
| VersionCheck | Get /version |
TokenResponse GetOauthToken(ctx, optional)
Request a jwt token for subsequent operations, this request is authenticated with normal HTTP auth
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *GetOauthTokenOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a GetOauthTokenOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| grantType | optional.String | OAuth Grant type for token | [default to password] |
| username | optional.String | User to assign OAuth token to | |
| password | optional.String | Password for corresponding user | |
| clientId | optional.String | The type of client used for the OAuth token | [default to anonymous] |
No authorization required
- Content-Type: application/x-www-form-urlencoded
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
HealthCheck(ctx, )
Health check, returns 200 and no body if service is running
This endpoint does not need any parameter.
(empty response body)
No authorization required
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]FileContentSearchResult ListFileContentSearchResults(ctx, imageDigest)
Return a list of analyzer artifacts of the specified type
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| imageDigest | string |
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]RetrievedFile ListRetrievedFiles(ctx, imageDigest)
Return a list of analyzer artifacts of the specified type
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| imageDigest | string |
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]SecretSearchResult ListSecretSearchResults(ctx, imageDigest)
Return a list of analyzer artifacts of the specified type
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| imageDigest | string |
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
string Ping(ctx, )
Simple status check
This endpoint does not need any parameter.
string
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ServiceVersion VersionCheck(ctx, )
Returns the version object for the service, including db schema version info
This endpoint does not need any parameter.
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]