just/mocks_
mockzilla.org →
Catalog /data /Anchore Engine API

Anchore Engine API

PROVIDER · Anchore SPEC v0.1.20 · OpenAPI 3.0.0 MOCK · LIVE
▸ TRY IT
https://api.justmocks.com/anchore
Open mock →

Simulate the Anchore Engine API in seconds. This is the Anchore Engine API.

[01]

About

overview

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

112 operations · 14 resource groups
GET /
Simple status check. Mocked via Mockzilla.
GET /account
Identity
List the account for the authenticated user
GET /accounts
User Management
List user summaries. Only available to the system admin user.
POST /accounts
User Management
Create a new user. Only avaialble to admin user.
DEL /accounts/{accountname}
User Management
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}
User Management
Get info about an user. Only available to admin user. Uses the main user Id, not a username.
PUT /accounts/{accountname}/state
User Management
Update the state of an account to either enabled or disabled. For deletion use the DELETE route
GET /accounts/{accountname}/users
User Management
List accounts for the user
POST /accounts/{accountname}/users
User Management
Create a new user
DEL /accounts/{accountname}/users/{username}
User Management
Delete a specific user credential by username of the credential. Cannot be the credential used to authenticate the request.
GET /accounts/{accountname}/users/{username}
User Management
Get a specific user in the specified account
DEL /accounts/{accountname}/users/{username}/credentials
User Management
Delete a credential by type
GET /accounts/{accountname}/users/{username}/credentials
User Management
Get current credential summary
POST /accounts/{accountname}/users/{username}/credentials
User Management
add/replace credential
GET /archives
Archives
GET /archives/images
Archives
POST /archives/images
Archives
DEL /archives/images/{imageDigest}
Archives
Performs a synchronous archive deletion
GET /archives/images/{imageDigest}
Archives
Returns the archive metadata record identifying the image and tags for the analysis in the archive.
GET /archives/rules
Archives
POST /archives/rules
Archives
DEL /archives/rules/{ruleId}
Archives
GET /archives/rules/{ruleId}
Archives
GET /event_types
Events
List Event Types
Returns list of event types in the category hierarchy
DEL /events
Events
Delete Events
Delete all or a subset of events filtered using the optional query parameters
GET /events
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}
Events
Delete Event
Delete an event by its event ID
GET /events/{eventId}
Events
Get Event
Lookup an event by its event ID
GET /health
Health check, returns 200 and no body if service is running
DEL /images
Images
Bulk mark images for deletion
Delete analysis for image digests in the list asynchronously
GET /images
Images
List all visible images
List all images visible to the user. Mockzilla mock: no signup, no API key.
POST /images
Images
Submit a new image for analysis by the engine
Creates a new analysis task that is executed asynchronously
DEL /images/by_id/{imageId}
Images
Delete image by docker imageId
GET /images/by_id/{imageId}
Images
Lookup image by docker imageId
GET /images/by_id/{imageId}/check
Images
Check policy evaluation status for image
Get the policy evaluation for the given image
GET /images/by_id/{imageId}/content
Images
List image content types
GET /images/by_id/{imageId}/content/files
Images
Get the content of an image by type files
GET /images/by_id/{imageId}/content/java
Images
Get the content of an image by type java
GET /images/by_id/{imageId}/content/{ctype}
Images
Get the content of an image by type
GET /images/by_id/{imageId}/vuln
Images
Get vulnerability types
GET /images/by_id/{imageId}/vuln/{vtype}
Images
Get vulnerabilities by type
DEL /images/{imageDigest}
Images
Delete an image analysis
GET /images/{imageDigest}
Images
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
Images
Check policy evaluation status for image
Get the policy evaluation for the given image
GET /images/{imageDigest}/content
Images
List image content types
GET /images/{imageDigest}/content/files
Images
Get the content of an image by type files
GET /images/{imageDigest}/content/java
Images
Get the content of an image by type java
GET /images/{imageDigest}/content/malware
Images
Get the content of an image by type malware
GET /images/{imageDigest}/content/{ctype}
Images
Get the content of an image by type
GET /images/{imageDigest}/metadata
Images
List image metadata types
GET /images/{imageDigest}/metadata/{mtype}
Images
Get the metadata of an image by type
GET /images/{imageDigest}/sboms/native
Images
Get image sbom in the native Anchore format
GET /images/{imageDigest}/vuln
Images
Get vulnerability types
GET /images/{imageDigest}/vuln/{vtype}
Images
Get vulnerabilities by type
POST /import/images
Import
Import an anchore image tar.gz archive file. This is a deprecated API replaced by the "/imports/images" route
GET /imports/images
Imports
Lists in-progress imports
POST /imports/images
Imports
Begin the import of an image analyzed by Syft into the system
DEL /imports/images/{operation_id}
Imports
Invalidate operation ID so it can be garbage collected
GET /imports/images/{operation_id}
Imports
Get detail on a single import
GET /imports/images/{operation_id}/dockerfile
Imports
List uploaded dockerfiles
POST /imports/images/{operation_id}/dockerfile
Imports
Begin the import of an image analyzed by Syft into the system
GET /imports/images/{operation_id}/image_config
Imports
List uploaded image configs
POST /imports/images/{operation_id}/image_config
Imports
Import a docker or OCI image config to associate with the image
GET /imports/images/{operation_id}/manifest
Imports
List uploaded image manifests
POST /imports/images/{operation_id}/manifest
Imports
Import a docker or OCI distribution manifest to associate with the image
GET /imports/images/{operation_id}/packages
Imports
List uploaded package manifests
POST /imports/images/{operation_id}/packages
Imports
Begin the import of an image analyzed by Syft into the system
GET /imports/images/{operation_id}/parent_manifest
Imports
List uploaded parent manifests (manifest lists for a tag)
POST /imports/images/{operation_id}/parent_manifest
Imports
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
Policies
List policies
List all saved policy bundles. Served by the Mockzilla mock runtime.
POST /policies
Policies
Add a new policy
Adds a new policy bundle to the system
DEL /policies/{policyId}
Policies
Delete policy
Delete the specified policy
GET /policies/{policyId}
Policies
Get specific policy
Get the policy bundle content
PUT /policies/{policyId}
Policies
Update policy
Update/replace and existing policy
GET /query/images/by_package
Query
List of images containing given package
Filterable query interface to search for images containing specified package. Mocked via Mockzilla.
GET /query/images/by_vulnerability
Query
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
Query
Listing information about given vulnerability
List (w/filters) vulnerability records known by the system, with affected packages information if present
GET /registries
Registries
List configured registries
List all configured registries the system can/will watch
POST /registries
Registries
Add a new registry
Adds a new registry to the system
DEL /registries/{registry}
Registries
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}
Registries
Get a specific registry configuration
Get information on a specific registry
PUT /registries/{registry}
Registries
Update/replace a registry configuration
Replaces an existing registry record with the given record
POST /repositories
Repository Credentials
Add repository to watch
GET /status
System
Service status
Get the API service status
GET /subscriptions
Subscriptions
List all subscriptions
POST /subscriptions
Subscriptions
Add a subscription of a specific type
Create a new subscription to watch a tag and get notifications of changes
DEL /subscriptions/{subscriptionId}
Subscriptions
Delete subscriptions of a specific type
GET /subscriptions/{subscriptionId}
Subscriptions
Get a specific subscription set
PUT /subscriptions/{subscriptionId}
Subscriptions
Update an existing and specific subscription
GET /summaries/imagetags
Summaries
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
System status
Get the system status including queue lengths
GET /system/error_codes
System
Describe anchore engine error codes.
Describe anchore engine error codes.
GET /system/feeds
System
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
System
trigger feeds operations
Execute a synchronous feed sync operation. The response will block until complete, then return the result summary.
DEL /system/feeds/{feed}
System
Delete the groups and data for the feed and disable the feed itself. Served by the Mockzilla mock runtime.
PUT /system/feeds/{feed}
System
Disable the feed so that it does not sync on subsequent sync operations
DEL /system/feeds/{feed}/{group}
System
Delete the group data and disable the group itself
PUT /system/feeds/{feed}/{group}
System
Disable a specific group within a feed to not sync
GET /system/policy_spec
System
Describe the policy language spec implemented by this service.
Get the policy language spec for this service
GET /system/services
System
List system services
GET /system/services/{servicename}
System
Get a service configuration and state
DEL /system/services/{servicename}/{hostid}
System
Delete the service config
GET /system/services/{servicename}/{hostid}
System
Get service config for a specific host
POST /system/webhooks/{webhook_type}/test
System
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
Identity
List authenticated user info
GET /user/credentials
Identity
Get current credential summary
POST /user/credentials
Identity
add/replace credential
GET /version
Returns the version object for the service, including db schema version info