Anchore Engine API Server

Tools (114)

Extracted live via the executor SDK.

• archives.archiveImageAnalysis

  POST /archives/images

• archives.createAnalysisArchiveRule

  POST /archives/rules

• archives.deleteAnalysisArchiveRule

  DELETE /archives/rules/{ruleId}

• archives.deleteArchivedAnalysis

  Performs a synchronous archive deletion

• archives.getAnalysisArchiveRule

  GET /archives/rules/{ruleId}

• archives.getArchivedAnalysis

  Returns the archive metadata record identifying the image and tags for the analysis in the archive.

• archives.listAnalysisArchive

  GET /archives/images

• archives.listAnalysisArchiveRules

  GET /archives/rules

• archives.listArchives

  GET /archives

• events.deleteEvent

  Delete an event by its event ID

• events.deleteEvents

  Delete all or a subset of events filtered using the optional query parameters

• events.getEvent

  Lookup an event by its event ID

• events.listEvents

  Returns a paginated list of events in the descending order of their occurrence. Optional query parameters may be used for filtering results

• events.listEventTypes

  Returns list of event types in the category hierarchy

• health.healthCheck

  Health check, returns 200 and no body if service is running

• identity.addCredential

  add/replace credential

• identity.getCredentials

  Get current credential summary

• identity.getUser

  List authenticated user info

• identity.getUsersAccount

  List the account for the authenticated user

• images.addImage

  Creates a new analysis task that is executed asynchronously

• images.deleteImage

  Delete an image analysis

• images.deleteImageByImageId

  Delete image by docker imageId

• images.deleteImagesAsync

  Delete analysis for image digests in the list asynchronously

• images.getImage

  Get image metadata

• images.getImageByImageId

  Lookup image by docker imageId

• images.getImageContentByType

  Get the content of an image by type

• images.getImageContentByTypeFiles

  Get the content of an image by type files

• images.getImageContentByTypeImageId

  Get the content of an image by type

• images.getImageContentByTypeImageIdFiles

  Get the content of an image by type files

• images.getImageContentByTypeImageIdJavapackage

  Get the content of an image by type java

• images.getImageContentByTypeJavapackage

  Get the content of an image by type java

• images.getImageContentByTypeMalware

  Get the content of an image by type malware

• images.getImageMetadataByType

  Get the metadata of an image by type

• images.getImagePolicyCheck

  Get the policy evaluation for the given image

• images.getImagePolicyCheckByImageId

  Get the policy evaluation for the given image

• images.getImageSbomNative

  Get image sbom in the native Anchore format

• images.getImageVulnerabilitiesByType

  Get vulnerabilities by type

• images.getImageVulnerabilitiesByTypeImageId

  Get vulnerabilities by type

• images.getImageVulnerabilityTypes

  Get vulnerability types

• images.getImageVulnerabilityTypesByImageId

  Get vulnerability types

• images.listFileContentSearchResults

  Return a list of analyzer artifacts of the specified type

• images.listImageContent

  List image content types

• images.listImageContentByImageid

  List image content types

• images.listImageMetadata

  List image metadata types

• images.listImages

  List all images visible to the user

• images.listRetrievedFiles

  Return a list of analyzer artifacts of the specified type

• images.listSecretSearchResults

  Return a list of analyzer artifacts of the specified type

• import.importImageArchive

  Import an anchore image tar.gz archive file. This is a deprecated API replaced by the "/imports/images" route

• imports.createOperation

  Begin the import of an image analyzed by Syft into the system

• imports.getOperation

  Get detail on a single import

• imports.importImageConfig

  Import a docker or OCI image config to associate with the image

• imports.importImageDockerfile

  Begin the import of an image analyzed by Syft into the system

• imports.importImageManifest

  Import a docker or OCI distribution manifest to associate with the image

• imports.importImagePackages

  Begin the import of an image analyzed by Syft into the system

• imports.importImageParentManifest

  Import a docker or OCI distribution manifest list to associate with the image

