Jump to Content

Guides API Reference Changelog Discussions

v0.1

v0.1Guides API Reference Changelog Discussions

On-Premises File

/sbom_builders
- Get All On-Premises Filesget
/sbom_builder/upload_url
- Get URL to Upload On-Premises Filepost
/sbom_builder/upload_success
- Upload Success Callbackput
/sbom_builder/{id}
/sbom_builder/import/{id}
- Import File from Deepbits Public SBOM Builder Toolpost
/sbom_builder/import_popular/{id}
- Import File from Deepbits Public SBOM Builder Tool Examples Listpost

On-Premises Docker Image

/containers
/containers/{id}/get_upload_url
- Get URL to Upload Docker Imageget
/containers/{id}/upload_success
- Upload Success Callbackput
/containers/{id}
- Get On-Premises Image Detailget
/containers/{id}/scan
- Rescan On-Premises Image Detailpost

Regulation and policy

/license
- Get supported licensesget
/license/{id}
- Get license detailsget
/policies
- Get policiesget
/policy_resources
- Get policie resourcesget
/policy_condition_options
- Get policie resourcesget
/policie
- Create policypost
/policy/{id}
- Update policyput
- Delete policydelete

Docker Hub Integration

/dockerhubga
- Add public Docker Hub imagepost
/dockerhub/account
/dockerhub
- Refresh Docker Hub account repos changesput
/dockerhub/repo
- Refesh repo changesput
/dockerhub/repos
- Get all Docker Hub reposget
/dockerhub/{repoId}
- Delete a public Docker Hub repo that is not under the linked Docker Hub accountdelete
/dockerhub/{repoId}/tags
- Get all tags of a Docker Hub repoget
/dockerhub/{repoId}/watch
- Watch / un-watch a Docker Hub tagput
/dockerhub/{repoId}/{tagId}
- Get details of a Docker Hub tagget
/dockerhub/{repoId}/{tagId}/scan
- Scan a Docker Hub tagput

Malware Detection API

/malware/upload_url
- Get S3 upload URL for a malware filepost
/malware/upload_success
- Upload Successful Malware Dataput
/malware/hash/{sha}
- Get malware scan result by hashget
/malware/detail/{id}
- Get malware scan result by malware idget
- Scan a malware by idput
/malware/detail/{id}/functions
- Get malware function details.get
/malware/detail/{id}/functions/{address}/{sha256}
- Get detailed information about a function of a malware file.get
/malware/detail/{id}/functions/{address}/{sha256}/compare
- Compare function of a malware file with anotherget

Malware Dump API

/mdump
- Get all memory dumpsget
/mdump/upload_url
- Get S3 upload URL for a memory dump filepost
/mdump/upload_success
- Upload successful hook for memory dumpput
/mdump/detail/{id}
- Get memory dump scan result by memory dump idget
- Scan a memory dump by idput

GitHub Integration

/user
- Get user dataget
/github/repos/add
- Add github repository to deepbitspost
/project/{projectId}
- Add github repositories to deepbits public toolput
/github/account
- Get shared github accountsget
/github/{accountId}/{owner}/{repository}
- Get github repository details with project asset settingsget
/github/{accountId}/repos/{githubRepoId}/branch
- Get github repository branchesget
/project/{projectId}/{projectAssetId}/stream_watch
- Watch github branchput
/github/{accountId}/repos/{owner}/{repository}/branch/{branchName}
- Get github branch scan detailsget
/project/{projectId}/{assetId}/{streamId}/scan_result
- Get stream scan resultget

Powered by

On-Premises File

/sbom_builders
- Get All On-Premises Filesget
/sbom_builder/upload_url
- Get URL to Upload On-Premises Filepost
/sbom_builder/upload_success
- Upload Success Callbackput
/sbom_builder/{id}
/sbom_builder/import/{id}
- Import File from Deepbits Public SBOM Builder Toolpost
/sbom_builder/import_popular/{id}
- Import File from Deepbits Public SBOM Builder Tool Examples Listpost

On-Premises Docker Image

/containers
/containers/{id}/get_upload_url
- Get URL to Upload Docker Imageget
/containers/{id}/upload_success
- Upload Success Callbackput
/containers/{id}
- Get On-Premises Image Detailget
/containers/{id}/scan
- Rescan On-Premises Image Detailpost

Regulation and policy

/license
- Get supported licensesget
/license/{id}
- Get license detailsget
/policies
- Get policiesget
/policy_resources
- Get policie resourcesget
/policy_condition_options
- Get policie resourcesget
/policie
- Create policypost
/policy/{id}
- Update policyput
- Delete policydelete

Docker Hub Integration

/dockerhubga
- Add public Docker Hub imagepost
/dockerhub/account
/dockerhub
- Refresh Docker Hub account repos changesput
/dockerhub/repo
- Refesh repo changesput
/dockerhub/repos
- Get all Docker Hub reposget
/dockerhub/{repoId}
- Delete a public Docker Hub repo that is not under the linked Docker Hub accountdelete
/dockerhub/{repoId}/tags
- Get all tags of a Docker Hub repoget
/dockerhub/{repoId}/watch
- Watch / un-watch a Docker Hub tagput
/dockerhub/{repoId}/{tagId}
- Get details of a Docker Hub tagget
/dockerhub/{repoId}/{tagId}/scan
- Scan a Docker Hub tagput

Malware Detection API

/malware/upload_url
- Get S3 upload URL for a malware filepost
/malware/upload_success
- Upload Successful Malware Dataput
/malware/hash/{sha}
- Get malware scan result by hashget
/malware/detail/{id}
- Get malware scan result by malware idget
- Scan a malware by idput
/malware/detail/{id}/functions
- Get malware function details.get
/malware/detail/{id}/functions/{address}/{sha256}
- Get detailed information about a function of a malware file.get
/malware/detail/{id}/functions/{address}/{sha256}/compare
- Compare function of a malware file with anotherget

Malware Dump API

/mdump
- Get all memory dumpsget
/mdump/upload_url
- Get S3 upload URL for a memory dump filepost
/mdump/upload_success
- Upload successful hook for memory dumpput
/mdump/detail/{id}
- Get memory dump scan result by memory dump idget
- Scan a memory dump by idput

GitHub Integration

/user
- Get user dataget
/github/repos/add
- Add github repository to deepbitspost
/project/{projectId}
- Add github repositories to deepbits public toolput
/github/account
- Get shared github accountsget
/github/{accountId}/{owner}/{repository}
- Get github repository details with project asset settingsget
/github/{accountId}/repos/{githubRepoId}/branch
- Get github repository branchesget
/project/{projectId}/{projectAssetId}/stream_watch
- Watch github branchput
/github/{accountId}/repos/{owner}/{repository}/branch/{branchName}
- Get github branch scan detailsget
/project/{projectId}/{assetId}/{streamId}/scan_result
- Get stream scan resultget

Powered by

Get supported licenses

get https://api.deepbits.com/api/v1/license

Get supported licenses

Language

Authorization

Header

Click Try It! to start a request and see the response here!