https://github.com/sh4d1/go-anchore
Go API for anchore-engine, created by Swagger
https://github.com/sh4d1/go-anchore
Last synced: about 1 year ago
JSON representation
Go API for anchore-engine, created by Swagger
- Host: GitHub
- URL: https://github.com/sh4d1/go-anchore
- Owner: Sh4d1
- Created: 2018-05-05T17:25:03.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-05-05T17:25:24.000Z (about 8 years ago)
- Last Synced: 2025-02-07T06:31:57.660Z (over 1 year ago)
- Language: Go
- Size: 206 KB
- Stars: 0
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Go API client for swagger
This is the Anchore Engine API. Provides the primary external API for users of the service.
## Overview
This API client was generated by the [swagger-codegen](https://github.com/swagger-api/swagger-codegen) project. By using the [swagger-spec](https://github.com/swagger-api/swagger-spec) from a remote server, you can easily generate an API client.
- API version: 0.1.5
- Package version: 1.0.0
- Build package: io.swagger.codegen.languages.GoClientCodegen
## Installation
Put the package under your project folder and add the following in import:
```
"./swagger"
```
## Documentation for API Endpoints
All URIs are relative to *http://localhost*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*CatalogApi* | [**AddRepository**](docs/CatalogApi.md#addrepository) | **Post** /repositories | Add repository to watch
*CatalogApi* | [**GetSystemFeeds**](docs/CatalogApi.md#getsystemfeeds) | **Get** /system/feeds | list feeds operations and information
*CatalogApi* | [**GetSystemPruneCandidates**](docs/CatalogApi.md#getsystemprunecandidates) | **Get** /system/prune/{resourcetype} | Get list of candidates for pruning
*CatalogApi* | [**GetSystemPruneResourcetypes**](docs/CatalogApi.md#getsystempruneresourcetypes) | **Get** /system/prune | Get list of resources that can be pruned
*CatalogApi* | [**PostSystemFeeds**](docs/CatalogApi.md#postsystemfeeds) | **Post** /system/feeds | trigger feeds operations
*CatalogApi* | [**PostSystemPruneCandidates**](docs/CatalogApi.md#postsystemprunecandidates) | **Post** /system/prune/{resourcetype} | Perform pruning on input resource name
*DefaultApi* | [**Ping**](docs/DefaultApi.md#ping) | **Get** / |
*ImageContentApi* | [**GetImageContentByType**](docs/ImageContentApi.md#getimagecontentbytype) | **Get** /images/{imageDigest}/content/{ctype} | Get the content of an image by type
*ImageContentApi* | [**GetImageContentByTypeImageId**](docs/ImageContentApi.md#getimagecontentbytypeimageid) | **Get** /images/by_id/{imageId}/content/{ctype} | Get the content of an image by type
*ImageContentApi* | [**ListImageContent**](docs/ImageContentApi.md#listimagecontent) | **Get** /images/{imageDigest}/content | List image content types
*ImageContentApi* | [**ListImageContentByImageid**](docs/ImageContentApi.md#listimagecontentbyimageid) | **Get** /images/by_id/{imageId}/content | List image content types
*ImageTagsApi* | [**ListImagetags**](docs/ImageTagsApi.md#listimagetags) | **Get** /summaries/imagetags | List all visible image digests and tags
*ImagesApi* | [**AddImage**](docs/ImagesApi.md#addimage) | **Post** /images | Submit a new image for analysis by the engine
*ImagesApi* | [**DeleteImage**](docs/ImagesApi.md#deleteimage) | **Delete** /images/{imageDigest} | Delete an image analysis
*ImagesApi* | [**DeleteImageByImageId**](docs/ImagesApi.md#deleteimagebyimageid) | **Delete** /images/by_id/{imageId} | Delete image by docker imageId
*ImagesApi* | [**GetImage**](docs/ImagesApi.md#getimage) | **Get** /images/{imageDigest} | Get image metadata
*ImagesApi* | [**GetImageByImageId**](docs/ImagesApi.md#getimagebyimageid) | **Get** /images/by_id/{imageId} | Lookup image by docker imageId
*ImagesApi* | [**GetImageContentByType**](docs/ImagesApi.md#getimagecontentbytype) | **Get** /images/{imageDigest}/content/{ctype} | Get the content of an image by type
*ImagesApi* | [**GetImageContentByTypeImageId**](docs/ImagesApi.md#getimagecontentbytypeimageid) | **Get** /images/by_id/{imageId}/content/{ctype} | Get the content of an image by type
*ImagesApi* | [**GetImagePolicyCheck**](docs/ImagesApi.md#getimagepolicycheck) | **Get** /images/{imageDigest}/check | Check policy evaluation status for image
*ImagesApi* | [**GetImagePolicyCheckByImageId**](docs/ImagesApi.md#getimagepolicycheckbyimageid) | **Get** /images/by_id/{imageId}/check | Check policy evaluation status for image
*ImagesApi* | [**GetImageVulnerabilitiesByType**](docs/ImagesApi.md#getimagevulnerabilitiesbytype) | **Get** /images/{imageDigest}/vuln/{vtype} | Get vulnerabilities by type
*ImagesApi* | [**GetImageVulnerabilitiesByTypeImageId**](docs/ImagesApi.md#getimagevulnerabilitiesbytypeimageid) | **Get** /images/by_id/{imageId}/vuln/{vtype} | Get vulnerabilities by type
*ImagesApi* | [**GetImageVulnerabilityTypes**](docs/ImagesApi.md#getimagevulnerabilitytypes) | **Get** /images/{imageDigest}/vuln | Get vulnerability types
*ImagesApi* | [**GetImageVulnerabilityTypesByImageId**](docs/ImagesApi.md#getimagevulnerabilitytypesbyimageid) | **Get** /images/by_id/{imageId}/vuln | Get vulnerability types
*ImagesApi* | [**ImportImage**](docs/ImagesApi.md#importimage) | **Post** /imageimport | Import and image analysis directly
*ImagesApi* | [**ListImageContent**](docs/ImagesApi.md#listimagecontent) | **Get** /images/{imageDigest}/content | List image content types
*ImagesApi* | [**ListImageContentByImageid**](docs/ImagesApi.md#listimagecontentbyimageid) | **Get** /images/by_id/{imageId}/content | List image content types
*ImagesApi* | [**ListImages**](docs/ImagesApi.md#listimages) | **Get** /images | List all visible images
*PoliciesApi* | [**AddPolicy**](docs/PoliciesApi.md#addpolicy) | **Post** /policies | Add a new policy
*PoliciesApi* | [**DeletePolicy**](docs/PoliciesApi.md#deletepolicy) | **Delete** /policies/{policyId} | Delete policy
*PoliciesApi* | [**GetPolicy**](docs/PoliciesApi.md#getpolicy) | **Get** /policies/{policyId} | Get specific policy
*PoliciesApi* | [**ListPolicies**](docs/PoliciesApi.md#listpolicies) | **Get** /policies | List policies
*PoliciesApi* | [**UpdatePolicy**](docs/PoliciesApi.md#updatepolicy) | **Put** /policies/{policyId} | Update policy
*PolicyApi* | [**DescribePolicy**](docs/PolicyApi.md#describepolicy) | **Get** /system/policy_spec | Describe the policy language spec implemented by this service.
*PolicyEvaluationApi* | [**GetImagePolicyCheck**](docs/PolicyEvaluationApi.md#getimagepolicycheck) | **Get** /images/{imageDigest}/check | Check policy evaluation status for image
*PolicyEvaluationApi* | [**GetImagePolicyCheckByImageId**](docs/PolicyEvaluationApi.md#getimagepolicycheckbyimageid) | **Get** /images/by_id/{imageId}/check | Check policy evaluation status for image
*RegistriesApi* | [**CreateRegistry**](docs/RegistriesApi.md#createregistry) | **Post** /registries | Add a new registry
*RegistriesApi* | [**DeleteRegistry**](docs/RegistriesApi.md#deleteregistry) | **Delete** /registries/{registry} | Delete a registry configuration
*RegistriesApi* | [**GetRegistry**](docs/RegistriesApi.md#getregistry) | **Get** /registries/{registry} | Get a specific registry configuration
*RegistriesApi* | [**ListRegistries**](docs/RegistriesApi.md#listregistries) | **Get** /registries | List configured registries
*RegistriesApi* | [**UpdateRegistry**](docs/RegistriesApi.md#updateregistry) | **Put** /registries/{registry} | Update/replace a registry configuration
*ServicesApi* | [**DeleteService**](docs/ServicesApi.md#deleteservice) | **Delete** /system/services/{servicename}/{hostid} | Delete the service config
*ServicesApi* | [**GetServicesByName**](docs/ServicesApi.md#getservicesbyname) | **Get** /system/services/{servicename} | Get a service configuration and state
*ServicesApi* | [**GetServicesByNameAndHost**](docs/ServicesApi.md#getservicesbynameandhost) | **Get** /system/services/{servicename}/{hostid} | Get service config for a specific host
*ServicesApi* | [**ListServices**](docs/ServicesApi.md#listservices) | **Get** /system/services | List system services
*SubscriptionsApi* | [**AddSubscription**](docs/SubscriptionsApi.md#addsubscription) | **Post** /subscriptions | Add a subscription of a specific type
*SubscriptionsApi* | [**DeleteSubscription**](docs/SubscriptionsApi.md#deletesubscription) | **Delete** /subscriptions/{subscriptionId} | Delete subscriptions of a specific type
*SubscriptionsApi* | [**GetSubscription**](docs/SubscriptionsApi.md#getsubscription) | **Get** /subscriptions/{subscriptionId} | Get a specific subscription set
*SubscriptionsApi* | [**ListSubscriptions**](docs/SubscriptionsApi.md#listsubscriptions) | **Get** /subscriptions | List all subscriptions
*SubscriptionsApi* | [**UpdateSubscription**](docs/SubscriptionsApi.md#updatesubscription) | **Put** /subscriptions/{subscriptionId} | Update an existing and specific subscription
*SystemApi* | [**DeleteService**](docs/SystemApi.md#deleteservice) | **Delete** /system/services/{servicename}/{hostid} | Delete the service config
*SystemApi* | [**DescribePolicy**](docs/SystemApi.md#describepolicy) | **Get** /system/policy_spec | Describe the policy language spec implemented by this service.
*SystemApi* | [**GetServiceDetail**](docs/SystemApi.md#getservicedetail) | **Get** /system | System status
*SystemApi* | [**GetServicesByName**](docs/SystemApi.md#getservicesbyname) | **Get** /system/services/{servicename} | Get a service configuration and state
*SystemApi* | [**GetServicesByNameAndHost**](docs/SystemApi.md#getservicesbynameandhost) | **Get** /system/services/{servicename}/{hostid} | Get service config for a specific host
*SystemApi* | [**GetStatus**](docs/SystemApi.md#getstatus) | **Get** /status | Service status
*SystemApi* | [**ListServices**](docs/SystemApi.md#listservices) | **Get** /system/services | List system services
*VulnerabilitiesApi* | [**GetImageVulnerabilitiesByType**](docs/VulnerabilitiesApi.md#getimagevulnerabilitiesbytype) | **Get** /images/{imageDigest}/vuln/{vtype} | Get vulnerabilities by type
*VulnerabilitiesApi* | [**GetImageVulnerabilitiesByTypeImageId**](docs/VulnerabilitiesApi.md#getimagevulnerabilitiesbytypeimageid) | **Get** /images/by_id/{imageId}/vuln/{vtype} | Get vulnerabilities by type
*VulnerabilitiesApi* | [**GetImageVulnerabilityTypes**](docs/VulnerabilitiesApi.md#getimagevulnerabilitytypes) | **Get** /images/{imageDigest}/vuln | Get vulnerability types
*VulnerabilitiesApi* | [**GetImageVulnerabilityTypesByImageId**](docs/VulnerabilitiesApi.md#getimagevulnerabilitytypesbyimageid) | **Get** /images/by_id/{imageId}/vuln | Get vulnerability types
## Documentation For Models
- [AnchoreImage](docs/AnchoreImage.md)
- [AnchoreImageList](docs/AnchoreImageList.md)
- [AnchoreImageTagSummary](docs/AnchoreImageTagSummary.md)
- [ApiErrorResponse](docs/ApiErrorResponse.md)
- [ContentResponse](docs/ContentResponse.md)
- [FeedGroupMetadata](docs/FeedGroupMetadata.md)
- [FeedMetadata](docs/FeedMetadata.md)
- [GateSpec](docs/GateSpec.md)
- [ImageAnalysisReport](docs/ImageAnalysisReport.md)
- [ImageAnalysisRequest](docs/ImageAnalysisRequest.md)
- [ImageContent](docs/ImageContent.md)
- [ImageDetail](docs/ImageDetail.md)
- [ImageFilter](docs/ImageFilter.md)
- [ImageRef](docs/ImageRef.md)
- [ImageSelectionRule](docs/ImageSelectionRule.md)
- [MappingRule](docs/MappingRule.md)
- [Policy](docs/Policy.md)
- [PolicyBundle](docs/PolicyBundle.md)
- [PolicyBundleList](docs/PolicyBundleList.md)
- [PolicyBundleRecord](docs/PolicyBundleRecord.md)
- [PolicyEvaluation](docs/PolicyEvaluation.md)
- [PolicyRule](docs/PolicyRule.md)
- [PolicyRuleParams](docs/PolicyRuleParams.md)
- [PruneCandidate](docs/PruneCandidate.md)
- [PruneCandidateList](docs/PruneCandidateList.md)
- [RegistryConfiguration](docs/RegistryConfiguration.md)
- [RegistryConfigurationList](docs/RegistryConfigurationList.md)
- [RepositoryTagList](docs/RepositoryTagList.md)
- [Service](docs/Service.md)
- [ServiceList](docs/ServiceList.md)
- [StatusResponse](docs/StatusResponse.md)
- [Subscription](docs/Subscription.md)
- [SubscriptionList](docs/SubscriptionList.md)
- [SubscriptionRequest](docs/SubscriptionRequest.md)
- [SubscriptionUpdate](docs/SubscriptionUpdate.md)
- [SystemStatusResponse](docs/SystemStatusResponse.md)
- [TriggerParamSpec](docs/TriggerParamSpec.md)
- [TriggerSpec](docs/TriggerSpec.md)
- [Vulnerability](docs/Vulnerability.md)
- [VulnerabilityList](docs/VulnerabilityList.md)
- [Whitelist](docs/Whitelist.md)
- [WhitelistItem](docs/WhitelistItem.md)
## Documentation For Authorization
## basicAuth
- **Type**: HTTP basic authentication
Example
```
auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
UserName: "username",
Password: "password",
})
r, err := client.Service.Operation(auth, args)
```
## Author
nurmi@anchore.com