Skip to content

Latest commit

 

History

History
321 lines (173 loc) · 8.3 KB

ArchivesApi.md

File metadata and controls

321 lines (173 loc) · 8.3 KB

\ArchivesApi

All URIs are relative to http://localhost

Method HTTP request Description
ArchiveImageAnalysis Post /archives/images
CreateAnalysisArchiveRule Post /archives/rules
DeleteAnalysisArchiveRule Delete /archives/rules/{ruleId}
DeleteArchivedAnalysis Delete /archives/images/{imageDigest}
GetAnalysisArchiveRule Get /archives/rules/{ruleId}
GetArchivedAnalysis Get /archives/images/{imageDigest}
ListAnalysisArchive Get /archives/images
ListAnalysisArchiveRules Get /archives/rules
ListArchives Get /archives

ArchiveImageAnalysis

[]AnalysisArchiveAddResult ArchiveImageAnalysis(ctx, imageReferences)

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
imageReferences []string

Return type

[]AnalysisArchiveAddResult

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateAnalysisArchiveRule

AnalysisArchiveTransitionRule CreateAnalysisArchiveRule(ctx, rule)

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
rule AnalysisArchiveTransitionRule

Return type

AnalysisArchiveTransitionRule

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteAnalysisArchiveRule

AnalysisArchiveTransitionRule DeleteAnalysisArchiveRule(ctx, ruleId)

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
ruleId string

Return type

AnalysisArchiveTransitionRule

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteArchivedAnalysis

ArchivedAnalysis DeleteArchivedAnalysis(ctx, imageDigest, optional)

Performs a synchronous archive deletion

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
imageDigest string
optional *DeleteArchivedAnalysisOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DeleteArchivedAnalysisOpts struct

Name Type Description Notes

force | optional.Bool| |

Return type

ArchivedAnalysis

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAnalysisArchiveRule

AnalysisArchiveTransitionRule GetAnalysisArchiveRule(ctx, ruleId)

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
ruleId string

Return type

AnalysisArchiveTransitionRule

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetArchivedAnalysis

ArchivedAnalysis GetArchivedAnalysis(ctx, imageDigest)

Returns the archive metadata record identifying the image and tags for the analysis in the archive.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
imageDigest string The image digest to identify the image analysis

Return type

ArchivedAnalysis

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListAnalysisArchive

[]ArchivedAnalysis ListAnalysisArchive(ctx, )

Required Parameters

This endpoint does not need any parameter.

Return type

[]ArchivedAnalysis

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListAnalysisArchiveRules

[]AnalysisArchiveTransitionRule ListAnalysisArchiveRules(ctx, optional)

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *ListAnalysisArchiveRulesOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ListAnalysisArchiveRulesOpts struct

Name Type Description Notes
systemGlobal optional.Bool If true include system global rules (owned by admin) even for non-admin users. Defaults to true if not set. Can be set to false to exclude globals

Return type

[]AnalysisArchiveTransitionRule

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListArchives

ArchiveSummary ListArchives(ctx, )

Required Parameters

This endpoint does not need any parameter.

Return type

ArchiveSummary

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]