Anchore Engine API
Simulate the Anchore Engine API in seconds. This is the Anchore Engine API.
[01]
About
Mock the Anchore Engine API as a turnkey Mockzilla sim with 112 OpenAPI endpoints, realistic JSON payloads, no upstream signup or sandbox keys. This is the Anchore Engine API. Methods: 68x GET, 21x POST, 17x DELETE, 6x PUT. Top resource groups: Images, System, Imports, User Management. Hit https://api.justmocks.com/anchore for the Mockzilla API Explorer landing and per-endpoint sample requests.
Endpoints
112 across 14 resource groups
Methods
GET 68 · POST 21 · PUT 6 · DEL 17 none deprecated
OpenAPI
3.0.0 spec version 0.1.20
Source spec
177 KB · YAML
view raw →
[02]
Endpoints
| GET |
/
|
Simple status check. Mocked via Mockzilla.
|
| GET |
/account
|
List the account for the authenticated user
|
| GET |
/accounts
|
List user summaries. Only available to the system admin user.
|
| POST |
/accounts
|
Create a new user. Only avaialble to admin user.
|
| DEL |
/accounts/{accountname}
|
Delete 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
|
| GET |
/accounts/{accountname}
|
Get info about an user. Only available to admin user. Uses the main user Id, not a username.
|
| PUT |
/accounts/{accountname}/state
|
Update the state of an account to either enabled or disabled. For deletion use the DELETE route
|
| GET |
/accounts/{accountname}/users
|
List accounts for the user
|
| POST |
/accounts/{accountname}/users
|
Create a new user
|
| DEL |
/accounts/{accountname}/users/{username}
|
Delete a specific user credential by username of the credential. Cannot be the credential used to authenticate the request.
|
| GET |
/accounts/{accountname}/users/{username}
|
Get a specific user in the specified account
|
| DEL |
/accounts/{accountname}/users/{username}/credentials
|
Delete a credential by type
|
| GET |
/accounts/{accountname}/users/{username}/credentials
|
Get current credential summary
|
| POST |
/accounts/{accountname}/users/{username}/credentials
|
add/replace credential
|
| GET |
/archives
|
|
| GET |
/archives/images
|
|
| POST |
/archives/images
|
|
| DEL |
/archives/images/{imageDigest}
|
Performs a synchronous archive deletion
|
| GET |
/archives/images/{imageDigest}
|
Returns the archive metadata record identifying the image and tags for the analysis in the archive.
|
| GET |
/archives/rules
|
|
| POST |
/archives/rules
|
|
| DEL |
/archives/rules/{ruleId}
|
|
| GET |
/archives/rules/{ruleId}
|
|
| GET |
/event_types
|
List Event Types Returns list of event types in the category hierarchy
|
| DEL |
/events
|
Delete Events Delete all or a subset of events filtered using the optional query parameters
|
| GET |
/events
|
List Events Returns a paginated list of events in the descending order of their occurrence. Optional query parameters may be used for filtering results. Available as a Mockzilla mock endpoint.
|
| DEL |
/events/{eventId}
|
Delete Event Delete an event by its event ID
|
| GET |
/events/{eventId}
|
Get Event Lookup an event by its event ID
|
| GET |
/health
|
Health check, returns 200 and no body if service is running
|
| DEL |
/images
|
Bulk mark images for deletion Delete analysis for image digests in the list asynchronously
|
| GET |
/images
|
List all visible images List all images visible to the user. Mockzilla mock: no signup, no API key.
|
| POST |
/images
|
Submit a new image for analysis by the engine Creates a new analysis task that is executed asynchronously
|
| DEL |
/images/by_id/{imageId}
|
Delete image by docker imageId
|
| GET |
/images/by_id/{imageId}
|
Lookup image by docker imageId
|
| GET |
/images/by_id/{imageId}/check
|
Check policy evaluation status for image Get the policy evaluation for the given image
|
| GET |
/images/by_id/{imageId}/content
|
List image content types
|
| GET |
/images/by_id/{imageId}/content/files
|
Get the content of an image by type files
|
| GET |
/images/by_id/{imageId}/content/java
|
Get the content of an image by type java
|
| GET |
/images/by_id/{imageId}/content/{ctype}
|
Get the content of an image by type
|
| GET |
/images/by_id/{imageId}/vuln
|
Get vulnerability types
|
| GET |
/images/by_id/{imageId}/vuln/{vtype}
|
Get vulnerabilities by type
|
| DEL |
/images/{imageDigest}
|
Delete an image analysis
|
| GET |
/images/{imageDigest}
|
Get image metadata
|
| GET |
/images/{imageDigest}/artifacts/file_content_search
|
Return a list of analyzer artifacts of the specified type
|
| GET |
/images/{imageDigest}/artifacts/retrieved_files
|
Return a list of analyzer artifacts of the specified type
|
| GET |
/images/{imageDigest}/artifacts/secret_search
|
Return a list of analyzer artifacts of the specified type
|
| GET |
/images/{imageDigest}/check
|
Check policy evaluation status for image Get the policy evaluation for the given image
|
| GET |
/images/{imageDigest}/content
|
List image content types
|
| GET |
/images/{imageDigest}/content/files
|
Get the content of an image by type files
|
| GET |
/images/{imageDigest}/content/java
|
Get the content of an image by type java
|
| GET |
/images/{imageDigest}/content/malware
|
Get the content of an image by type malware
|
| GET |
/images/{imageDigest}/content/{ctype}
|
Get the content of an image by type
|
| GET |
/images/{imageDigest}/metadata
|
List image metadata types
|
| GET |
/images/{imageDigest}/metadata/{mtype}
|
Get the metadata of an image by type
|
| GET |
/images/{imageDigest}/sboms/native
|
Get image sbom in the native Anchore format
|
| GET |
/images/{imageDigest}/vuln
|
Get vulnerability types
|
| GET |
/images/{imageDigest}/vuln/{vtype}
|
Get vulnerabilities by type
|
| POST |
/import/images
|
Import an anchore image tar.gz archive file. This is a deprecated API replaced by the "/imports/images" route
|
| GET |
/imports/images
|
Lists in-progress imports
|
| POST |
/imports/images
|
Begin the import of an image analyzed by Syft into the system
|
| DEL |
/imports/images/{operation_id}
|
Invalidate operation ID so it can be garbage collected
|
| GET |
/imports/images/{operation_id}
|
Get detail on a single import
|
| GET |
/imports/images/{operation_id}/dockerfile
|
List uploaded dockerfiles
|
| POST |
/imports/images/{operation_id}/dockerfile
|
Begin the import of an image analyzed by Syft into the system
|
| GET |
/imports/images/{operation_id}/image_config
|
List uploaded image configs
|
| POST |
/imports/images/{operation_id}/image_config
|
Import a docker or OCI image config to associate with the image
|
| GET |
/imports/images/{operation_id}/manifest
|
List uploaded image manifests
|
| POST |
/imports/images/{operation_id}/manifest
|
Import a docker or OCI distribution manifest to associate with the image
|
| GET |
/imports/images/{operation_id}/packages
|
List uploaded package manifests
|
| POST |
/imports/images/{operation_id}/packages
|
Begin the import of an image analyzed by Syft into the system
|
| GET |
/imports/images/{operation_id}/parent_manifest
|
List uploaded parent manifests (manifest lists for a tag)
|
| POST |
/imports/images/{operation_id}/parent_manifest
|
Import a docker or OCI distribution manifest list to associate with the image
|
| POST |
/oauth/token
|
Request a jwt token for subsequent operations, this request is authenticated with normal HTTP auth
|
| GET |
/policies
|
List policies List all saved policy bundles. Served by the Mockzilla mock runtime.
|
| POST |
/policies
|
Add a new policy Adds a new policy bundle to the system
|
| DEL |
/policies/{policyId}
|
Delete policy Delete the specified policy
|
| GET |
/policies/{policyId}
|
Get specific policy Get the policy bundle content
|
| PUT |
/policies/{policyId}
|
Update policy Update/replace and existing policy
|
| GET |
/query/images/by_package
|
List of images containing given package Filterable query interface to search for images containing specified package. Mocked via Mockzilla.
|
| GET |
/query/images/by_vulnerability
|
List images vulnerable to the specific vulnerability ID. Returns a listing of images and their respective packages vulnerable to the given vulnerability ID
|
| GET |
/query/vulnerabilities
|
Listing information about given vulnerability List (w/filters) vulnerability records known by the system, with affected packages information if present
|
| GET |
/registries
|
List configured registries List all configured registries the system can/will watch
|
| POST |
/registries
|
Add a new registry Adds a new registry to the system
|
| DEL |
/registries/{registry}
|
Delete a registry configuration Delete a registry configuration record from the system. Does not remove any images. Available as a Mockzilla mock endpoint.
|
| GET |
/registries/{registry}
|
Get a specific registry configuration Get information on a specific registry
|
| PUT |
/registries/{registry}
|
Update/replace a registry configuration Replaces an existing registry record with the given record
|
| POST |
/repositories
|
Add repository to watch
|
| GET |
/status
|
Service status Get the API service status
|
| GET |
/subscriptions
|
List all subscriptions
|
| POST |
/subscriptions
|
Add a subscription of a specific type Create a new subscription to watch a tag and get notifications of changes
|
| DEL |
/subscriptions/{subscriptionId}
|
Delete subscriptions of a specific type
|
| GET |
/subscriptions/{subscriptionId}
|
Get a specific subscription set
|
| PUT |
/subscriptions/{subscriptionId}
|
Update an existing and specific subscription
|
| GET |
/summaries/imagetags
|
List all visible image digests and tags List all image tags visible to the user. Mockzilla mock: no signup, no API key.
|
| GET |
/system
|
System status Get the system status including queue lengths
|
| GET |
/system/error_codes
|
Describe anchore engine error codes. Describe anchore engine error codes.
|
| GET |
/system/feeds
|
list feeds operations and information Return 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 feed service itself.
|
| POST |
/system/feeds
|
trigger feeds operations Execute a synchronous feed sync operation. The response will block until complete, then return the result summary.
|
| DEL |
/system/feeds/{feed}
|
Delete the groups and data for the feed and disable the feed itself. Served by the Mockzilla mock runtime.
|
| PUT |
/system/feeds/{feed}
|
Disable the feed so that it does not sync on subsequent sync operations
|
| DEL |
/system/feeds/{feed}/{group}
|
Delete the group data and disable the group itself
|
| PUT |
/system/feeds/{feed}/{group}
|
Disable a specific group within a feed to not sync
|
| GET |
/system/policy_spec
|
Describe the policy language spec implemented by this service. Get the policy language spec for this service
|
| GET |
/system/services
|
List system services
|
| GET |
/system/services/{servicename}
|
Get a service configuration and state
|
| DEL |
/system/services/{servicename}/{hostid}
|
Delete the service config
|
| GET |
/system/services/{servicename}/{hostid}
|
Get service config for a specific host
|
| POST |
/system/webhooks/{webhook_type}/test
|
Adds the capabilities to test a webhook delivery for the given notification type Loads the Webhook configuration for webhook_type, and sends the notification out as a test. Mocked via Mockzilla.
|
| GET |
/user
|
List authenticated user info
|
| GET |
/user/credentials
|
Get current credential summary
|
| POST |
/user/credentials
|
add/replace credential
|
| GET |
/version
|
Returns the version object for the service, including db schema version info
|