/accounts/{accountname}/state

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

/accounts/{accountname}/users

Create a new user

/accounts/{accountname}/users/{username}

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

/accounts

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

/accounts

Create a new user. Only avaialble to admin user.

/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

/accounts/{accountname}

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

/accounts/{accountname}/users/{username}

Get a specific user in the specified account

/accounts/{accountname}/users/{username}/credentials

Delete a credential by type

/accounts/{accountname}/users/{username}/credentials

Get current credential summary

/accounts/{accountname}/users/{username}/credentials

add/replace credential

/

Simple status check

/account

List the account for the authenticated user

/archives

/archives/images

/archives/images

/archives/images/{imageDigest}

Performs a synchronous archive deletion

/archives/images/{imageDigest}

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

/archives/rules

/archives/rules

/archives/rules/{ruleId}

/archives/rules/{ruleId}

/event_types

List Event Types

/events

Delete Events

/events

List Events

/events/{eventId}

Delete Event

/events/{eventId}

Get Event

/health

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

/images

Bulk mark images for deletion

/images

List all visible images

/images

Submit a new image for analysis by the engine

/images/by_id/{imageId}

Delete image by docker imageId

/images/by_id/{imageId}

Lookup image by docker imageId

/images/by_id/{imageId}/check

Check policy evaluation status for image

/images/by_id/{imageId}/content

List image content types

/images/by_id/{imageId}/content/files

Get the content of an image by type files

/images/by_id/{imageId}/content/java

Get the content of an image by type java

/images/by_id/{imageId}/content/{ctype}

Get the content of an image by type

/images/by_id/{imageId}/vuln

Get vulnerability types

/images/by_id/{imageId}/vuln/{vtype}

Get vulnerabilities by type

/images/{imageDigest}

Delete an image analysis

/images/{imageDigest}

Get image metadata

/images/{imageDigest}/artifacts/file_content_search

Return a list of analyzer artifacts of the specified type

/images/{imageDigest}/artifacts/retrieved_files

Return a list of analyzer artifacts of the specified type

/images/{imageDigest}/artifacts/secret_search

Return a list of analyzer artifacts of the specified type

/images/{imageDigest}/check

Check policy evaluation status for image

/images/{imageDigest}/content

List image content types

/images/{imageDigest}/content/files

Get the content of an image by type files

/images/{imageDigest}/content/java

Get the content of an image by type java

/images/{imageDigest}/content/malware

Get the content of an image by type malware

/images/{imageDigest}/content/{ctype}

Get the content of an image by type

/images/{imageDigest}/metadata

List image metadata types

/images/{imageDigest}/metadata/{mtype}

Get the metadata of an image by type

/images/{imageDigest}/sboms/native

Get image sbom in the native Anchore format

/images/{imageDigest}/vuln

Get vulnerability types

/images/{imageDigest}/vuln/{vtype}

Get vulnerabilities by type

/import/images

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

/imports/images

Lists in-progress imports

/imports/images

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

/imports/images/{operation_id}

Invalidate operation ID so it can be garbage collected

/imports/images/{operation_id}

Get detail on a single import

/imports/images/{operation_id}/dockerfile

List uploaded dockerfiles

/imports/images/{operation_id}/dockerfile

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

/imports/images/{operation_id}/image_config

List uploaded image configs

/imports/images/{operation_id}/image_config

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

/imports/images/{operation_id}/manifest

List uploaded image manifests

/imports/images/{operation_id}/manifest

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

/imports/images/{operation_id}/packages

List uploaded package manifests

/imports/images/{operation_id}/packages

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

/imports/images/{operation_id}/parent_manifest

List uploaded parent manifests (manifest lists for a tag)

/imports/images/{operation_id}/parent_manifest

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

/oauth/token

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

/policies

List policies

/policies

Add a new policy

/policies/{policyId}

Delete policy

/policies/{policyId}

Get specific policy

/policies/{policyId}

Update policy

/query/images/by_package

List of images containing given package

/query/images/by_vulnerability

List images vulnerable to the specific vulnerability ID.

/query/vulnerabilities

Listing information about given vulnerability

/registries

List configured registries

/registries

Add a new registry

/registries/{registry}

Delete a registry configuration

/registries/{registry}

Get a specific registry configuration

/registries/{registry}

Update/replace a registry configuration

/repositories

Add repository to watch

/status

Service status

/subscriptions

List all subscriptions

/subscriptions

Add a subscription of a specific type

/subscriptions/{subscriptionId}

Delete subscriptions of a specific type

/subscriptions/{subscriptionId}

Get a specific subscription set

/subscriptions/{subscriptionId}

Update an existing and specific subscription

/summaries/imagetags

List all visible image digests and tags

/system

System status

/system/error_codes

Describe anchore engine error codes.

/system/feeds

list feeds operations and information

/system/feeds

trigger feeds operations

/system/feeds/{feed}

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

/system/feeds/{feed}

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

/system/feeds/{feed}/{group}

Delete the group data and disable the group itself

/system/feeds/{feed}/{group}

Disable a specific group within a feed to not sync

/system/policy_spec

Describe the policy language spec implemented by this service.

/system/services

List system services

/system/services/{servicename}

Get a service configuration and state

/system/services/{servicename}/{hostid}

Delete the service config

/system/services/{servicename}/{hostid}

Get service config for a specific host

/system/webhooks/{webhook_type}/test

Adds the capabilities to test a webhook delivery for the given notification type

/user

List authenticated user info

/user/credentials

Get current credential summary

/user/credentials

add/replace credential

/version

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