This is the Anchore Engine API. Provides the primary external API for users of the service.
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: http://anchore.local
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
This is the Anchore Engine API. Provides the primary external API for users of the service.
| method | path | what the vendor says it does |
|---|---|---|
GET | / | Simple status check |
GET | /account | List the account for the authenticated user Identity |
GET | /accounts | List user summaries. Only available to the system admin user. User Management |
POST | /accounts | Create a new user. Only avaialble to admin user. User Management |
GET | /accounts/{accountname} | Get info about an user. Only available to admin user. Uses the main user Id, not a username. User Management |
DELETE | /accounts/{accountname} | Delete the specified account, only allowed if the account is in the disabled state. All users will be deleted |
PUT | /accounts/{accountname}/state | Update the state of an account to either enabled or disabled. For deletion use the DELETE route User Managemen |
GET | /accounts/{accountname}/users | List accounts for the user User Management |
POST | /accounts/{accountname}/users | Create a new user User Management |
GET | /accounts/{accountname}/users/{username} | Get a specific user in the specified account User Management |
DELETE | /accounts/{accountname}/users/{username} | Delete a specific user credential by username of the credential. Cannot be the credential used to authenticate |
GET | /accounts/{accountname}/users/{username}/credentials | Get current credential summary User Management |
POST | /accounts/{accountname}/users/{username}/credentials | add/replace credential User Management |
DELETE | /accounts/{accountname}/users/{username}/credentials | Delete a credential by type User Management |
GET | /archives/images/{imageDigest} | Returns the archive metadata record identifying the image and tags for the analysis in the archive. Archives |
DELETE | /archives/images/{imageDigest} | Performs a synchronous archive deletion Archives |
GET | /event_types | List Event Types Returns list of event types in the category hierarchy Events |
GET | /events | List Events Returns a paginated list of events in the descending order of their occurrence. Optional query par |
DELETE | /events | Delete Events Delete all or a subset of events filtered using the optional query parameters Events |
GET | /events/{eventId} | Get Event Lookup an event by its event ID Events |
DELETE | /events/{eventId} | Delete Event Delete an event by its event ID Events |
GET | /health | Health check, returns 200 and no body if service is running |
GET | /images | List all visible images List all images visible to the user Images |
POST | /images | Submit a new image for analysis by the engine Creates a new analysis task that is executed asynchronously Imag |
DELETE | /images | Bulk mark images for deletion Delete analysis for image digests in the list asynchronously Images |
GET | /images/by_id/{imageId} | Lookup image by docker imageId Images |
DELETE | /images/by_id/{imageId} | Delete image by docker imageId Images |
GET | /images/by_id/{imageId}/check | Check policy evaluation status for image Get the policy evaluation for the given image Images |
GET | /images/by_id/{imageId}/content | List image content types Images |
GET | /images/by_id/{imageId}/content/files | Get the content of an image by type files Images |
GET | /images/by_id/{imageId}/content/java | Get the content of an image by type java Images |
GET | /images/by_id/{imageId}/content/{ctype} | Get the content of an image by type Images |
GET | /images/by_id/{imageId}/vuln | Get vulnerability types Images |
GET | /images/by_id/{imageId}/vuln/{vtype} | Get vulnerabilities by type Images |
GET | /images/{imageDigest} | Get image metadata Images |
DELETE | /images/{imageDigest} | Delete an image analysis Images |
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 Images |
and 65 more operation(s) in this specification, all searchable.
specification origin: https://raw.githubusercontent.com/anchore/anchore-engine/master/anchore_engine/services/ap
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.