• imports.invalidateOperation

  Invalidate operation ID so it can be garbage collected

• imports.listImportDockerfiles

  List uploaded dockerfiles

• imports.listImportImageConfigs

  List uploaded image configs

• imports.listImportImageManifests

  List uploaded image manifests

• imports.listImportPackages

  List uploaded package manifests

• imports.listImportParentManifests

  List uploaded parent manifests (manifest lists for a tag)

• imports.listOperations

  Lists in-progress imports

• oauth.getOauthToken

  Request a jwt token for subsequent operations, this request is authenticated with normal HTTP auth

• policies.addPolicy

  Adds a new policy bundle to the system

• policies.deletePolicy

  Delete the specified policy

• policies.getPolicy

  Get the policy bundle content

• policies.listPolicies

  List all saved policy bundles

• policies.updatePolicy

  Update/replace and existing policy

• query.queryImagesByPackage

  Filterable query interface to search for images containing specified package

• query.queryImagesByVulnerability

  Returns a listing of images and their respective packages vulnerable to the given vulnerability ID

• query.queryVulnerabilities

  List (w/filters) vulnerability records known by the system, with affected packages information if present

• registries.createRegistry

  Adds a new registry to the system

• registries.deleteRegistry

  Delete a registry configuration record from the system. Does not remove any images.

• registries.getRegistry

  Get information on a specific registry

• registries.listRegistries

  List all configured registries the system can/will watch

• registries.updateRegistry

  Replaces an existing registry record with the given record

• repositoryCredentials.addRepository
• root.ping

  Simple status check

• subscriptions.addSubscription

  Create a new subscription to watch a tag and get notifications of changes

• subscriptions.deleteSubscription

  Delete subscriptions of a specific type

• subscriptions.getSubscription

  Get a specific subscription set

• subscriptions.listSubscriptions

  List all subscriptions

• subscriptions.updateSubscription

  Update an existing and specific subscription

• summaries.listImagetags

  List all image tags visible to the user

• system.deleteFeed

  Delete the groups and data for the feed and disable the feed itself

• system.deleteFeedGroup

  Delete the group data and disable the group itself

• system.deleteService

  Delete the service config

• system.describeErrorCodes

  Describe anchore engine error codes.

• system.describePolicy

  Get the policy language spec for this service

• system.getServiceDetail

  Get the system status including queue lengths

• system.getServicesByName

  Get a service configuration and state

• system.getServicesByNameAndHost

  Get service config for a specific host

• system.getStatus

  Get the API service status

• system.getSystemFeeds

  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.

• system.listServices

  List system services

• system.postSystemFeeds

  Execute a synchronous feed sync operation. The response will block until complete, then return the result summary.

• system.testWebhook

  Loads the Webhook configuration for webhook_type, and sends the notification out as a test

• system.toggleFeedEnabled

  Disable the feed so that it does not sync on subsequent sync operations

• system.toggleGroupEnabled

  Disable a specific group within a feed to not sync

• userManagement.createAccount

  Create a new user. Only avaialble to admin user.

• userManagement.createUser

  Create a new user

• userManagement.createUserCredential

  add/replace credential

• userManagement.deleteAccount

  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

• userManagement.deleteUser

  Delete a specific user credential by username of the credential. Cannot be the credential used to authenticate the request.

• userManagement.deleteUserCredential

  Delete a credential by type

• userManagement.getAccount

  Get info about an user. Only available to admin user. Uses the main user Id, not a username.

• userManagement.getAccountUser

  Get a specific user in the specified account

• userManagement.listAccounts

  List user summaries. Only available to the system admin user.

• userManagement.listUserCredentials

  Get current credential summary

• userManagement.listUsers

  List accounts for the user

• userManagement.updateAccountState

  Update the state of an account to either enabled or disabled. For deletion use the DELETE route

• version.versionCheck

  Returns the version object for the service, including db schema version info

• openapi.previewSpec

  Preview an OpenAPI document before adding it as a source

• openapi.addSource

  Add an OpenAPI source and register its operations as tools