{"openapi":"3.0.0","info":{"title":"Container Security v1","version":"1.0.0"},"security":[{"cloud":[]}],"servers":[{"url":"https://cloud.tenable.com"}],"components":{"securitySchemes":{"cloud":{"type":"apiKey","in":"header","name":"X-ApiKeys","description":"Format - accessKey=ACCESS_KEY;secretKey=SECRET_KEY"}}},"x-samples-languages":["python","curl","node","powershell","ruby","javascript","objectivec","java","php","csharp","go","swift","kotlin"],"paths":{"/container-security/api/v1/container/list":{"get":{"summary":"List containers","description":"**Deprecated!** Tenable.io Container Security API v1 is deprecated. Use the [GET /container-security/api/v2/images](/reference#list-images) endpoint instead.\nLists all containers.
Requires BASIC [16] user permissions. See Permissions.
","operationId":"container-security-containers-list-containers","deprecated":true,"tags":["Containers"],"responses":{"200":{"description":"Returns an array of containers.","content":{"application/json":{"schema":{},"examples":{"response":{"value":[{"number_of_vulnerabilities":"string","name":"string","size":"string","digest":"string","repo_name":"string","score":"string","id":"string","status":"string","created_at":"string","repo_id":"string","platform":"string","updated_at":"string"}]}}}}},"401":{"description":"Returns an error message if the request is not authorized."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"\n\n\nRequires BASIC [16] user permissions. See Permissions.
","operationId":"container-security-containers-image-inventory","deprecated":true,"tags":["Containers"],"parameters":[{"description":"The ID of the image that you want to inventory.","required":true,"name":"imageID","in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns the inventory of the image you specified.","content":{"application/json":{"schema":{"type":"object","properties":{"files":{"type":"array","items":{"type":"object"}},"packages":{"type":"array","items":{"type":"object"}},"id":{"type":"string"}}},"examples":{"response":{"value":{"files":[{"path":"string","md5":"string","sha256":"string","fileType":"string","isCritical":true}],"packages":[{"name":"string","version":"string","release":"string","epoch":"string","rawString":"string"}],"id":"string"}}}}}},"401":{"description":"Returns an error message if the request is not authorized."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"\n\n\nRequires STANDARD [32] user permissions. See Permissions.
","operationId":"container-security-import-import","tags":["Import"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"host":{"type":"string","description":""},"port":{"type":"integer","description":"","format":"int32"},"username":{"type":"string","description":""},"password":{"type":"string","description":""},"provider":{"type":"string","description":""},"active":{"type":"boolean","description":""},"ssl":{"type":"boolean","description":""}},"required":["host","port","username","password","provider","ssl"]}}}},"responses":{"200":{"description":"Returns the ID you specified in the request.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"id":{"type":"string"}}},"examples":{"response":{"value":{"status":"string","id":"string"}}}}}},"401":{"description":"Returns an error message if the request is not authorized."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"\n\n\nRequires STANDARD [32] user permissions. See Permissions.
","operationId":"container-security-import-list-imports","tags":["Import"],"responses":{"200":{"description":"Returns an array of information about each import that has been performed.","content":{"application/json":{"schema":{},"examples":{"response":{"value":[{"org_id":"integer","user_uuid":"string","host":"string","port":"integer","username":"string","password":"string","provider":"string","active":"boolean","ssl":"boolean","hourBetween":"integer","id":"integer","created_at":"string","updated_at":"string","started_at":"string","finished_at":"string"}]}}}}},"401":{"description":"Returns an error message if the request is not authorized."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"\n\n\nRequires STANDARD [32] user permissions. See Permissions.
","operationId":"container-security-import-update-import-by-id","tags":["Import"],"parameters":[{"description":"The ID of the import that you want to update.","required":true,"name":"id","in":"path","schema":{"type":"integer","format":"int32"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"host":{"type":"string","description":""},"port":{"type":"integer","description":"","format":"int32"},"username":{"type":"string","description":""},"password":{"type":"string","description":""},"provider":{"type":"string","description":""},"active":{"type":"boolean","description":""},"ssl":{"type":"boolean","description":""}},"required":["host","port","username","password","provider","ssl"]}}}},"responses":{"200":{"description":"Returns the ID you specified in the request.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"id":{"type":"string"}}},"examples":{"response":{"value":{"status":"string","id":"string"}}}}}},"401":{"description":"Returns an error message if the request is not authorized."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"\n\n\nRequires STANDARD [32] user permissions. See Permissions.
","operationId":"container-security-import-delete-import-by-id","deprecated":true,"tags":["Import"],"parameters":[{"description":"The ID of the import that you want to delete.","required":true,"name":"id","in":"path","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns the ID of the deleted import.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"id":{"type":"string"}}},"examples":{"response":{"value":{"status":"string","id":"string"}}}}}},"401":{"description":"Returns an error message if the request is not authorized."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"\n\n\nRequires STANDARD [32] user permissions. See Permissions.
","operationId":"container-security-import-run-import-by-id","deprecated":true,"tags":["Import"],"parameters":[{"description":"The ID of the import that you want to run.","required":true,"name":"id","in":"path","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns the ID of the import you want to run.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"id":{"type":"string"}}},"examples":{"response":{"value":{"status":"string","id":"string"}}}}}},"401":{"description":"Returns an error message if the request is not authorized."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"\n\n\nRequires STANDARD [32] user permissions. See Permissions.
","operationId":"container-security-import-test-connection","deprecated":true,"tags":["Import"],"parameters":[{"description":"A test ID. You can specify any integer as the ID. Tenable.io Container Security uses this value for the test only.","required":true,"name":"id","in":"path","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns the ID you specified in the request.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"id":{"type":"string"}}},"examples":{"response":{"value":{"status":"string","id":"string"}}}}}},"401":{"description":"Returns an error message if the request is not authorized."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"\n\n\nRequires BASIC [16] user permissions. See Permissions.
","operationId":"container-security-jobs-list-jobs","deprecated":true,"tags":["Jobs"],"responses":{"200":{"description":"Returns an array of the statuses of all active jobs.","content":{"application/json":{"schema":{},"examples":{"response":{"value":[{"container_id":"string","job_id":"string","error":"string","job_status":"string","created_at":"string","updated_at":"string"}]}}}}},"401":{"description":"Returns an error message if the request is not authorized."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"\n\n\nRequires BASIC [16] user permissions. See Permissions.
","operationId":"container-security-jobs-job-status","deprecated":true,"tags":["Jobs"],"parameters":[{"description":"The ID of the job for which you want the status.","required":true,"name":"job_id","in":"query","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns the status of the job you specified.","content":{"application/json":{"schema":{"type":"object","properties":{"container_id":{"type":"string"},"job_id":{"type":"string"},"error":{"type":"string"},"job_status":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}}},"examples":{"response":{"value":{"container_id":"string","job_id":"string","error":"string","job_status":"string","created_at":"string","updated_at":"string"}}}}}},"401":{"description":"Returns an error message if the request is not authorized."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"\n\n\nRequires BASIC [16] user permissions. See Permissions.
","operationId":"container-security-jobs-job-status-by-image-id","deprecated":true,"tags":["Jobs"],"parameters":[{"description":"The ID of the image for which you want the status.","required":true,"name":"image_id","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns the status of the job you specified.","content":{"application/json":{"schema":{"type":"object","properties":{"container_id":{"type":"string"},"job_id":{"type":"string"},"error":{"type":"string"},"job_status":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}}},"examples":{"response":{"value":{"container_id":"string","job_id":"string","error":"string","job_status":"string","created_at":"string","updated_at":"string"}}}}}},"401":{"description":"Returns an error message if the request is not authorized."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"\n\n\nRequires BASIC [16] user permissions. See Permissions.
","operationId":"container-security-jobs-job-status-by-image-digest","deprecated":true,"tags":["Jobs"],"parameters":[{"description":"The image digest of the job for which you want the status.","required":true,"name":"image_digest","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns the status of the job you specified.","content":{"application/json":{"schema":{"type":"object","properties":{"container_id":{"type":"string"},"job_id":{"type":"string"},"error":{"type":"string"},"job_status":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}}},"examples":{"response":{"value":{"container_id":"string","job_id":"string","error":"string","job_status":"string","created_at":"string","updated_at":"string"}}}}}},"401":{"description":"Returns an error message if the request is not authorized."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"\n\n\nRequires BASIC [16] user permissions. See Permissions.
","operationId":"container-security-policy-policy-compliance-by-id","deprecated":true,"tags":["Policy"],"parameters":[{"description":"The ID of the image that you want to check for policy compliance.","required":true,"name":"image_id","in":"query","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns an array of compliance results.","content":{"application/json":{"schema":{},"examples":{"response":{"value":[{"status":"string","message":"string","reason":"string"}]}}}}},"401":{"description":"Returns an error message if the request is not authorized."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"\n\n\nRequires BASIC [16] user permissions. See Permissions.
","operationId":"container-security-policy-policy-compliance-by-name","deprecated":true,"tags":["Policy"],"parameters":[{"description":"The name of the image for which you want the job status.","required":true,"name":"image","in":"query","schema":{"type":"string"}},{"description":"The name of the repository that hosts the image. By default, this value is library.","required":false,"name":"repo","in":"query","schema":{"type":"string"}},{"description":"The tag for the image that you want to check for policy compliance.","required":false,"name":"tag","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns an array compliance results.","content":{"application/json":{"schema":{},"examples":{"response":{"value":[{"status":"string","message":"string","reason":"string"}]}}}}},"401":{"description":"Returns an error message if the request is not authorized."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"\n\n\nRequires BASIC [16] user permissions. See Permissions.
","operationId":"container-security-reports-report-by-container-id","deprecated":true,"tags":["Reports"],"parameters":[{"description":"The ID of the container for which you want a report.","required":true,"name":"container_id","in":"query","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns the report for the container you specified.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"image_name":{"type":"string"},"docker_image_id":{"type":"string"},"tag":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"platform":{"type":"string"},"findings":{"type":"array","items":{"type":"object"}},"malware":{"type":"array","items":{"type":"object"}},"potentially_unwanted_programs":{"type":"array","items":{"type":"object"}},"sha256":{"type":"string"},"os":{"type":"string"},"os_version":{"type":"string"},"os_architecture":{"type":"string"},"os_release_name":{"type":"string"},"installed_packages":{"type":"array","items":{"type":"object"}},"risk_score":{"type":"integer","format":"int32"},"digest":{"type":"string"}}},"examples":{"response":{"value":{"id":"string","image_name":"string","docker_image_id":"string","tag":"string","created_at":"string","updated_at":"string","platform":"string","findings":[{"nvdFinding":{"reference_id":"string","cve":"string","published_date":"string","modified_date":"string","description":"string","cvss_score":"string","access_vector":"string","access_complexity":"string","auth":"string","availability_impact":"string","confidentiality_impact":"string","integrity_impact":"string","cwe":"string","cpe":["string"],"remediation":"string","references":["string"]},"packages":[{"name":"string","version":"string","release":"string","epoch":"string","rawString":"string"}]}],"malware":[{"infectedFile":"string","fileTypeDescriptor":"string","md5":"string","sha256":"string"}],"potentially_unwanted_programs":[{"file":"string","md5":"string","sha256":"string"}],"sha256":"string","os":"string","os_version":"string","os_architecture":"string","os_release_name":"string","installed_packages":[{"name":"string","version":"string","release":"string","epoch":"string","rawString":"string"}],"risk_score":0,"digest":"string"}}}}}},"401":{"description":"Returns an error message if the request is not authorized."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"\n\n\nRequires BASIC [16] user permissions. See Permissions.
","operationId":"container-security-reports-report-by-image-id","deprecated":true,"tags":["Reports"],"parameters":[{"description":"The ID of the image for which you want a report.","required":true,"name":"image_id","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns the report for the image you specified.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"image_name":{"type":"string"},"docker_image_id":{"type":"string"},"tag":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"platform":{"type":"string"},"findings":{"type":"array","items":{"type":"object"}},"malware":{"type":"array","items":{"type":"object"}},"potentially_unwanted_programs":{"type":"array","items":{"type":"object"}},"sha256":{"type":"string"},"os":{"type":"string"},"os_version":{"type":"string"},"os_architecture":{"type":"string"},"os_release_name":{"type":"string"},"installed_packages":{"type":"array","items":{"type":"object"}},"risk_score":{"type":"integer","format":"int32"},"digest":{"type":"string"}}},"examples":{"response":{"value":{"id":"string","image_name":"string","docker_image_id":"string","tag":"string","created_at":"string","updated_at":"string","platform":"string","findings":[{"nvdFinding":{"cve":"string","published_date":"string","modified_date":"string","description":"string","cvss_score":"string","access_vector":"string","access_complexity":"string","auth":"string","availability_impact":"string","confidentiality_impact":"string","integrity_impact":"string","cwe":"string","cpe":["string"],"remediation":"string","references":["string"]},"packages":[{"name":"string","version":"string","release":"string","epoch":"string","rawString":"string"}]}],"malware":[{"infectedFile":"string","fileTypeDescriptor":"string","md5":"string","sha256":"string"}],"potentially_unwanted_programs":[{"file":"string","md5":"string","sha256":"string"}],"sha256":"string","os":"string","os_version":"string","os_architecture":"string","os_release_name":"string","installed_packages":[{"name":"string","version":"string","type":"string","license":"string"}],"risk_score":0,"digest":"string"}}}}}},"401":{"description":"Returns an error message if the request is not authorized."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"\n\n\nRequires BASIC [16] user permissions. See Permissions.
","operationId":"container-security-reports-report-by-image-digest","deprecated":true,"tags":["Reports"],"parameters":[{"description":"The image digest of the image for which you want a report.","required":true,"name":"image_digest","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns the report for the image you specified.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"image_name":{"type":"string"},"docker_image_id":{"type":"string"},"tag":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"platform":{"type":"string"},"findings":{"type":"array","items":{"type":"object"}},"malware":{"type":"array","items":{"type":"object"}},"potentially_unwanted_programs":{"type":"array","items":{"type":"object"}},"sha256":{"type":"string"},"os":{"type":"string"},"os_version":{"type":"string"},"os_architecture":{"type":"string"},"os_release_name":{"type":"string"},"installed_packages":{"type":"array","items":{"type":"object"}},"risk_score":{"type":"integer","format":"int32"},"digest":{"type":"string"}}},"examples":{"response":{"value":{"id":"string","image_name":"string","docker_image_id":"string","tag":"string","created_at":"string","updated_at":"string","platform":"string","findings":[{"nvdFinding":{"reference_id":"string","cve":"string","published_date":"string","modified_date":"string","description":"string","cvss_score":"string","access_vector":"string","access_complexity":"string","auth":"string","availability_impact":"string","confidentiality_impact":"string","integrity_impact":"string","cwe":"string","cpe":["string"],"remediation":"string","references":["string"]},"packages":[{"name":"string","version":"string","release":"string","epoch":"string","rawString":"string"}]}],"malware":[{"infectedFile":"string","fileTypeDescriptor":"string","md5":"string","sha256":"string"}],"potentially_unwanted_programs":[{"file":"string","md5":"string","sha256":"string"}],"sha256":"string","os":"string","os_version":"string","os_architecture":"string","os_release_name":"string","installed_packages":[{"name":"string","version":"string","release":"string","epoch":"string","rawString":"string"}],"risk_score":0,"digest":"string"}}}}}},"401":{"description":"Returns an error message if the request is not authorized."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"\n\n\nRequires BASIC [16] user permissions. See Permissions.
","operationId":"container-security-reports-nessus-report-by-container-id","deprecated":true,"tags":["Reports"],"parameters":[{"description":"The ID of the container for which you want a report.","required":true,"name":"id","in":"query","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns the Nessus report for the container you specified.","content":{"application/json":{"schema":{},"examples":{"response":{"value":{"To do":"Add response sample here"}}}}}},"401":{"description":"Returns an error message if the request is not authorized."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"\n\n\nRequires BASIC [16] user permissions. See Permissions.
","operationId":"container-security-repositories-list-repositories","deprecated":true,"tags":["Repositories"],"parameters":[{"description":"The number of items Tenable.io Container Security skips before starting to collect the result set.","required":false,"name":"offset","in":"query","schema":{"type":"integer","format":"int32"}},{"description":"The maximum number of items to return.","required":false,"name":"limit","in":"query","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns an array of repositories.","content":{"application/json":{"schema":{"type":"object","properties":{"offset":{"type":"integer"},"limit":{"type":"integer"},"total":{"type":"integer"},"items":{"type":"array","items":{"type":"object"}}}},"examples":{"response":{"value":{"offset":"integer","limit":"integer","total":"integer","items":[{"name":"string","description":"string","pullCount":"integer","pushCount":"integer"}]}}}}}},"401":{"description":"Returns an error message if the request is not authorized."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"\n\n\nRequires BASIC [16] user permissions. See Permissions.
","operationId":"container-security-repositories-list-images","deprecated":true,"tags":["Repositories"],"parameters":[{"description":"The ID of the relevant repository.","required":true,"name":"id","in":"path","schema":{"type":"integer","format":"int32"}},{"description":"The number of items to skip before Tenable.io Container Security starts to collect the result set.","required":false,"name":"offset","in":"query","schema":{"type":"integer","format":"int32"}},{"description":"The maximum number of items to return.","required":false,"name":"limit","in":"query","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns an array of images.","content":{"application/json":{"schema":{"type":"object","properties":{"offset":{"type":"integer"},"limit":{"type":"integer"},"total":{"type":"integer"},"items":{"type":"array","items":{"type":"object"}}}},"examples":{"response":{"value":{"offset":"integer","limit":"integer","total":"integer","items":[{"id":"string","repoId":"string","name":"string","tag":"string","digest":"string","hasReport":"boolean","hasInventory":"boolean","status":"string","score":"integer","numberOfVulns":"integer","numberOfMalware":"integer","pullCount":"string","pushCount":"string","source":"string","createdAt":"string","updatedAt":"string","finishedAt":"string","imageHash":"string","size":"string","layers":["string"]}]}}}}}},"401":{"description":"Returns an error message if the request is not authorized."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"\n\n\n