Anchore Engine API Server
This is the Anchore Engine API. Provides the primary external API for users of the service.
Developer tools#openapi#developer-tools
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
This is the Anchore Engine API. Provides the primary external API for users of the service.
Endpoints 112
Subscriptions
- GETList all subscriptions
/subscriptions?subscription_key=string&subscription_type=string - POSTAdd a subscription of a specific type
/subscriptionsCreate a new subscription to watch a tag and get notifications of changes - GETGet a specific subscription set
/subscriptions/:subscriptionId - PUTUpdate an existing and specific subscription
/subscriptions/:subscriptionId - DELETEDelete subscriptions of a specific type
/subscriptions/:subscriptionId
Policies
- GETList policies
/policies?detail=trueList all saved policy bundles - POSTAdd a new policy
/policiesAdds a new policy bundle to the system - GETGet specific policy
/policies/:policyId?detail=trueGet the policy bundle content - PUTUpdate policy
/policies/:policyId?active=trueUpdate/replace and existing policy - DELETEDelete policy
/policies/:policyIdDelete the specified policy
Images
- GETList all visible images
/images?history=true&fulltag=string&image_status=active&analysis_status=not_analyzedList all images visible to the user - POSTSubmit a new image for analysis by the engine
/images?force=true&autosubscribe=trueCreates a new analysis task that is executed asynchronously - DELETEBulk mark images for deletion
/images?imageDigests=string&force=trueDelete analysis for image digests in the list asynchronously - GETLookup image by docker imageId
/images/by_id/:imageId - DELETEDelete image by docker imageId
/images/by_id/:imageId?force=true - GETCheck policy evaluation status for image
/images/by_id/:imageId/check?policyId=string&tag=string&detail=true&history=trueGet the policy evaluation for the given image - GETList image content types
/images/by_id/:imageId/content - GETGet the content of an image by type files
/images/by_id/:imageId/content/files - GETGet the content of an image by type java
/images/by_id/:imageId/content/java - GETGet the content of an image by type
/images/by_id/:imageId/content/:ctype - GETGet vulnerability types
/images/by_id/:imageId/vuln - GETGet vulnerabilities by type
/images/by_id/:imageId/vuln/:vtype - GETGet image metadata
/images/:imageDigest - DELETEDelete an image analysis
/images/:imageDigest?force=true - GETCheck policy evaluation status for image
/images/:imageDigest/check?policyId=string&tag=string&detail=true&history=true&interactive=trueGet the policy evaluation for the given image - GETList image content types
/images/:imageDigest/content - GETGet the content of an image by type files
/images/:imageDigest/content/files - GETGet the content of an image by type java
/images/:imageDigest/content/java - GETGet the content of an image by type malware
/images/:imageDigest/content/malware - GETGet the content of an image by type
/images/:imageDigest/content/:ctype - GETList image metadata types
/images/:imageDigest/metadata - GETGet the metadata of an image by type
/images/:imageDigest/metadata/:mtype - GETGet image sbom in the native Anchore format
/images/:imageDigest/sboms/native - GETGet vulnerability types
/images/:imageDigest/vuln - GETGet vulnerabilities by type
/images/:imageDigest/vuln/:vtype?force_refresh=true&vendor_only=true
Registries
- GETList configured registries
/registriesList all configured registries the system can/will watch - POSTAdd a new registry
/registries?validate=trueAdds a new registry to the system - GETGet a specific registry configuration
/registries/:registryGet information on a specific registry - PUTUpdate/replace a registry configuration
/registries/:registry?validate=trueReplaces an existing registry record with the given record - DELETEDelete a registry configuration
/registries/:registryDelete a registry configuration record from the system. Does not remove any images.
Repository Credentials
- POSTAdd repository to watch
/repositories?repository=string&autosubscribe=true&dryrun=true
System
- GETService status
/statusGet the API service status - GETSystem status
/systemGet the system status including queue lengths - GETDescribe anchore engine error codes.
/system/error_codesDescribe anchore engine error codes. - GETlist feeds operations and information
/system/feedsReturn a list of feed and their groups along with update and record count information. This data reflects the state of the policy engine, not the upstream… - POSTtrigger feeds operations
/system/feeds?flush=true&sync=trueExecute a synchronous feed sync operation. The response will block until complete, then return the result summary. - PUTtoggle_feed_enabled
/system/feeds/:feed?enabled=trueDisable the feed so that it does not sync on subsequent sync operations - DELETEdelete_feed
/system/feeds/:feedDelete the groups and data for the feed and disable the feed itself - PUTtoggle_group_enabled
/system/feeds/:feed/:group?enabled=trueDisable a specific group within a feed to not sync - DELETEdelete_feed_group
/system/feeds/:feed/:groupDelete the group data and disable the group itself - GETDescribe the policy language spec implemented by this service.
/system/policy_specGet the policy language spec for this service - GETList system services
/system/services - GETGet a service configuration and state
/system/services/:servicename - GETGet service config for a specific host
/system/services/:servicename/:hostid - DELETEDelete the service config
/system/services/:servicename/:hostid - POSTAdds the capabilities to test a webhook delivery for the given notification type
/system/webhooks/:webhook_type/test?notification_type=tag_updateLoads the Webhook configuration for webhook_type, and sends the notification out as a test
Summaries
- GETList all visible image digests and tags
/summaries/imagetags?image_status=activeList all image tags visible to the user
Events
- GETList Event Types
/event_typesReturns list of event types in the category hierarchy - GETList Events
/events?source_servicename=string&source_hostid=string&event_type=string&resource_type=string&resource_id=string&level=string&since=string&before=string&page=1&limit=100Returns a paginated list of events in the descending order of their occurrence. Optional query parameters may be used for filtering results - DELETEDelete Events
/events?before=string&since=string&level=stringDelete all or a subset of events filtered using the optional query parameters - GETGet Event
/events/:eventIdLookup an event by its event ID - DELETEDelete Event
/events/:eventIdDelete an event by its event ID
User Management
- GETList user summaries. Only available to the system admin user.
/accounts?state=enabled - POSTCreate a new user. Only avaialble to admin user.
/accounts - GETGet info about an user. Only available to admin user. Uses the main user Id, not a username.
/accounts/:accountname - DELETEDelete the specified account, only allowed if the account is in the disabled state. All users will be deleted along with the account and all resources will be garbage collected
/accounts/:accountname - PUTUpdate the state of an account to either enabled or disabled. For deletion use the DELETE route
/accounts/:accountname/state - GETList accounts for the user
/accounts/:accountname/users - POSTCreate a new user
/accounts/:accountname/users - GETGet a specific user in the specified account
/accounts/:accountname/users/:username - DELETEDelete a specific user credential by username of the credential. Cannot be the credential used to authenticate the request.
/accounts/:accountname/users/:username - GETGet current credential summary
/accounts/:accountname/users/:username/credentials - POSTadd/replace credential
/accounts/:accountname/users/:username/credentials - DELETEDelete a credential by type
/accounts/:accountname/users/:username/credentials?credential_type=password
Identity
- GETList the account for the authenticated user
/account - GETList authenticated user info
/user - GETGet current credential summary
/user/credentials - POSTadd/replace credential
/user/credentials
Archives
- GETlist_archives
/archives - GETlist_analysis_archive
/archives/images - POSTarchive_image_analysis
/archives/images - GETget_archived_analysis
/archives/images/:imageDigestReturns the archive metadata record identifying the image and tags for the analysis in the archive. - DELETEdelete_archived_analysis
/archives/images/:imageDigest?force=truePerforms a synchronous archive deletion - GETlist_analysis_archive_rules
/archives/rules?system_global=true - POSTcreate_analysis_archive_rule
/archives/rules - GETget_analysis_archive_rule
/archives/rules/:ruleId - DELETEdelete_analysis_archive_rule
/archives/rules/:ruleId
Import
- POSTImport an anchore image tar.gz archive file. This is a deprecated API replaced by the "/imports/images" route
/import/images
Imports
- GETLists in-progress imports
/imports/images - POSTBegin the import of an image analyzed by Syft into the system
/imports/images - GETGet detail on a single import
/imports/images/:operation_id - DELETEInvalidate operation ID so it can be garbage collected
/imports/images/:operation_id - GETList uploaded dockerfiles
/imports/images/:operation_id/dockerfile - POSTBegin the import of an image analyzed by Syft into the system
/imports/images/:operation_id/dockerfile - GETList uploaded image configs
/imports/images/:operation_id/image_config - POSTImport a docker or OCI image config to associate with the image
/imports/images/:operation_id/image_config - GETList uploaded image manifests
/imports/images/:operation_id/manifest - POSTImport a docker or OCI distribution manifest to associate with the image
/imports/images/:operation_id/manifest - GETList uploaded package manifests
/imports/images/:operation_id/packages - POSTBegin the import of an image analyzed by Syft into the system
/imports/images/:operation_id/packages - GETList uploaded parent manifests (manifest lists for a tag)
/imports/images/:operation_id/parent_manifest - POSTImport a docker or OCI distribution manifest list to associate with the image
/imports/images/:operation_id/parent_manifest
Query
- GETList of images containing given package
/query/images/by_package?name=string&package_type=string&version=string&page=string&limit=0Filterable query interface to search for images containing specified package - GETList images vulnerable to the specific vulnerability ID.
/query/images/by_vulnerability?vulnerability_id=string&namespace=string&affected_package=string&severity=Unknown&vendor_only=true&page=0&limit=0Returns a listing of images and their respective packages vulnerable to the given vulnerability ID - GETListing information about given vulnerability
/query/vulnerabilities?id=string&affected_package=string&affected_package_version=string&page=1&limit=0&namespace=stringList (w/filters) vulnerability records known by the system, with affected packages information if present
- GETping
/Simple status check - GEThealth_check
/healthHealth check, returns 200 and no body if service is running - GETReturn a list of analyzer artifacts of the specified type
/images/:imageDigest/artifacts/file_content_search - GETReturn a list of analyzer artifacts of the specified type
/images/:imageDigest/artifacts/retrieved_files - GETReturn a list of analyzer artifacts of the specified type
/images/:imageDigest/artifacts/secret_search - POSTget_oauth_token
/oauth/tokenRequest a jwt token for subsequent operations, this request is authenticated with normal HTTP auth - GETversion_check
/versionReturns the version object for the service, including db schema version info
API details
- Base URL
http://anchore.local- Authentication
- None declared in the description
- Operations
- 112 operations on 75 pathsGET 68POST 21DELETE 17PUT 6
- Main resources
- Images 25System 15Imports 14User Management 12Archives 9Events 5Policies 5Registries 5Subscriptions 5Identity 4
- Response formats
application/jsonapplication/gzip- Description format
- OpenAPI 3.0.0, API version
0.1.20 - Links
- OpenAPI document
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the Anchore Engine API Server in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Anchore Engine API Server collection, without the publisher's secrets.
- Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
- Send a requestPick an endpoint, for example “List all subscriptions” (GET /subscriptions?subscription_key=string&subscription_type=string), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Anchore Engine API Server?
This is the Anchore Engine API. Provides the primary external API for users of the service. It is listed under Developer tools and has 112 endpoints.
Who publishes the Anchore Engine API Server?
It is listed from Anchore's public API description (an OpenAPI document), not published by Anchore on Swastik Codes. Anyone who controls anchore.io can claim the profile by adding a DNS TXT record.
What is the base URL of the Anchore Engine API Server?
Requests go to http://anchore.local. Endpoint paths are added to this base URL.
How do I authenticate with the Anchore Engine API Server?
Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.
How many endpoints does the Anchore Engine API Server have?
112 operations on 75 paths (68 GET, 21 POST, 17 DELETE, 6 PUT). The largest groups are Images, System, Imports, User Management.
Is forking the Anchore Engine API Server free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.