Creates a new analysis task that is executed asynchronously
643 matches
92 actions
Anchore Engine API Server
92 actions
- Add a new policyPOSTv1.0.0
- Add a new registryPOSTv1.0.0
- Add a subscription of a specific typePOSTv1.0.0
- Add repository to watchPOSTv1.0.0
- add/replace credentialPOSTv1.0.0
- add/replace credentialPOSTv1.0.0
- archive_image_analysisPOSTv1.0.0
- Check policy evaluation status for imageGETv1.0.0
- Check policy evaluation status for imageGETv1.0.0
- Create a new userPOSTv1.0.0
- Create a new user. Only avaialble to admin user.POSTv1.0.0
- create_analysis_archive_rulePOSTv1.0.0
- Delete a credential by typeDELETEv1.0.0
- Delete a registry configurationDELETEv1.0.0
- Delete a specific user credential by username of the credential. Cannot be the credential used to authenticate the request.DELETEv1.0.0
- Delete an image analysisDELETEv1.0.0
- Delete EventDELETEv1.0.0
- Delete EventsDELETEv1.0.0
- Delete image by docker imageIdDELETEv1.0.0
- Delete policyDELETEv1.0.0
- Delete subscriptions of a specific typeDELETEv1.0.0
- Delete the service configDELETEv1.0.0
- 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 collectedDELETEv1.0.0
- delete_analysis_archive_ruleDELETEv1.0.0
- delete_archived_analysisDELETEv1.0.0
- delete_feedDELETEv1.0.0
- delete_feed_groupDELETEv1.0.0
- Describe anchore engine error codes.GETv1.0.0
- Describe the policy language spec implemented by this service.GETv1.0.0
- Get a service configuration and stateGETv1.0.0
- Get a specific registry configurationGETv1.0.0
- Get a specific subscription setGETv1.0.0
- Get a specific user in the specified accountGETv1.0.0
- Get current credential summaryGETv1.0.0
- Get current credential summaryGETv1.0.0
- Get EventGETv1.0.0
- Get image metadataGETv1.0.0
- Get image sbom in the native Anchore formatGETv1.0.0
- Get info about an user. Only available to admin user. Uses the main user Id, not a username.GETv1.0.0
- Get service config for a specific hostGETv1.0.0
- Get specific policyGETv1.0.0
- Get the content of an image by typeGETv1.0.0
- Get the content of an image by typeGETv1.0.0
- Get the content of an image by type filesGETv1.0.0
- Get the content of an image by type filesGETv1.0.0
- Get the content of an image by type javaGETv1.0.0
- Get the content of an image by type javaGETv1.0.0
- Get the content of an image by type malwareGETv1.0.0
- Get the metadata of an image by typeGETv1.0.0
- Get vulnerabilities by typeGETv1.0.0
- Get vulnerabilities by typeGETv1.0.0
- Get vulnerability typesGETv1.0.0
- Get vulnerability typesGETv1.0.0
- get_analysis_archive_ruleGETv1.0.0
- get_archived_analysisGETv1.0.0
- Invalidate operation ID so it can be garbage collectedDELETEv1.0.0
- List accounts for the userGETv1.0.0
- List all subscriptionsGETv1.0.0
- List all visible image digests and tagsGETv1.0.0
- List all visible imagesGETv1.0.0
- List authenticated user infoGETv1.0.0
- List configured registriesGETv1.0.0
- List Event TypesGETv1.0.0
- List EventsGETv1.0.0
- list feeds operations and informationGETv1.0.0
- List image content typesGETv1.0.0
- List image content typesGETv1.0.0
- List image metadata typesGETv1.0.0
- List images vulnerable to the specific vulnerability ID.GETv1.0.0
- List of images containing given packageGETv1.0.0
- List policiesGETv1.0.0
- List system servicesGETv1.0.0
- List the account for the authenticated userGETv1.0.0
- List user summaries. Only available to the system admin user.GETv1.0.0
- list_analysis_archiveGETv1.0.0
- list_analysis_archive_rulesGETv1.0.0
- list_archivesGETv1.0.0
- Listing information about given vulnerabilityGETv1.0.0
- Lookup image by docker imageIdGETv1.0.0
- Return a list of analyzer artifacts of the specified typeGETv1.0.0
- Return a list of analyzer artifacts of the specified typeGETv1.0.0
- Return a list of analyzer artifacts of the specified typeGETv1.0.0
- Service statusGETv1.0.0
- Submit a new image for analysis by the enginePOSTv1.0.0
- System statusGETv1.0.0
- toggle_feed_enabledPUTv1.0.0
- toggle_group_enabledPUTv1.0.0
- trigger feeds operationsPOSTv1.0.0
- Update an existing and specific subscriptionPUTv1.0.0
- Update policyPUTv1.0.0
- Update the state of an account to either enabled or disabled. For deletion use the DELETE routePUTv1.0.0
- Update/replace a registry configurationPUTv1.0.0
Other/Anchore Engine API Server
Submit a new image for analysis by the engine
v1.0.0Input
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 154
- 155
- 156
- 157
- 158
- 159
- 160
- 161
- 162
- 163
- 164
- 165
- 166
{
"type": "object",
"properties": {
"annotations": {
"type": "object",
"description": "Annotations to be associated with the added image in key/value form"
},
"autosubscribe": {
"type": "boolean"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Optional override of the image creation time, only honored when both tag and digest are also supplied e.g. 2018-10-17T18:14:00Z. Deprecated in favor of the 'source' field"
},
"digest": {
"type": "string",
"description": "A digest string for an image, maybe a pull string or just a digest. e.g. nginx@sha256:123 or sha256:abc123. If a pull string, it must have same regisry/repo as the tag field. Deprecated in favor of the 'source' field"
},
"dockerfile": {
"type": "string",
"description": "Base64 encoded content of the dockerfile for the image, if available. Deprecated in favor of the 'source' field."
},
"force": {
"type": "boolean"
},
"image_type": {
"type": "string",
"description": "Optional. The type of image this is adding, defaults to \"docker\". This can be ommitted until multiple image types are supported."
},
"source": {
"type": "object",
"description": "A set of analysis source types. Only one may be set in any given request.",
"properties": {
"archive": {
"type": "object",
"description": "An image reference in the analysis archive for the purposes of loading analysis from the archive into th working set",
"required": [
"digest"
],
"properties": {
"digest": {
"type": "string",
"description": "The image digest identify the analysis. Archived analyses are based on digest, tag records are restored as analysis is restored."
}
}
},
"digest": {
"type": "object",
"description": "An image reference using a digest in a registry, includes some extra tag and timestamp info in addition to the pull string to allow proper tag history reconstruction.",
"required": [
"pullstring",
"tag"
],
"properties": {
"creation_timestamp_override": {
"type": "string",
"format": "date-time",
"description": "Optional override of the image creation time to support proper tag history construction in cases of out-of-order analysis compared to registry history for the tag"
},
"dockerfile": {
"type": "string",
"description": "Base64 encoded content of the dockerfile used to build the image, if available."
},
"pullstring": {
"type": "string",
"description": "A digest-based pullstring (e.g. docker.io/nginx@sha256:123abc)"
},
"tag": {
"type": "string",
"description": "A valid docker tag reference (e.g. docker.io/nginx:latest) that will be associated with the image but not used to pull the image."
}
}
},
"import": {
"type": "object",
"required": [
"contents",
"digest",
"operation_uuid",
"tags"
],
"properties": {
"contents": {
"type": "object",
"description": "Digest of content to use in the final import",
"required": [
"image_config",
"manifest",
"packages"
],
"properties": {
"dockerfile": {
"type": "string",
"description": "Digest for reference content for dockerfile"
},
"image_config": {
"type": "string",
"description": "Digest for reference content for image config"
},
"manifest": {
"type": "string",
"description": "Digest to reference content for the image manifest"
},
"packages": {
"type": "string",
"description": "Digest to use for the packages content"
},
"parent_manifest": {
"type": "string",
"description": "Digest for reference content for parent manifest"
}
}
},
"digest": {
"type": "string"
},
"local_image_id": {
"type": "string",
"description": "An \"imageId\" as used by Docker if available"
},
"operation_uuid": {
"type": "string"
},
"parent_digest": {
"type": "string",
"description": "The digest of the images's manifest-list parent if it was accessed from a multi-arch tag where the tag pointed to a manifest-list. This allows preservation of that relationship in the data"
},
"tags": {
"type": "array",
"items": {
"type": "string",
"description": "Full docker reference tags"
}
}
}
},
"tag": {
"type": "object",
"description": "An image reference using a tag in a registry, this is the most common source type.",
"required": [
"pullstring"
],
"properties": {
"dockerfile": {
"type": "string",
"description": "Base64 encoded content of the dockerfile used to build the image, if available."
},
"pullstring": {
"type": "string",
"description": "A docker pull string (e.g. docker.io/nginx:latest, or docker.io/nginx@sha256:abd) to retrieve the image"
}
}
}
}
},
"tag": {
"type": "string",
"description": "Full pullable tag reference for image. e.g. docker.io/nginx:latest. Deprecated in favor of the 'source' field"
},
"x-anchore-account": {
"type": "string"
}
},
"additionalProperties": false
}Output
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
{
"type": "array",
"description": "A list of Anchore Images",
"items": {
"type": "object",
"description": "A unique image in the engine. May have multiple tags or references. Unique to an image content across registries or repositories.",
"properties": {
"analysis_status": {
"type": "string",
"description": "A state value for the current status of the analysis progress of the image",
"enum": [
"not_analyzed",
"analyzing",
"analyzed",
"analysis_failed"
]
},
"annotations": {
"type": "object"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"imageDigest": {
"type": "string"
},
"image_content": {
"type": "object",
"description": "A metadata content record for a specific image, containing different content type entries"
},
"image_detail": {
"type": "array",
"description": "Details specific to an image reference and type such as tag and image source",
"items": {
"type": "object",
"description": "A metadata detail record for a specific image. Multiple detail records may map a single catalog image.",
"properties": {
"created_at": {
"type": "string",
"format": "date-time"
},
"dockerfile": {
"type": "string"
},
"fulldigest": {
"type": "string",
"description": "Full docker-pullable digest string including the registry url and repository necessary get the image"
},
"fulltag": {
"type": "string",
"description": "Full docker-pullable tag string referencing the image"
},
"imageDigest": {
"type": "string",
"description": "The parent Anchore Image record to which this detail maps"
},
"imageId": {
"type": "string"
},
"last_updated": {
"type": "string",
"format": "date-time"
},
"registry": {
"type": "string"
},
"repo": {
"type": "string"
},
"userId": {
"type": "string"
}
}
}
},
"image_status": {
"type": "string",
"description": "State of the image",
"enum": [
"active",
"inactive",
"disabled"
]
},
"last_updated": {
"type": "string",
"format": "date-time"
},
"record_version": {
"type": "string",
"description": "The version of the record, used for internal schema updates and data migrations."
},
"userId": {
"type": "string"
}
}
}
}