openapi-directory/api/anchore.io.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","servers":[{"url":"/"},{"url":"http://anchore.local"}],"info":{"contact":{"email":"nurmi@anchore.com","x-twitter":"anchore"},"description":"This is the Anchore Engine API. Provides the primary external API for users of the service.","license":{"name":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0.html"},"title":"Anchore Engine API Server","version":"0.1.20","x-apisguru-categories":["developer_tools"],"x-logo":{"url":"https://twitter.com/anchore/profile_image?size=original"},"x-origin":[{"format":"openapi","url":"https://raw.githubusercontent.com/anchore/anchore-engine/master/anchore_engine/services/apiext/swagger/swagger.yaml","version":"3.0"}],"x-providerName":"anchore.io"},"tags":[{"description":"Subscription Management","name":"Subscriptions"},{"description":"Policy Management","name":"Policies"},{"description":"Image Management","name":"Images"},{"description":"View Image Content","name":"Image Content"},{"description":"Vulnerability checks and reports","name":"Vulnerabilities"},{"description":"Evaluate images against policies","name":"Policy Evaluation"},{"description":"Registry Management","name":"Registries"},{"description":"Repository Credential Management","name":"Repository Credentials"},{"description":"System Management","name":"System"},{"description":"Service Management","name":"Services"},{"description":"Resource Summaries","name":"Summaries"},{"description":"View and delete events","name":"Events"},{"description":"Resource Queries","name":"Queries"},{"description":"Manage Accounts, Users, and Credentials","name":"User Management"},{"description":"Get and operate on the authenticated user's identity","name":"Identity"},{"description":"Data Archiving Management","name":"Archives"}],"paths":{"/":{"get":{"description":"Simple status check","operationId":"ping","responses":{"200":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"Version check response, returns the api version prefix (e.g. 'v1')"}},"x-anchore-authz-action":"None","x-swagger-router-controller":"anchore_engine.services.apiext.api.controllers.system"}},"/account":{"get":{"operationId":"get_users_account","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account"}}},"description":"User details for caller's user"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}},"description":"Internal error"}},"summary":"List the account for the authenticated user","tags":["Identity"],"x-anchore-authz-action":"getAccount","x-swagger-router-controller":"anchore_engine.services.apiext.api.controllers.accounts"}},"/accounts":{"get":{"operationId":"list_accounts","parameters":[{"description":"Filter accounts by state","in":"query","name":"state","required":false,"schema":{"enum":["enabled","disabled","deleting"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountList"}}},"description":"Accound summary listing"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}},"description":"Internal error"}},"summary":"List user summaries. Only available to the system admin user.","tags":["User Management"],"x-anchore-authz-action":"listAccounts","x-swagger-router-controller":"anchore_engine.services.apiext.api.controllers.accounts"},"post":{"operationId":"create_account","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountCreationRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account"}}},"description":"Account Record"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}},"description":"Conflicting user information. User already exists."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}},"description":"Internal error"}},"summary":"Create a new user. Only avaialble to admin user.","tags":["User Management"],"x-anchore-authz-action":"createAccount","x-swagger-router-controller":"anchore_engine.services.apiext.api.controllers.accounts"}},"/accounts/{accountname}":{"delete":{"operationId":"delete_account","parameters":[{"in":"path","name":"accountname","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Successful deletion"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}},"description":"Internal error"}},"summary":"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","tags":["User Management"],"x-anchore-authz-action":"deleteAccount","x-swagger-router-controller":"anchore_engine.services.apiext.api.controllers.accounts"},"get":{"operationId":"get_account","parameters":[{"in":"path","name":"accountname","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account"}}},"description":"Get user information"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}},"description":"Internal error"}},"summary":"Get info about an user. Only available to admin user. Uses the main user Id, not a username.","tags":["User Management"],"x-anchore-authz-action":"getAccount","x-swagger-router-controller":"anchore_engine.services.apiext.api.controllers.accounts"}},"/accounts/{accountname}/state":{"put":{"operationId":"update_account_state","parameters":[{"in":"path","name":"accountname","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountStatus"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountStatus"}}},"description":"Updated state of the account"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}},"description":"State requested is invalid based on current state of the account"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}},"description":"Internal error"}},"summary":"Update the state of an account to either enabled or disabled. For deletion use the DELETE route","tags":["User Management"],"x-anchore-authz-action":"updateAccount","x-swagger-router-controller":"anchore_engine.services.apiext.api.controllers.accounts"}},"/accounts/{accountname}/users":{"get":{"operationId":"list_users","parameters":[{"in":"path","name":"accountname","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"description":"List of user credential records","items":{"$ref":"#/components/schemas/User"},"type":"array"}}},"description":"User listing"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}},"description":"Internal error"}},"summary":"List accounts for the user","tags":["User Management"],"x-anchore-authz-action":"listUsers","x-swagger-router-controller":"anchore_engine.services.apiext.api.controllers.accounts"},"post":{"operationId":"create_user","parameters":[{"in":"path","name":"accountname","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserCreationRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}},"description":"Credential summary"}},"summary":"Create a new user","tags":["User Management"],"x-anchore-authz-action":"createUser","x-swagger-router-controller":"anchore_engine.services.apiext.api.controllers.accounts"}},"/accounts/{accountname}/users/{username}":{"delete":{"operationId":"delete_user","parameters":[{"in":"path","name":"accountname","required":true,"schema":{"type":"string"}},{"in":"path","name":"username","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Deleted credential"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}},"description":"Internal error"}},"summary":"Delete a specific user credential by username of the credential. Cannot be the credential used to authenticate the request.","tags":["User Management"],"x-anchore-authz-action":"deleteUser","x-swagger-router-controller":"anchore_engine.services.apiext.api.controllers.accounts"},"get":{"operationId":"get_account_user","parameters":[{"in":"path","name":"accountname","required":true,"schema":{"type":"string"}},{"in":"path","name":"username","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}},"description":"User record"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}},"description":"Internal error"}},"summary":"Get a specific user in the specified account","tags":["User Management"],"x-anchore-authz-action":"getUser","x-swagger-router-controller":"anchore_engine.services.apiext.api.controllers.accounts"}},"/accounts/{accountname}/users/{username}/credentials":{"delete":{"operationId":"delete_user_credential","parameters":[{"in":"path","name":"accountname","required":true,"schema":{"type":"string"}},{"in":"path","name":"username","required":true,"schema":{"type":"string"}},{"in":"query","name":"credential_type","required":true,"schema":{"enum":["password"],"type":"string"}}],"responses":{"204":{"description":"Successful deletion"},"400":{"description":"Conflict, cannot delete the credential used to authenticate this request"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}},"description":"Internal error"}},"summary":"Delete a credential by type","tags":["User Management"],"x-anchore-authz-action":"updateUser","x-swagger-router-controller":"anchore_engine.services.apiext.api.controllers.accounts"},"get":{"operationId":"list_user_credentials","parameters":[{"in":"path","name":"accountname","required":true,"schema":{"type":"string"}},{"in":"path","name":"username","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CredentialList"}}},"description":"User credential listing"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}},"description":"Internal error"}},"summary":"Get current credential summary","tags":["User Management"],"x-anchore-authz-action":"getUser","x-swagger-router-controller":"anchore_engine.services.apiext.api.controllers.accounts"},"post":{"operationId":"create_user_credential","parameters":[{"in":"path","name":"accountname","required":true,"schema":{"type":"string"}},{"in":"path","name":"username","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/AccessCredential"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}},"description":"Add a credential, overwritting if already exists"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}},"description":"Internal error"}},"summary":"add/replace credential","tags":["User Management"],"x-anchore-authz-action":"updateUser","x-swagger-router-controller":"anchore_engine.services.apiext.api.controllers.accounts"}},"/archives":{"get":{"operationId":"list_archives","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ArchiveSummary"}}},"description":"Archive summary listing"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}},"description":"Internal error"}},"tags":["Archives"],"x-anchore-authz-action":"listArchives","x-swagger-router-controller":"anchore_engine.services.apiext.api.controllers.archive"}},"/archives/images":{"get":{"operationId":"list_analysis_archive","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ArchivedAnalyses"}}},"description":"Image analysis archive listing for the requesting account (not the whole system)"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}},"description":"Internal error"}},"tags":["Archives"],"x-anchore-authz-action":"listArchivedImageAnalysis","x-swagger-router-controller":"anchore_engine.services.apiext.api.controllers.archive"},"post":{"operationId":"archive_image_analysis","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageAnalysisReferences"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddAnalysisArchiveResult"}}},"description":"Archive statuses"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}},"description":"Internal error"}},"tags":["Archives"],"x-anchore-authz-action":"createArchivedImageAnalysis","x-swagger-router-controller":"anchore_engine.services.apiext.api.controllers.archive"}},"/archives/images/{imageDigest}":{"delete":{"description":"Performs a synchronous archive deletion","operationId":"delete_archived_analysis","parameters":[{"in":"path","name":"imageDigest","required":true,"schema":{"type":"string"}},{"in":"query","name":"force","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"ArchivdImageAnalysis successfully deleted"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}},"description":"Internal error"}},"tags":["Archives"],"x-anchore-authz-action":"deleteArchivedImageAnalysis","x-swagger-router-controller":"anchore_engine.services.apiext.api.controllers.archive"},"get":{"description":"Returns the archive metadata record identifying the image and tags for the analysis in the archive.","operationId":"get_archived_analysis","parameters":[{"description":"The image digest to identify the image analysis","in":"path","name":"imageDigest","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ArchivedAnalysis"}}},"description":"Archived Image"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}},"description":"Internal error"}},"tags":["Archives"],"x-anchore-authz-action":"getArchivedImageAnalysis","x-swagger-router-controller":"anchore_engine.services.apiext.api.controllers.archive"}},"/archives/rules":{"get":{"operationId":"list_analysis_archive_rules","parameters":[{"description":"If true include system global rules (owned by admin) even for non-admin users. Defaults to true if not set. Can be set to false to exclude globals","in":"query","name":"system_global","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalysisArchiveRules"}}},"description":"Archive transition rules"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}},"description":"Internal error"}},"tags":["Archives"],"x-anchore-authz-action":"listArchiveTransitionRules","x-swagger-router-controller":"anchore_engine.services.apiext.api.controllers.archive"},"post":{"operationId":"create_analysis_archive_rule","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalysisArchiveTransitionRule"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalysisArchiveTransitionRule"}}},"description":"Archive transition rule"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}},"description":"Internal error"}},"tags":["Archives"],"x-anchore-authz-action":"createArchiveTransitionRule","x-swagger-router-controller":"anchore_engine.services.apiext.api.controllers.archive"}},"/archives/rules/{ruleId}":{"delete":{"operationId":"delete_analysis_archive_rule","parameters":[{"in":"path","name":"ruleId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Analysis archive rule succesfuly deleted"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}},"description":"Internal error"}},"tags":["Archives"],"x-anchore-authz-action":"deleteArchiveTransitionRule","x-swagger-router-controller":"anchore_engine.services.apiext.api.controllers.archive"},"get":{"operationId":"get_analysis_archive_rule","parameters":[{"in":"path","name":"ruleId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalysisArchiveTransitionRule"}}},"description":"Archive transition rule"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}},"description":"Internal error"}},"tags":["Archives"],"x-anchore-authz-action":"getArchiveTransitionRule","x-swagger-router-controller":"anchore_engine.services.apiext.api.controllers.archive"}},"/event_types":{"get":{"description":"Returns list of event types in the category hierarchy","operationId":"list_event_types","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventTypesList"}}},"description":"List of event types"}},"summary":"List Event Types","tags":["Events"],"x-anchore-authz-action":"listEvents","x-swagger-router-controller":"anchore_engine.services.apiext.api.controllers.events"}},"/events":{"delete":{"description":"Delete all or a subset of events filtered using the optional query parameters","operationId":"delete_events","parameters":[{"description":"Delete events that occurred before the timestamp","in":"query","name":"before","required":false,"schema":{"type":"string"}},{"description":"Delete events that occurred after the timestamp","in":"query","name":"since","required":false,"schema":{"type":"string"}},{"description":"Delete events that match the level - INFO or ERROR","in":"query","name":"level","required":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/AsAccountParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"type":"string"},"type":"array"}}},"description":"List of deleted event IDs"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}},"description":"Internal Error"}},"summary":"Delete Events","tags":["Events"],"x-anchore-authz-action":"deleteEvents","x-swagger-router-controller":"anchore_engine.services.apiext.api.controllers.events"},"get":{"description":"Returns a paginated list of events in the descending order of their occurrence. Optional query parameters may be used for filtering results","operationId":"list_events","parameters":[{"description":"Filter events by the originating service","in":"query","name":"source_servicename","required":false,"schema":{"type":"string"}},{"description":"Filter events by the originating host ID","in":"query","name":"source_hostid","required":false,"schema":{"type":"string"}},{"description":"Filter events by a prefix match on the event type (e.g. \"user.image.\")","in":"query","name":"event_type","required":false,"schema":{"pattern":"^[a-z0-9-_.*]+$","type":"string"}},{"description":"Filter events by the type of resource - tag, imageDigest, repository etc","in":"query","name":"resource_type","required":false,"schema":{"type":"string"}},{"description":"Filter events by the id of the resource","in":"query","name":"resource_id","required":false,"schema":{"type":"string"}},{"description":"Filter events by the level - INFO or ERROR","in":"query","name":"level","required":false,"schema":{"type":"string"}},{"description":"Return events that occurred after the timestamp","in":"query","name":"since","required":false,"schema":{"type":"string"}},{"description":"Return events that occurred before the timestamp","in":"query","name":"before","required":false,"schema":{"type":"string"}},{"description":"Pagination controls - return the nth page of results. Defaults to first page if left empty","in":"query","name":"page","required":false,"schema":{"default":1,"type":"integer"}},{"description":"Number of events in the result set. Defaults to 100 if left empty","in":"query","name":"limit","required":false,"schema":{"default":100,"type":"integer"}},{"$ref":"#/components/parameters/AsAccountParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventsList"}}},"description":"Paginated list of event records and the next token"}},"summary":"List Events","tags":["Events"],"x-anchore-authz-action":"listEvents","x-swagger-router-controller":"anchore_engine.services.apiext.api.controllers.events"}},"/events/{eventId}":{"delete":{"description":"Delete an event by its event ID","operationId":"delete_event","parameters":[{"description":"Event ID of the event to be deleted","in":"path","name":"eventId","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/AsAccountParameter"}],"responses":{"200":{"description":"Delete success"}},"summary":"Delete Event","tags":["Events"],"x-anchore-authz-action":"getEvent","x-swagger-router-controller":"anchore_engine.services.apiext.api.controllers.events"},"get":{"description":"Lookup an event by its event ID","operationId":"get_event","parameters":[{"description":"Event ID of the event for lookup","in":"path","name":"eventId","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/AsAccountParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventResponse"}}},"description":"Single event record"}},"summary":"Get Event","tags":["Events"],"x-anchore-authz-action":"getEvent","x-swagger-router-controller":"anchore_engine.services.apiext.api.controllers.events"}},"/health":{"get":{"description":"Health check, returns 200 and no body if service is running","operationId":"health_check","responses":{"200":{"description":"Empty body on success"}},"x-anchore-authz-action":"None","x-swagger-router-controller":"anchore_engine.apis.common"}},"/images":{"delete":{"description":"Delete analysis for image digests in the list asynchronously","operationId":"delete_images_async","parameters":[{"explode":false,"in":"query","name":"imageDigests","required":true,"schema":{"items":{"type":"string"},"type":"array"},"style":"form","x-nullable":false},{"in":"query","name":"force","required":false,"schema":{"type":"boolean"}},{"$ref":"#/components/parameters/AsAccountParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteImageResponseList"}}},"description":"successful operation"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}},"description":"Internal Error"}},"summary":"Bulk mark images for deletion","tags":["Images"],"x-anchore-authz-action":"deleteImage","x-swagger-router-controller":"anchore_engine.services.apiext.api.controllers.images"},"get":{"description":"List all images visible to the user","operationId":"list_images","parameters":[{"description":"Include image history in the response","in":"query","name":"history","required":false,"schema":{"type":"boolean"}},{"description":"Full docker-pull string to filter results by (e.g. docker.io/library/nginx:latest, or myhost.com:5000/testimages:v1.1.1)","in":"query","name":"fulltag","required":false,"schema":{"type":"string"}},{"description":"Filter by image_status value on the record. Default if omitted is 'active'.","in":"query","name":"image_status","required":false,"schema":{"default":"active","enum":["all","active","deleting"],"type":"string"}},{"description":"Filter by analysis_status value on the record.","in":"query","name":"analysis_status","required":false,"schema":{"enum":["not_analyzed","analyzed","analyzing","analysis_failed"],"type":"string"}},{"$ref":"#/components/parameters/AsAccountParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnchoreImageList"}}},"description":"successful operation"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}},"description":"Internal Error"}},"summary":"List all visible images","tags":["Images"],"x-anchore-authz-action":"listImages","x-swagger-router-controller":"anchore_engine.services.apiext.api.controllers.images"},"post":{"description":"Creates a new analysis task that is executed asynchronously","operationId":"add_image","parameters":[{"description":"Override any existing entry in the system","in":"query","name":"force","required":false,"schema":{"type":"boolean"}},{"description":"Instruct engine to automatically begin watching the added tag for updates from registry","in":"query","name":"autosubscribe","required":false,"schema":{"type":"boolean"}},{"$ref":"#/components/parameters/AsAccountParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageAnalysisRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnchoreImageList"}}},"description":"Successfully added image to analysis queue"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}},"description":"Internal Error"}},"summary":"Submit a new image for analysis by the engine","tags":["Images"],"x-anchore-authz-action":"createImage","x-swagger-router-controller":"anchore_engine.services.apiext.api.controllers.images"}},"/images/by_id/{imageId}":{"delete":{"operationId":"delete_image_by_imageId","parameters":[{"in":"path","name":"imageId","required":true,"schema":{"type":"string"}},{"in":"query","name":"force","required":false,"schema":{"type":"boolean"}},{"$ref":"#/components/parameters/AsAccountParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteImageResponse"}}},"description":"Image deletion success"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}},"description":"Internal error"}},"summary":"Delete image by docker imageId","tags":["Images"],"x-anchore-authz-action":"deleteImage","x-swagger-router-controller":"anchore_engine.services.apiext.api.controllers.images"},"get":{"operationId":"get_image_by_imageId","parameters":[{"in":"path","name":"imageId","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/AsAccountParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnchoreImageList"}}},"description":"Image lookup success"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}},"description":"Internal error"}},"summary":"Lookup image by docker imageId","tags":["Images"],"x-anchore-authz-action":"getImage","x-swagger-router-controller":"anchore_engine.services.apiext.api.controllers.images"}},"/images/by_id/{imageId}/check":{"get":{"description":"Get the policy evaluation for the given image","operationId":"get_image_policy_check_by_imageId","parameters":[{"in":"path","name":"imageId","required":true,"schema":{"type":"string"}},{"in":"query","name":"policyId","required":false,"schema":{"type":"string"}},{"in":"query","name":"tag","required":true,"schema":{"type":"string"}},{"in":"query","name":"detail","required":false,"schema":{"type":"boolean"}},{"in":"query","name":"history","required":false,"schema":{"type":"boolean"}},{"$ref":"#/components/parameters/AsAccountParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyEvaluationList"}}},"description":"Policy evaluation success"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}},"description":"Internal Error"}},"summary":"Check policy evaluation status for image","tags":["Images"],"x-anchore-authz-action":"getImageEvaluation","x-swagger-router-controller":"anchore_engine.services.apiext.api.controllers.images"}},"/images/by_id/{imageId}/content":{"get":{"operationId":"list_image_content_by_imageid","parameters":[{"in":"path","name":"imageId","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/AsAccountParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"type":"string"},"type":"array"}}},"description":"Content of specified type from the image"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}},"description":"Internal error"}},"summary":"List image content types","tags":["Images"],"x-anchore-authz-action":"getImage","x-swagger-router-controller":"anchore_engine.services.apiext.api.controllers.images"}},"/images/by_id/{imageId}/content/files":{"get":{"operationId":"get_image_content_by_type_imageId_files","parameters":[{"in":"path","name":"imageId","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/AsAccountParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentFilesResponse"}}},"description":"Content of specified type from the image"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}},"description":"Internal error"}},"summary":"Get the content of an image by type files","tags":["Images"],"x-anchore-authz-action":"getImage","x-swagger-router-controller":"anchore_engine.services.apiext.api.controllers.images"}},"/images/by_id/{imageId}/content/java":{"get":{"operationId":"get_image_content_by_type_imageId_javapackage","parameters":[{"in":"path","name":"imageId","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/AsAccountParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentJAVAPackageResponse"}}},"description":"Content of specified type from the image"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}},"description":"Internal error"}},"summary":"Get the content of an image by type java","tags":["Images"],"x-anchore-authz-action":"getImage","x-swagger-router-controller":"anchore_engine.services.apiext.api.controllers.images"}},"/images/by_id/{imageId}/content/{ctype}":{"get":{"operationId":"get_image_content_by_type_imageId","parameters":[{"in":"path","name":"imageId","required":true,"schema":{"type":"string"}},{"in":"path","name":"ctype","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/AsAccountParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentPackageResponse"}}},"description":"Content of specified type from the image"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}},"description":"Internal error"}},"summary":"Get the content of an image by type","tags":["Images"],"x-anchore-authz-action":"getImage","x-swagger-router-controller":"anchore_engine.services.apiext.api.controllers.images"}},"/images/by_id/{imageId}/vuln":{"get":{"operationId":"get_image_vulnerability_types_by_imageId","parameters":[{"in":"path","name":"imageId","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/AsAccountParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"enum":["all","os","non-os"],"type":"string"},"type":"array"}}},"description":"Vulnerability listing for the image"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}},"description":"Internal Error"}},"summary":"Get vulnerability types","tags":["Images"],"x-anchore-authz-action":"getImage","x-swagger-router-controller":"anchore_engine.services.apiext.api.controllers.images"}},"/images/by_id/{imageId}/vuln/{vtype}":{"get":{"operationId":"get_image_vulnerabilities_by_type_imageId","parameters":[{"in":"path","name":"imageId","required":true,"schema":{"type":"string"}},{"in":"path","name":"vtype","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/AsAccountParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VulnerabilityResponse"}}},"description":"Vulnerability listing for the image"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}},"description":"Internal Error"}},"summary":"Get vulnerabilities by type","tags":["Images"],"x-anchore-authz-action":"getImage","x-swagger-router-controller":"anchore_engine.services.apiext.api.controllers.images"}},"/images/{imageDigest}":{"delete":{"operationId":"delete_image","parameters":[{"in":"path","name":"imageDigest","required":true,"schema":{"type":"string"}},{"in":"query","name":"force","required":false,"schema":{"type":"boolean"}},{"$ref":"#/components/parameters/AsAccountParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteImageResponse"}}},"description":"Image deletion success"}},"summary":"Delete an image analysis","tags":["Images"],"x-anchore-authz-action":"deleteImage","x-swagger-router-controller":"anchore_engine.services.apiext.api.controllers.images"},"get":{"operationId":"get_image","parameters":[{"in":"path","name":"imageDigest","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/AsAccountParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnchoreImageList"}}},"description":"Image lookup success"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}},"description":"Internal error"}},"summary":"Get image metadata","tags":["Images"],"x-anchore-authz-action":"getImage","x-swagger-router-controller":"anchore_engine.services.apiext.api.controllers.images"}},"/images/{imageDigest}/artifacts/file_content_search":{"get":{"operationId":"list_file_content_search_results","parameters":[{"in":"path","name":"imageDigest","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileContentSearchList"}}},"description":"List of file metadata objects"},"404":{"description":"Image not found in this service"}},"summary":"Return a list of analyzer artifacts of the specified type","x-anchore-authz-action":"getImage","x-swagger-router-controller":"anchore_engine.services.apiext.api.controllers.images"}},"/images/{imageDigest}/artifacts/retrieved_files":{"get":{"operationId":"list_retrieved_files","parameters":[{"in":"path","name":"imageDigest","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrievedFileList"}}},"description":"List of file metadata objects"},"404":{"description":"Image not found in this service"}},"summary":"Return a list of analyzer artifacts of the specified type","x-anchore-authz-action":"getImage","x-swagger-router-controller":"anchore_engine.services.apiext.api.controllers.images"}},"/images/{imageDigest}/artifacts/secret_search":{"get":{"operationId":"list_secret_search_results","parameters":[{"in":"path","name":"imageDigest","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecretSearchList"}}},"description":"List of file metadata objects"},"404":{"description":"Image not found in this service"}},"summary":"Return a list of analyzer artifacts of the specified type","x-anchore-authz-action":"getImage","x-swagger-router-controller":"anchore_engine.services.apiext.api.controllers.images"}},"/images/{imageDigest}/check":{"get":{"description":"Get the policy evaluation for the given image","operationId":"get_image_policy_check","parameters":[{"in":"path","name":"imageDigest","required":true,"schema":{"type":"string"}},{"in":"query","name":"policyId","required":false,"schema":{"type":"string"}},{"in":"query","name":"tag","required":true,"schema":{"type":"string"}},{"in":"query","name":"detail","required":false,"schema":{"type":"boolean"}},{"in":"query","name":"history","required":false,"schema":{"type":"boolean"}},{"in":"query","name":"interactive","required":false,"schema":{"type":"boolean"}},{"$ref":"#/components/parameters/AsAccountParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyEvaluationList"}}},"description":"Policy evaluation success"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}},"description":"Internal Error"}},"summary":"Check policy evaluation status for image","tags":["Images"],"x-anchore-authz-action":"getImageEvaluation","x-swagger-router-controller":"anchore_engine.services.apiext.api.controllers.images"}},"/images/{imageDigest}/content":{"get":{"operationId":"list_image_content","parameters":[{"in":"path","name":"imageDigest","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/AsAccountParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"type":"string"},"type":"array"}}},"description":"Content listing for the image"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}},"description":"Internal Error"}},"summary":"List image content types","tags":["Images"],"x-anchore-authz-action":"getImage","x-swagger-router-controller":"anchore_engine.services.apiext.api.controllers.images"}},"/images/{imageDigest}/content/files":{"get":{"operationId":"get_image_content_by_type_files","parameters":[{"in":"path","name":"imageDigest","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/AsAccountParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentFilesResponse"}}},"description":"Content of specified type from the image"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}},"description":"Internal error"}},"summary":"Get the content of an image by type files","tags":["Images"],"x-anchore-authz-action":"getImage","x-swagger-router-controller":"anchore_engine.services.apiext.api.controllers.images"}},"/images/{imageDigest}/content/java":{"get":{"operationId":"get_image_content_by_type_javapackage","parameters":[{"in":"path","name":"imageDigest","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/AsAccountParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentJAVAPackageResponse"}}},"description":"Content of specified type from the image"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}},"description":"Internal error"}},"summary":"Get the content of an image by type java","tags":["Images"],"x-anchore-authz-action":"getImage","x-swagger-router-controller":"anchore_engine.services.apiext.api.controllers.images"}},"/images/{imageDigest}/content/malware":{"get":{"operationId":"get_image_content_by_type_malware","parameters":[{"in":"path","name":"imageDigest","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/AsAccountParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentMalwareResponse"}}},"description":"Content of specified type from the image"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}},"description":"Internal error"}},"summary":"Get the content of an image by type malware","tags":["Images"],"x-anchore-authz-action":"getImage","x-swagger-router-controller":"anchore_engine.services.apiext.api.controllers.images"}},"/images/{imageDigest}/content/{ctype}":{"get":{"operationId":"get_image_content_by_type","parameters":[{"in":"path","name":"imageDigest","required":true,"schema":{"type":"string"}},{"in":"path","name":"ctype","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/AsAccountParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentPackageResponse"}}},"description":"Content of specified type from the image"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}},"description":"Internal error"}},"summary":"Get the content of an image by type","tags":["Images"],"x-anchore-authz-action":"getImage","x-swagger-router-controller":"anchore_engine.services.apiext.api.controllers.images"}},"/images/{imageDigest}/metadata":{"get":{"operationId":"list_image_metadata","parameters":[{"in":"path","name":"imageDigest","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/AsAccountParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"type":"string"},"type":"array"}}},"description":"Metadata listing for the image"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}},"description":"Internal Error"}},"summary":"List image metadata types","tags":["Images"],"x-anchore-authz-action":"getImage","x-swagger-router-controller":"anchore_engine.services.apiext.api.controllers.images"}},"/images/{imageDigest}/metadata/{mtype}":{"get":{"operationId":"get_image_metadata_by_type","parameters":[{"in":"path","name":"imageDigest","required":true,"schema":{"type":"string"}},{"in":"path","name":"mtype","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/AsAccountParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataResponse"}}},"description":"Metadata of specified type from the image"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}},"description":"Internal error"}},"summary":"Get the metadata of an image by type","tags":["Images"],"x-anchore-authz-action":"getImage","x-swagger-router-controller":"anchore_engine.services.apiext.api.controllers.images"}},"/images/{imageDigest}/sboms/native":{"get":{"operationId":"get_image_sbom_native","parameters":[{"in":"path","name":"imageDigest","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/AsAccountParameter"}],"responses":{"200":{"content":{"application/gzip":{"schema":{"format":"binary","type":"string"}}},"description":"Image lookup success"},"500":{"content":{"application/gzip":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}},"description":"Internal error"}},"summary":"Get image sbom in the native Anchore format","tags":["Images"],"x-anchore-authz-action":"getImage","x-swagger-router-controller":"anchore_engine.services.apiext.api.controllers.images"}},"/images/{imageDigest}/vuln":{"get":{"operationId":"get_image_vulnerability_types","parameters":[{"in":"path","name":"imageDigest","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/AsAccountParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"enum":["all","os","non-os"],"type":"string"},"type":"array"}}},"description":"Vulnerability listing for the image"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}},"description":"Internal Error"}},"summary":"Get vulnerability types","tags":["Images"],"x-anchore-authz-action":"getImage","x-swagger-router-controller":"anchore_engine.services.apiext.api.controllers.images"}},"/images/{imageDigest}/vuln/{vtype}":{"get":{"operationId":"get_image_vulnerabilities_by_type","parameters":[{"in":"path","name":"imageDigest","required":true,"schema":{"type":"string"}},{"in":"path","name":"vtype","required":true,"schema":{"type":"string"}},{"in":"query","name":"force_refresh","required":false,"schema":{"type":"boolean"}},{"description":"Filter results to include only vulnerabilities that are not marked as invalid by upstream OS vendor data. When set to true, it will filter out all vulnerabilities where `will_not_fix` is False. If false all vulnerabilities are returned regardless of `will_not_fix`","in":"query","name":"vendor_only","required":false,"schema":{"type":"boolean"}},{"$ref":"#/components/parameters/AsAccountParameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VulnerabilityResponse"}}},"description":"Vulnerability listing for the image"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}},"description":"Internal Error"}},"summary":"Get vulnerabilities by type","tags":["Images"],"x-anchore-authz-action":"getImage","x-swagger-router-controller":"anchore_engine.services.apiext.api.controllers.images"}},"/import/images":{"post":{"operationId":"import_image_archive","requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"archive_file":{"description":"anchore image tar archive.","format":"binary","type":"string"}},"required":["archive_file"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnchoreImageList"}}},"description":"Successfully imported image to the engine"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}},"description":"Internal Error"}},"summary":"Import an anchore image tar.gz archive file. This is a deprecated API replaced by the \"/imports/images\" route","tags":["Import"],"x-anchore-authz-action":"importImage","x-swagger-router-controller":"anchore_engine.services.apiext.api.controllers.images"}},"/imports/images":{"get":{"operationId":"list_operations","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageImports"}}},"description":"success"},"500":{"description":"Internal Error"}},"summary":"Lists in-progress imports","tags":["Imports"],"x-anchore-authz-action":"importImage","x-swagger-router-controller":"anchore_engine.services.apiext.api.controllers.image_imports"},"post":{"operationId":"create_operation","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageImportOperation"}}},"description":"success"},"500":{"description":"Internal Error"}},"summary":"Begin the import of an image analyzed by Syft into the system","tags":["Imports"],"x-anchore-authz-action":"importImage","x-swagger-router-controller":"anchore_engine.services.apiext.api.controllers.image_imports"}},"/imports/images/{operation_id}":{"delete":{"operationId":"invalidate_operation","parameters":[{"in":"path","name":"operation_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageImportOperation"}}},"description":"success"},"500":{"description":"Internal Error"}},"summary":"Invalidate operation ID so it can be garbage collected","tags":["Imports"],"x-anchore-authz-action":"importImage","x-swagger-router-controller":"anchore_engine.services.apiext.api.controllers.image_imports"},"get":{"operationId":"get_operation","parameters":[{"in":"path","name":"operation_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageImportOperation"}}},"description":"success"},"500":{"description":"Internal Error"}},"summary":"Get detail on a single import","tags":["Imports"],"x-anchore-authz-action":"importImage","x-swagger-router-controller":"anchore_engine.services.apiext.api.controllers.image_imports"}},"/imports/images/{operation_id}/dockerfile":{"get":{"operationId":"list_import_dockerfiles","parameters":[{"in":"path","name":"operation_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportContentDigestList"}}},"description":"success"},"500":{"description":"Internal Error"}},"summary":"List uploaded dockerfiles","tags":["Imports"],"x-anchore-authz-action":"importImage","x-swagger-router-controller":"anchore_engine.services.apiext.api.controllers.image_imports"},"post":{"operationId":"import_image_dockerfile","parameters":[{"in":"path","name":"operation_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"text/plain; utf-8":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageImportContentResponse"}}},"description":"success"},"500":{"description":"Internal Error"}},"summary":"Begin the import of an image analyzed by Syft into the system","tags":["Imports"],"x-anchore-authz-action":"importImage","x-swagger-router-controller":"anchore_engine.services.apiext.api.controllers.image_imports"}},"/imports/images/{operation_id}/image_config":{"get":{"operationId":"list_import_image_configs","parameters":[{"in":"path","name":"operation_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportContentDigestList"}}},"description":"success"},"500":{"description":"Internal Error"}},"summary":"List uploaded image configs","tags":["Imports"],"x-anchore-authz-action":"importImage","x-swagger-router-controller":"anchore_engine.services.apiext.api.controllers.image_imports"},"post":{"operationId":"import_image_config","parameters":[{"in":"path","name":"operation_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageImportContentResponse"}}},"description":"success"},"500":{"description":"Internal Error"}},"summary":"Import a docker or OCI image config to associate with the image","