CLI Reference
This page provides documentation for the command line tool dojo.
uv tool install defectdojo-cli
dojo
DefectDojo CLI
Usage:
dojo [OPTIONS] COMMAND [ARGS]...
Options:
--config PATH Path to the configuration file [default:
(/home/docs/.config/defectdojo-generated-
api/config.toml)]
-e, --env TEXT Environment to use for the command (as many can be
specified in config.toml)
-h, --host TEXT DefectDojo server host [env var: DEFECTDOJO_HOST]
-t, --token TEXT DefectDojo API token - if provided, --user/--password
are ignored [env var: DEFECTDOJO_TOKEN]
-u, --user TEXT DefectDojo API username [env var: DEFECTDOJO_USER]
-p, --password TEXT DefectDojo API password [env var: DEFECTDOJO_PASSWORD]
--disable-tls Disable TLS verification in DefectDojo API requests
--debug-http Log HTTP requests and responses
--version Show the version and exit.
--help Show this message and exit.
Subcommands
- api: Interact directly with any API/method
- config: Show or edit the current CLI configuration
- status: Quick connectivity check
dojo api
Interact directly with any API/method
Usage:
dojo api [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
- announcements: methods from
AnnouncementsApi. - api-token-auth: create
- asset-api-scan-configurations: methods from
AssetApiScanConfigurationsApi. - asset-groups: methods from
AssetGroupsApi. - asset-members: methods from
AssetMembersApi. - assets: methods from
AssetsApi. - celery: methods from
CeleryApi. - configuration-permissions: methods from
ConfigurationPermissionsApi. - credential-mappings: methods from
CredentialMappingsApi. - credentials: methods from
CredentialsApi. - development-environments: methods from
DevelopmentEnvironmentsApi. - dojo-group-members: methods from
DojoGroupMembersApi. - dojo-groups: methods from
DojoGroupsApi. - endpoint-meta-import: create
- endpoint-status: methods from
EndpointStatusApi. - endpoints: methods from
EndpointsApi. - engagement-presets: methods from
EngagementPresetsApi. - engagements: methods from
EngagementsApi. - finding-templates: methods from
FindingTemplatesApi. - findings: methods from
FindingsApi. - global-roles: methods from
GlobalRolesApi. - import-languages: create
- import-scan: create
- jira-configurations: methods from
JiraConfigurationsApi. - jira-finding-mappings: methods from
JiraFindingMappingsApi. - jira-instances: methods from
JiraInstancesApi. - jira-product-configurations: methods from
JiraProductConfigurationsApi. - jira-projects: methods from
JiraProjectsApi. - language-types: methods from
LanguageTypesApi. - languages: methods from
LanguagesApi. - metadata: methods from
MetadataApi. - network-locations: methods from
NetworkLocationsApi. - note-type: methods from
NoteTypeApi. - notes: methods from
NotesApi. - notification-webhooks: methods from
NotificationWebhooksApi. - notifications: methods from
NotificationsApi. - oa3: schema_retrieve
- organization-groups: methods from
OrganizationGroupsApi. - organization-members: methods from
OrganizationMembersApi. - organizations: methods from
OrganizationsApi. - product-api-scan-configurations: methods from
ProductApiScanConfigurationsApi. - product-groups: methods from
ProductGroupsApi. - product-members: methods from
ProductMembersApi. - product-type-groups: methods from
ProductTypeGroupsApi. - product-type-members: methods from
ProductTypeMembersApi. - product-types: methods from
ProductTypesApi. - products: methods from
ProductsApi. - questionnaire-answered-questionnaires: methods from
QuestionnaireAnsweredQuestionnairesApi. - questionnaire-answers: methods from
QuestionnaireAnswersApi. - questionnaire-engagement-questionnaires: methods from
QuestionnaireEngagementQuestionnairesApi. - questionnaire-general-questionnaires: methods from
QuestionnaireGeneralQuestionnairesApi. - questionnaire-questions: methods from
QuestionnaireQuestionsApi. - regulations: methods from
RegulationsApi. - reimport-scan: create
- request-response-pairs: methods from
RequestResponsePairsApi. - risk-acceptance: methods from
RiskAcceptanceApi. - roles: methods from
RolesApi. - sla-configurations: methods from
SlaConfigurationsApi. - sonarqube-issues: methods from
SonarqubeIssuesApi. - sonarqube-transitions: methods from
SonarqubeTransitionsApi. - stub-findings: methods from
StubFindingsApi. - system-settings: methods from
SystemSettingsApi. - technologies: methods from
TechnologiesApi. - test-imports: methods from
TestImportsApi. - test-types: methods from
TestTypesApi. - tests: methods from
TestsApi. - tool-configurations: methods from
ToolConfigurationsApi. - tool-product-settings: methods from
ToolProductSettingsApi. - tool-types: methods from
ToolTypesApi. - user-contact-infos: methods from
UserContactInfosApi. - user-profile: retrieve
- users: methods from
UsersApi.
dojo api announcements
methods from AnnouncementsApi.
Usage:
dojo api announcements [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
- create: create
- delete-preview-list: delete_preview_list
- destroy: destroy
- list: list
- partial-update: partial_update
- retrieve: retrieve
- update: update
dojo api announcements create
create
Usage:
dojo api announcements create [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--message TEXT This dismissable message will be displayed on all pages for
authenticated users. It can contain basic html tags, for
example <a href='https://www.fred.com' style='color:
#337ab7;' target='_blank'>https://example.com</a>
--style TEXT The style of banner to display. (info, success, warning,
danger) * `info` - Info * `success` - Success * `warning` -
Warning * `danger` - Danger
--dismissable Ticking this box allows users to dismiss the current
announcement
--help Show this message and exit.
dojo api announcements delete-preview-list
delete_preview_list
Usage:
dojo api announcements delete-preview-list [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
announcement. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api announcements destroy
destroy
Usage:
dojo api announcements destroy [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this announcement.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api announcements list
list
Usage:
dojo api announcements list [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--dismissable
--limit INTEGER Number of results to return per page.
--message TEXT
--offset INTEGER The initial index from which to return the
results.
--style TEXT The style of banner to display. (info,
success, warning, danger) * `info` - Info *
`success` - Success * `warning` - Warning *
`danger` - Danger
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api announcements partial-update
partial_update
Usage:
dojo api announcements partial-update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
announcement. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--patched-announcement-request TEXT
--help Show this message and exit.
dojo api announcements retrieve
retrieve
Usage:
dojo api announcements retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this announcement.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api announcements update
update
Usage:
dojo api announcements update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
announcement. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--announcement-request TEXT
--help Show this message and exit.
dojo api api-token-auth
create
Usage:
dojo api api-token-auth [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--username TEXT
--password TEXT
--help Show this message and exit.
dojo api asset-api-scan-configurations
methods from AssetApiScanConfigurationsApi.
Usage:
dojo api asset-api-scan-configurations [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
- create: create
- delete-preview-list: delete_preview_list
- destroy: destroy
- list: list
- partial-update: partial_update
- retrieve: retrieve
- update: update
dojo api asset-api-scan-configurations create
create
Usage:
dojo api asset-api-scan-configurations create [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--asset INTEGER
--service-key-1 TEXT
--service-key-2 TEXT
--service-key-3 TEXT
--tool-configuration INTEGER
--help Show this message and exit.
dojo api asset-api-scan-configurations delete-preview-list
delete_preview_list
Usage:
dojo api asset-api-scan-configurations delete-preview-list
[OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
product_ap i_ scan_ configuration.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api asset-api-scan-configurations destroy
destroy
Usage:
dojo api asset-api-scan-configurations destroy [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this product_ap i_ scan_
configuration. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api asset-api-scan-configurations list
list
Usage:
dojo api asset-api-scan-configurations list [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--asset INTEGER
--id INTEGER
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
--prefetch TEXT List of fields for which to prefetch model
instances and add those to the response
--service-key-1 TEXT
--service-key-2 TEXT
--service-key-3 TEXT
--tool-configuration INTEGER
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api asset-api-scan-configurations partial-update
partial_update
Usage:
dojo api asset-api-scan-configurations partial-update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
product_ap i_ scan_ configuration.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--patched-asset-api-scan-configuration-request TEXT
--help Show this message and exit.
dojo api asset-api-scan-configurations retrieve
retrieve
Usage:
dojo api asset-api-scan-configurations retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this product_ap i_ scan_
configuration. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--prefetch TEXT List of fields for which to prefetch model instances and
add those to the response
--help Show this message and exit.
dojo api asset-api-scan-configurations update
update
Usage:
dojo api asset-api-scan-configurations update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
product_ap i_ scan_ configuration.
[required]
--asset-api-scan-configuration-request TEXT
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--help Show this message and exit.
dojo api asset-groups
methods from AssetGroupsApi.
Usage:
dojo api asset-groups [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
- create: create
- delete-preview-list: delete_preview_list
- destroy: destroy
- list: list
- retrieve: retrieve
- update: update
dojo api asset-groups create
create
Usage:
dojo api asset-groups create [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--asset INTEGER
--group INTEGER
--role INTEGER
--help Show this message and exit.
dojo api asset-groups delete-preview-list
delete_preview_list
Usage:
dojo api asset-groups delete-preview-list [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
product_ group. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api asset-groups destroy
destroy
Usage:
dojo api asset-groups destroy [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this product_ group.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api asset-groups list
list
Usage:
dojo api asset-groups list [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--asset-id FLOAT
--group-id INTEGER
--id INTEGER
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
--prefetch TEXT List of fields for which to prefetch model
instances and add those to the response
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api asset-groups retrieve
retrieve
Usage:
dojo api asset-groups retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this product_ group.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--prefetch TEXT List of fields for which to prefetch model instances and
add those to the response
--help Show this message and exit.
dojo api asset-groups update
update
Usage:
dojo api asset-groups update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this product_
group. [required]
--asset-group-request TEXT [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--help Show this message and exit.
dojo api asset-members
methods from AssetMembersApi.
Usage:
dojo api asset-members [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
- create: create
- delete-preview-list: delete_preview_list
- destroy: destroy
- list: list
- retrieve: retrieve
- update: update
dojo api asset-members create
create
Usage:
dojo api asset-members create [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--asset INTEGER
--user INTEGER
--role INTEGER
--help Show this message and exit.
dojo api asset-members delete-preview-list
delete_preview_list
Usage:
dojo api asset-members delete-preview-list [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
product_ member. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api asset-members destroy
destroy
Usage:
dojo api asset-members destroy [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this product_ member.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api asset-members list
list
Usage:
dojo api asset-members list [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--asset-id FLOAT
--id INTEGER
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
--prefetch TEXT List of fields for which to prefetch model
instances and add those to the response
--user-id INTEGER
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api asset-members retrieve
retrieve
Usage:
dojo api asset-members retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this product_ member.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--prefetch TEXT List of fields for which to prefetch model instances and
add those to the response
--help Show this message and exit.
dojo api asset-members update
update
Usage:
dojo api asset-members update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
product_ member. [required]
--asset-member-request TEXT [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--help Show this message and exit.
dojo api assets
methods from AssetsApi.
Usage:
dojo api assets [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
- create: create
- delete-preview-list: delete_preview_list
- destroy: destroy
- generate-report-create: generate_report_create
- list: list
- partial-update: partial_update
- retrieve: retrieve
- update: update
dojo api assets create
create
Usage:
dojo api assets create [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--tags TEXT
--organization INTEGER
--asset-numeric-grade INTEGER
--enable-asset-tag-inheritance
--asset-managers INTEGER
--business-criticality TEXT * `very high` - Very High * `high` - High *
`medium` - Medium * `low` - Low * `very low`
- Very Low * `none` - None
--platform TEXT * `web service` - API * `desktop` - Desktop
* `iot` - Internet of Things * `mobile` -
Mobile * `web` - Web
--lifecycle TEXT * `construction` - Construction *
`production` - Production * `retirement` -
Retirement
--origin TEXT * `third party library` - Third Party
Library * `purchased` - Purchased *
`contractor` - Contractor Developed *
`internal` - Internally Developed * `open
source` - Open Source * `outsourced` -
Outsourced
--name TEXT
--description TEXT
--user-records INTEGER Estimate the number of user records within
the application.
--revenue TEXT Estimate the application's revenue.
--external-audience Specify if the application is used by people
outside the organization.
--internet-accessible Specify if the application is accessible
from the public internet.
--enable-simple-risk-acceptance
Allows simple risk acceptance by
checking/unchecking a checkbox.
--enable-full-risk-acceptance Allows full risk acceptance using a risk
acceptance form, expiration date, uploaded
proof, etc.
--disable-sla-breach-notifications
Disable SLA breach notifications if
configured in the global settings
--technical-contact INTEGER
--team-manager INTEGER
--sla-configuration INTEGER
--regulations INTEGER
--help Show this message and exit.
dojo api assets delete-preview-list
delete_preview_list
Usage:
dojo api assets delete-preview-list [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
product. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api assets destroy
destroy
Usage:
dojo api assets destroy [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this product. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api assets generate-report-create
generate_report_create
Usage:
dojo api assets generate-report-create [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
product. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--report-generate-option-request TEXT
--help Show this message and exit.
dojo api assets list
list
Usage:
dojo api assets list [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--asset-manager INTEGER Multiple values may be separated by commas.
--asset-numeric-grade INTEGER Multiple values may be separated by commas.
--business-criticality TEXT * `very high` - Very High * `high` - High *
`medium` - Medium * `low` - Low * `very low`
- Very Low * `none` - None
--created DATETIME Time that the object was initially created,
and saved to the database * `None` - Any
date * `1` - Today * `2` - Past 7 days * `3`
- Past 30 days * `4` - Past 90 days * `5` -
Current month * `6` - Current year * `7` -
Past year
--description TEXT
--external-audience
--has-tags Has tags
--id INTEGER Multiple values may be separated by commas.
--internet-accessible
--lifecycle TEXT * `construction` - Construction *
`production` - Production * `retirement` -
Retirement
--limit INTEGER Number of results to return per page.
--name TEXT
--name-exact TEXT
--not-tag TEXT Not Tag name contains
--not-tags TEXT Comma separated list of exact tags not
present on Product
-o TEXT Ordering * `id` - Id * `-id` - Id
(descending) * `tid` - Tid * `-tid` - Tid
(descending) * `name` - Name * `-name` -
Name (descending) * `created` - Created *
`-created` - Created (descending) *
`asset_numeric_grade` - Asset numeric grade
* `-asset_numeric_grade` - Asset numeric
grade (descending) * `business_criticality`
- Business criticality *
`-business_criticality` - Business
criticality (descending) * `platform` -
Platform * `-platform` - Platform
(descending) * `lifecycle` - Lifecycle *
`-lifecycle` - Lifecycle (descending) *
`origin` - Origin * `-origin` - Origin
(descending) * `revenue` - Revenue *
`-revenue` - Revenue (descending) *
`external_audience` - External audience *
`-external_audience` - External audience
(descending) * `internet_accessible` -
Internet accessible * `-internet_accessible`
- Internet accessible (descending) *
`asset_manager` - Asset manager *
`-asset_manager` - Asset manager
(descending) * `asset_manager__first_name` -
Asset manager first name *
`-asset_manager__first_name` - Asset manager
first name (descending) *
`asset_manager__last_name` - Asset manager
last name * `-asset_manager__last_name` -
Asset manager last name (descending) *
`technical_contact` - Technical contact *
`-technical_contact` - Technical contact
(descending) *
`technical_contact__first_name` - Technical
contact first name *
`-technical_contact__first_name` - Technical
contact first name (descending) *
`technical_contact__last_name` - Technical
contact last name *
`-technical_contact__last_name` - Technical
contact last name (descending) *
`team_manager` - Team manager *
`-team_manager` - Team manager (descending)
* `team_manager__first_name` - Team manager
first name * `-team_manager__first_name` -
Team manager first name (descending) *
`team_manager__last_name` - Team manager
last name * `-team_manager__last_name` -
Team manager last name (descending) *
`organization` - Organization *
`-organization` - Organization (descending)
* `organization__name` - Organization name
* `-organization__name` - Organization name
(descending) * `updated` - Updated *
`-updated` - Updated (descending) *
`user_records` - User records *
`-user_records` - User records (descending)
--offset INTEGER The initial index from which to return the
results.
--organization INTEGER Multiple values may be separated by commas.
--origin TEXT * `third party library` - Third Party
Library * `purchased` - Purchased *
`contractor` - Contractor Developed *
`internal` - Internally Developed * `open
source` - Open Source * `outsourced` -
Outsourced
--outside-of-sla FLOAT
--platform TEXT * `web service` - API * `desktop` - Desktop
* `iot` - Internet of Things * `mobile` -
Mobile * `web` - Web
--prefetch TEXT List of fields for which to prefetch model
instances and add those to the response
--regulations INTEGER Multiple values may be separated by commas.
--revenue FLOAT
--tag TEXT Tag name contains
--tags TEXT Comma separated list of exact tags (uses OR
for multiple values)
--tags--and TEXT Comma separated list of exact tags to match
with an AND expression
--team-manager INTEGER Multiple values may be separated by commas.
--technical-contact INTEGER Multiple values may be separated by commas.
--tid INTEGER Multiple values may be separated by commas.
--updated DATETIME Time that the object was most recently saved
to the database * `None` - Any date * `1` -
Today * `2` - Past 7 days * `3` - Past 30
days * `4` - Past 90 days * `5` - Current
month * `6` - Current year * `7` - Past year
--user-records INTEGER Multiple values may be separated by commas.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api assets partial-update
partial_update
Usage:
dojo api assets partial-update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
product. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--patched-asset-request TEXT
--help Show this message and exit.
dojo api assets retrieve
retrieve
Usage:
dojo api assets retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this product.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--prefetch TEXT List of fields for which to prefetch model instances and
add those to the response
--help Show this message and exit.
dojo api assets update
update
Usage:
dojo api assets update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this product.
[required]
--asset-request TEXT [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api celery
methods from CeleryApi.
Usage:
dojo api celery [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
- queue-details-list: Get per-task breakdown of the Celery queue
- queue-purge-create: Purge all pending Celery tasks from the queue
- queue-task-purge-create: Purge all queued tasks with a given task name
- status-retrieve: Get Celery worker and queue status
dojo api celery queue-details-list
Get per-task breakdown of the Celery queue
Usage:
dojo api celery queue-details-list [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api celery queue-purge-create
Purge all pending Celery tasks from the queue
Usage:
dojo api celery queue-purge-create [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api celery queue-task-purge-create
Purge all queued tasks with a given task name
Usage:
dojo api celery queue-task-purge-create [OPTIONS]
Options:
--task-name TEXT [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api celery status-retrieve
Get Celery worker and queue status
Usage:
dojo api celery status-retrieve [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api configuration-permissions
methods from ConfigurationPermissionsApi.
Usage:
dojo api configuration-permissions [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
dojo api configuration-permissions list
list
Usage:
dojo api configuration-permissions list [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--codename TEXT
--id INTEGER
--limit INTEGER Number of results to return per page.
--name TEXT
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api configuration-permissions retrieve
retrieve
Usage:
dojo api configuration-permissions retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this permission.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api credential-mappings
methods from CredentialMappingsApi.
Usage:
dojo api credential-mappings [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
- create: (Deprecated) create
- delete-preview-list: delete_preview_list
- destroy: (Deprecated) destroy
- list: (Deprecated) list
- partial-update: (Deprecated) partial_update
- retrieve: (Deprecated) retrieve
- update: (Deprecated) update
dojo api credential-mappings create
(Deprecated) create
Usage:
dojo api credential-mappings create [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--is-authn-provider
--url TEXT
--cred-id INTEGER
--product INTEGER
--finding INTEGER
--engagement INTEGER
--test INTEGER
--help Show this message and exit.
dojo api credential-mappings delete-preview-list
delete_preview_list
Usage:
dojo api credential-mappings delete-preview-list [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
cred_ mapping. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api credential-mappings destroy
(Deprecated) destroy
Usage:
dojo api credential-mappings destroy [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this cred_ mapping.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api credential-mappings list
(Deprecated) list
Usage:
dojo api credential-mappings list [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--cred-id INTEGER
--engagement INTEGER
--finding INTEGER
--is-authn-provider
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
--product INTEGER
--test INTEGER
--url TEXT
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api credential-mappings partial-update
(Deprecated) partial_update
Usage:
dojo api credential-mappings partial-update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
cred_ mapping. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--patched-credential-mapping-request TEXT
--help Show this message and exit.
dojo api credential-mappings retrieve
(Deprecated) retrieve
Usage:
dojo api credential-mappings retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this cred_ mapping.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api credential-mappings update
(Deprecated) update
Usage:
dojo api credential-mappings update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
cred_ mapping. [required]
--credential-mapping-request TEXT
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--help Show this message and exit.
dojo api credentials
methods from CredentialsApi.
Usage:
dojo api credentials [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
- create: (Deprecated) create
- delete-preview-list: delete_preview_list
- destroy: (Deprecated) destroy
- list: (Deprecated) list
- partial-update: (Deprecated) partial_update
- retrieve: (Deprecated) retrieve
- update: (Deprecated) update
dojo api credentials create
(Deprecated) create
Usage:
dojo api credentials create [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--name TEXT
--username TEXT
--role TEXT
--authentication TEXT * `Form` - Form Authentication * `SSO` - SSO
Redirect
--http-authentication TEXT * `Basic` - Basic * `NTLM` - NTLM
--description TEXT
--url TEXT
--login-regex TEXT
--logout-regex TEXT
--is-valid
--environment INTEGER
--help Show this message and exit.
dojo api credentials delete-preview-list
delete_preview_list
Usage:
dojo api credentials delete-preview-list [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
cred_ user. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api credentials destroy
(Deprecated) destroy
Usage:
dojo api credentials destroy [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this cred_ user.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api credentials list
(Deprecated) list
Usage:
dojo api credentials list [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
--prefetch TEXT List of fields for which to prefetch model
instances and add those to the response
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api credentials partial-update
(Deprecated) partial_update
Usage:
dojo api credentials partial-update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
cred_ user. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--patched-credential-request TEXT
--help Show this message and exit.
dojo api credentials retrieve
(Deprecated) retrieve
Usage:
dojo api credentials retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this cred_ user.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--prefetch TEXT List of fields for which to prefetch model instances and
add those to the response
--help Show this message and exit.
dojo api credentials update
(Deprecated) update
Usage:
dojo api credentials update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this cred_
user. [required]
--credential-request TEXT [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api development-environments
methods from DevelopmentEnvironmentsApi.
Usage:
dojo api development-environments [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
- create: create
- delete-preview-list: delete_preview_list
- destroy: destroy
- list: list
- partial-update: partial_update
- retrieve: retrieve
- update: update
dojo api development-environments create
create
Usage:
dojo api development-environments create [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--name TEXT
--help Show this message and exit.
dojo api development-environments delete-preview-list
delete_preview_list
Usage:
dojo api development-environments delete-preview-list [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
development_ environment. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api development-environments destroy
destroy
Usage:
dojo api development-environments destroy [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this development_
environment. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api development-environments list
list
Usage:
dojo api development-environments list [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api development-environments partial-update
partial_update
Usage:
dojo api development-environments partial-update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
development_ environment. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--patched-development-environment-request TEXT
--help Show this message and exit.
dojo api development-environments retrieve
retrieve
Usage:
dojo api development-environments retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this development_
environment. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api development-environments update
update
Usage:
dojo api development-environments update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
development_ environment. [required]
--development-environment-request TEXT
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--help Show this message and exit.
dojo api dojo-group-members
methods from DojoGroupMembersApi.
Usage:
dojo api dojo-group-members [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
- create: create
- delete-preview-list: delete_preview_list
- destroy: destroy
- list: list
- retrieve: retrieve
- update: update
dojo api dojo-group-members create
create
Usage:
dojo api dojo-group-members create [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--group INTEGER
--user INTEGER
--role INTEGER This role determines the permissions of the user to manage
the group.
--help Show this message and exit.
dojo api dojo-group-members delete-preview-list
delete_preview_list
Usage:
dojo api dojo-group-members delete-preview-list [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
dojo_ group_ member. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api dojo-group-members destroy
destroy
Usage:
dojo api dojo-group-members destroy [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this dojo_ group_ member.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api dojo-group-members list
list
Usage:
dojo api dojo-group-members list [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--group-id INTEGER
--id INTEGER
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
--prefetch TEXT List of fields for which to prefetch model
instances and add those to the response
--user-id INTEGER
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api dojo-group-members retrieve
retrieve
Usage:
dojo api dojo-group-members retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this dojo_ group_
member. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--prefetch TEXT List of fields for which to prefetch model instances and
add those to the response
--help Show this message and exit.
dojo api dojo-group-members update
update
Usage:
dojo api dojo-group-members update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
dojo_ group_ member. [required]
--dojo-group-member-request TEXT
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--help Show this message and exit.
dojo api dojo-groups
methods from DojoGroupsApi.
Usage:
dojo api dojo-groups [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
- create: create
- delete-preview-list: delete_preview_list
- destroy: destroy
- list: list
- partial-update: partial_update
- retrieve: retrieve
- update: update
dojo api dojo-groups create
create
Usage:
dojo api dojo-groups create [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--configuration-permissions INTEGER
--name TEXT
--description TEXT
--social-provider TEXT Group imported from a social provider. *
`AzureAD` - AzureAD * `Remote` - Remote
--help Show this message and exit.
dojo api dojo-groups delete-preview-list
delete_preview_list
Usage:
dojo api dojo-groups delete-preview-list [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
dojo_ group. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api dojo-groups destroy
destroy
Usage:
dojo api dojo-groups destroy [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this dojo_ group.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api dojo-groups list
list
Usage:
dojo api dojo-groups list [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--id INTEGER
--limit INTEGER Number of results to return per page.
--name TEXT
--offset INTEGER The initial index from which to return the
results.
--prefetch TEXT List of fields for which to prefetch model
instances and add those to the response
--social-provider TEXT Group imported from a social provider. *
`AzureAD` - AzureAD * `Remote` - Remote
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api dojo-groups partial-update
partial_update
Usage:
dojo api dojo-groups partial-update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
dojo_ group. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--patched-dojo-group-request TEXT
--help Show this message and exit.
dojo api dojo-groups retrieve
retrieve
Usage:
dojo api dojo-groups retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this dojo_ group.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--prefetch TEXT List of fields for which to prefetch model instances and
add those to the response
--help Show this message and exit.
dojo api dojo-groups update
update
Usage:
dojo api dojo-groups update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this dojo_
group. [required]
--dojo-group-request TEXT [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api endpoint-meta-import
create
Usage:
dojo api endpoint-meta-import [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--file PATH
--create-endpoints
--create-tags
--create-dojo-meta
--product-name TEXT
--product INTEGER
--help Show this message and exit.
dojo api endpoint-status
methods from EndpointStatusApi.
Usage:
dojo api endpoint-status [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
- create: create
- delete-preview-list: delete_preview_list
- destroy: destroy
- list: list
- partial-update: partial_update
- retrieve: retrieve
- update: update
dojo api endpoint-status create
create
Usage:
dojo api endpoint-status create [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--var-date DATE
--mitigated
--false-positive
--out-of-scope
--risk-accepted
--mitigated-by INTEGER
--endpoint INTEGER
--finding INTEGER
--help Show this message and exit.
dojo api endpoint-status delete-preview-list
delete_preview_list
Usage:
dojo api endpoint-status delete-preview-list [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
endpoint_ status. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api endpoint-status destroy
destroy
Usage:
dojo api endpoint-status destroy [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this endpoint_ status.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api endpoint-status list
list
Usage:
dojo api endpoint-status list [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--endpoint INTEGER
--false-positive
--finding INTEGER
--limit INTEGER Number of results to return per page.
--mitigated
--mitigated-by INTEGER
--offset INTEGER The initial index from which to return the
results.
--out-of-scope
--risk-accepted
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api endpoint-status partial-update
partial_update
Usage:
dojo api endpoint-status partial-update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
endpoint_ status. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--patched-endpoint-status-request TEXT
--help Show this message and exit.
dojo api endpoint-status retrieve
retrieve
Usage:
dojo api endpoint-status retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this endpoint_ status.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api endpoint-status update
update
Usage:
dojo api endpoint-status update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
endpoint_ status. [required]
--endpoint-status-request TEXT [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--help Show this message and exit.
dojo api endpoints
methods from EndpointsApi.
Usage:
dojo api endpoints [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
- create: create
- delete-preview-list: delete_preview_list
- destroy: destroy
- generate-report-create: generate_report_create
- list: list
- partial-update: partial_update
- retrieve: retrieve
- update: update
dojo api endpoints create
create
Usage:
dojo api endpoints create [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--tags TEXT
--protocol TEXT The communication protocol/scheme such as 'http', 'ftp',
'dns', etc.
--userinfo TEXT User info as 'alice', 'bob', etc.
--host TEXT The host name or IP address. It must not include the port
number. For example '127.0.0.1', 'localhost',
'yourdomain.com'.
--port INTEGER The network port associated with the endpoint.
--path TEXT The location of the resource, it must not start with a
'/'. For example endpoint/420/edit
--query TEXT The query string, the question mark should be omitted.For
example 'group=4&team=8'
--fragment TEXT The fragment identifier which follows the hash mark. The
hash mark should be omitted. For example 'section-13',
'paragraph-2'.
--product INTEGER
--help Show this message and exit.
dojo api endpoints delete-preview-list
delete_preview_list
Usage:
dojo api endpoints delete-preview-list [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
endpoint. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api endpoints destroy
destroy
Usage:
dojo api endpoints destroy [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this endpoint. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api endpoints generate-report-create
generate_report_create
Usage:
dojo api endpoints generate-report-create [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
endpoint. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--report-generate-option-request TEXT
--help Show this message and exit.
dojo api endpoints list
list
Usage:
dojo api endpoints list [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--fragment TEXT
--has-tags Has tags
--host TEXT
--id INTEGER
--limit INTEGER Number of results to return per page.
--not-tag TEXT Not Tag name contains
--not-tags TEXT Comma separated list of exact tags not
present on model
-o TEXT Ordering * `host` - Host * `-host` - Host
(descending) * `product` - Product *
`-product` - Product (descending) * `id` -
Id * `-id` - Id (descending) *
`active_finding_count` - Active Findings
Count * `-active_finding_count` - Active
Findings Count (descending)
--offset INTEGER The initial index from which to return the
results.
--path TEXT
--port INTEGER
--product INTEGER
--protocol TEXT
--query TEXT
--tag TEXT Tag name contains
--tags TEXT Comma separated list of exact tags (uses OR
for multiple values)
--tags--and TEXT Comma separated list of exact tags to match
with an AND expression
--userinfo TEXT
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api endpoints partial-update
partial_update
Usage:
dojo api endpoints partial-update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
endpoint. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--patched-endpoint-request TEXT
--help Show this message and exit.
dojo api endpoints retrieve
retrieve
Usage:
dojo api endpoints retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this endpoint. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api endpoints update
update
Usage:
dojo api endpoints update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this endpoint.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--endpoint-request TEXT
--help Show this message and exit.
dojo api engagement-presets
methods from EngagementPresetsApi.
Usage:
dojo api engagement-presets [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
- create: create
- delete-preview-list: delete_preview_list
- destroy: destroy
- list: list
- partial-update: partial_update
- retrieve: retrieve
- update: update
dojo api engagement-presets create
create
Usage:
dojo api engagement-presets create [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--title TEXT Brief description of preset.
--notes TEXT Description of what needs to be tested or
setting up environment for testing
--scope TEXT Scope of Engagement testing,
IP's/Resources/URL's)
--product INTEGER
--test-type INTEGER
--network-locations INTEGER
--help Show this message and exit.
dojo api engagement-presets delete-preview-list
delete_preview_list
Usage:
dojo api engagement-presets delete-preview-list [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
engagement_ presets. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api engagement-presets destroy
destroy
Usage:
dojo api engagement-presets destroy [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this engagement_ presets.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api engagement-presets list
list
Usage:
dojo api engagement-presets list [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--id INTEGER
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
--prefetch TEXT List of fields for which to prefetch model
instances and add those to the response
--product INTEGER
--title TEXT
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api engagement-presets partial-update
partial_update
Usage:
dojo api engagement-presets partial-update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
engagement_ presets. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--patched-engagement-presets-request TEXT
--help Show this message and exit.
dojo api engagement-presets retrieve
retrieve
Usage:
dojo api engagement-presets retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this engagement_
presets. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--prefetch TEXT List of fields for which to prefetch model instances and
add those to the response
--help Show this message and exit.
dojo api engagement-presets update
update
Usage:
dojo api engagement-presets update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
engagement_ presets. [required]
--engagement-presets-request TEXT
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--help Show this message and exit.
dojo api engagements
methods from EngagementsApi.
Usage:
dojo api engagements [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
- accept-risks-create: accept_risks_create
- close-create: close_create
- complete-checklist-create: complete_checklist_create
- complete-checklist-retrieve: complete_checklist_retrieve
- create: create
- delete-preview-list: delete_preview_list
- destroy: destroy
- files-create: files_create
- files-download-retrieve: files_download_retrieve
- files-retrieve: files_retrieve
- generate-report-create: generate_report_create
- list: list
- notes-create: notes_create
- notes-retrieve: notes_retrieve
- partial-update: partial_update
- reopen-create: reopen_create
- retrieve: retrieve
- update: update
- update-jira-epic-create: update_jira_epic_create
dojo api engagements accept-risks-create
accept_risks_create
Usage:
dojo api engagements accept-risks-create [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
engagement. [required]
--accepted-risk-request TEXT [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--help Show this message and exit.
dojo api engagements close-create
close_create
Usage:
dojo api engagements close-create [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this engagement.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api engagements complete-checklist-create
complete_checklist_create
Usage:
dojo api engagements complete-checklist-create [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
engagement. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--engagement-check-list-request TEXT
--help Show this message and exit.
dojo api engagements complete-checklist-retrieve
complete_checklist_retrieve
Usage:
dojo api engagements complete-checklist-retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this engagement.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api engagements create
create
Usage:
dojo api engagements create [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--tags TEXT
--name TEXT
--description TEXT
--version TEXT Version of the product the engagement
tested.
--first-contacted DATE
--target-start DATE
--target-end DATE
--reason TEXT
--tracker TEXT Link to epic or ticket system with changes
to version.
--test-strategy TEXT
--threat-model
--api-test
--pen-test
--check-list
--status TEXT * `Not Started` - Not Started * `Blocked` -
Blocked * `Cancelled` - Cancelled *
`Completed` - Completed * `In Progress` - In
Progress * `On Hold` - On Hold * `Scheduled`
- Scheduled * `Waiting for Resource` -
Waiting for Resource
--engagement-type TEXT * `Interactive` - Interactive * `CI/CD` -
CI/CD
--build-id TEXT Build ID of the product the engagement
tested.
--commit-hash TEXT Commit hash from repo
--branch-tag TEXT Tag or branch of the product the engagement
tested.
--source-code-management-uri TEXT
Resource link to source code
--deduplication-on-engagement If enabled deduplication will only mark a
finding in this engagement as duplicate of
another finding if both findings are in this
engagement. If disabled, deduplication is on
the product level.
--lead INTEGER
--requester INTEGER
--preset INTEGER Settings and notes for performing this
engagement.
--report-type INTEGER
--product INTEGER
--build-server INTEGER Build server responsible for CI/CD test
--source-code-management-server INTEGER
Source code server for CI/CD test
--orchestration-engine INTEGER Orchestration service responsible for CI/CD
test
--help Show this message and exit.
dojo api engagements delete-preview-list
delete_preview_list
Usage:
dojo api engagements delete-preview-list [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
engagement. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api engagements destroy
destroy
Usage:
dojo api engagements destroy [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this engagement.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api engagements files-create
files_create
Usage:
dojo api engagements files-create [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this engagement.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--title TEXT
--file PATH
--help Show this message and exit.
dojo api engagements files-download-retrieve
files_download_retrieve
Usage:
dojo api engagements files-download-retrieve [OPTIONS]
Options:
--file-id TEXT [required]
--id INTEGER A unique integer value identifying this engagement.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api engagements files-retrieve
files_retrieve
Usage:
dojo api engagements files-retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this engagement.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api engagements generate-report-create
generate_report_create
Usage:
dojo api engagements generate-report-create [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
engagement. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--report-generate-option-request TEXT
--help Show this message and exit.
dojo api engagements list
list
Usage:
dojo api engagements list [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--active
--api-test
--has-tags Has tags
--id INTEGER
--limit INTEGER Number of results to return per page.
--name TEXT
--not-product--tags TEXT Comma separated list of exact tags not
present on Product
--not-tag TEXT Not Tag name contains
--not-tags TEXT Comma separated list of exact tags not
present on model
-o TEXT Ordering * `name` - Engagement Name *
`-name` - Engagement Name (descending) *
`version` - Version * `-version` - Version
(descending) * `target_start` - Target start
* `-target_start` - Target start
(descending) * `target_end` - Target end *
`-target_end` - Target end (descending) *
`status` - Status * `-status` - Status
(descending) * `lead` - Lead * `-lead` -
Lead (descending) * `created` - Created *
`-created` - Created (descending) *
`updated` - Updated * `-updated` - Updated
(descending)
--offset INTEGER The initial index from which to return the
results.
--pen-test
--product INTEGER
--product--prod-type INTEGER Multiple values may be separated by commas.
--product--tags TEXT Comma separated list of exact tags present
on Product (uses OR for multiple values)
--product--tags--and TEXT Comma separated list of exact tags to match
with an AND expression present on Product
--report-type INTEGER
--requester INTEGER
--status TEXT * `Not Started` - Not Started * `Blocked` -
Blocked * `Cancelled` - Cancelled *
`Completed` - Completed * `In Progress` - In
Progress * `On Hold` - On Hold * `Scheduled`
- Scheduled * `Waiting for Resource` -
Waiting for Resource
--tag TEXT Tag name contains
--tags TEXT Comma separated list of exact tags (uses OR
for multiple values)
--tags--and TEXT Comma separated list of exact tags to match
with an AND expression
--target-end DATE
--target-start DATE
--threat-model
--updated DATETIME
--version TEXT
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api engagements notes-create
notes_create
Usage:
dojo api engagements notes-create [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
engagement. [required]
--add-new-note-option-request TEXT
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--help Show this message and exit.
dojo api engagements notes-retrieve
notes_retrieve
Usage:
dojo api engagements notes-retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this engagement.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api engagements partial-update
partial_update
Usage:
dojo api engagements partial-update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
engagement. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--patched-engagement-request TEXT
--help Show this message and exit.
dojo api engagements reopen-create
reopen_create
Usage:
dojo api engagements reopen-create [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this engagement.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api engagements retrieve
retrieve
Usage:
dojo api engagements retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this engagement.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api engagements update
update
Usage:
dojo api engagements update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
engagement. [required]
--engagement-request TEXT [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api engagements update-jira-epic-create
update_jira_epic_create
Usage:
dojo api engagements update-jira-epic-create [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
engagement. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--engagement-update-jira-epic-request TEXT
--help Show this message and exit.
dojo api finding-templates
methods from FindingTemplatesApi.
Usage:
dojo api finding-templates [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
- create: create
- delete-preview-list: delete_preview_list
- destroy: destroy
- list: list
- partial-update: partial_update
- retrieve: retrieve
- update: update
dojo api finding-templates create
create
Usage:
dojo api finding-templates create [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--tags TEXT
--title TEXT
--cwe INTEGER
--cvssv3 TEXT Common Vulnerability Scoring System version
3 (CVSSv3) score associated with this
finding.
--cvssv3-score FLOAT CVSSv3 score
--cvssv4 TEXT Common Vulnerability Scoring System version
4 (CVSS4) score associated with this
finding.
--cvssv4-score FLOAT CVSSv4 score
--severity TEXT
--description TEXT
--mitigation TEXT
--impact TEXT
--references TEXT
--fix-available Indicates if a fix is available for this
vulnerability type
--fix-version TEXT Version where fix is available
--planned-remediation-version TEXT
Target version for remediation
--effort-for-fixing TEXT Effort estimate for fixing (e.g.,
Low/Medium/High)
--steps-to-reproduce TEXT Standard reproduction steps for this
vulnerability type
--severity-justification TEXT Explanation of why this severity level is
appropriate
--component-name TEXT Affected component name (e.g., library name)
--component-version TEXT Affected component version
--notes TEXT Note content to add when applying this
template
--endpoints-text TEXT Endpoint URLs (one per line)
--help Show this message and exit.
dojo api finding-templates delete-preview-list
delete_preview_list
Usage:
dojo api finding-templates delete-preview-list [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
finding_ template. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api finding-templates destroy
destroy
Usage:
dojo api finding-templates destroy [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this finding_ template.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api finding-templates list
list
Usage:
dojo api finding-templates list [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--cwe INTEGER
--description TEXT
--id INTEGER
--limit INTEGER Number of results to return per page.
--mitigation TEXT
--not-tag TEXT Not Tag name contains
--not-tags TEXT Comma separated list of exact tags not
present on model
-o TEXT Ordering * `title` - Title * `-title` -
Title (descending) * `cwe` - Cwe * `-cwe` -
Cwe (descending)
--offset INTEGER The initial index from which to return the
results.
--severity TEXT
--tag TEXT Tag name contains
--tags TEXT Comma separated list of exact tags (uses OR
for multiple values)
--tags--and TEXT Comma separated list of exact tags to match
with an AND expression
--title TEXT
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api finding-templates partial-update
partial_update
Usage:
dojo api finding-templates partial-update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
finding_ template. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--patched-finding-template-request TEXT
--help Show this message and exit.
dojo api finding-templates retrieve
retrieve
Usage:
dojo api finding-templates retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this finding_ template.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api finding-templates update
update
Usage:
dojo api finding-templates update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
finding_ template. [required]
--finding-template-request TEXT
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--help Show this message and exit.
dojo api findings
methods from FindingsApi.
Usage:
dojo api findings [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
- accept-risks-create: accept_risks_create
- close-create: close_create
- create: create
- delete-preview-list: delete_preview_list
- destroy: destroy
- duplicate-list: duplicate_list
- duplicate-reset-create: duplicate_reset_create
- files-create: files_create
- files-download-retrieve: files_download_retrieve
- files-retrieve: files_retrieve
- generate-report-create: generate_report_create
- list: list
- metadata-create: metadata_create
- metadata-destroy: metadata_destroy
- metadata-list: metadata_list
- metadata-update: metadata_update
- notes-create: notes_create
- notes-retrieve: notes_retrieve
- original-create: original_create
- partial-update: partial_update
- remove-note-partial-update: remove_note_partial_update
- remove-tags-partial-update: remove_tags_partial_update
- remove-tags-update: remove_tags_update
- request-response-create: request_response_create
- request-response-retrieve: request_response_retrieve
- retrieve: retrieve
- tags-create: tags_create
- tags-retrieve: tags_retrieve
- update: update
- verify-create: verify_create
dojo api findings accept-risks-create
accept_risks_create
Usage:
dojo api findings accept-risks-create [OPTIONS]
Options:
--accepted-risk-request TEXT [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--active
--component-name TEXT
--component-version TEXT
--created DATETIME Time that the object was initially created,
and saved to the database * `None` - Any
date * `1` - Today * `2` - Past 7 days * `3`
- Past 30 days * `4` - Past 90 days * `5` -
Current month * `6` - Current year * `7` -
Past year
--cvssv3 TEXT
--cvssv3-score FLOAT
--cvssv4 TEXT
--cvssv4-score FLOAT
--cwe INTEGER Multiple values may be separated by commas.
--var-date DATE The date the flaw was discovered. * `None`
- Any date * `1` - Today * `2` - Past 7 days
* `3` - Past 30 days * `4` - Past 90 days *
`5` - Current month * `6` - Current year *
`7` - Past year
--defect-review-requested-by INTEGER
Multiple values may be separated by commas.
--description TEXT
--discovered-after DATE
--discovered-before DATE
--discovered-on DATE
--duplicate
--duplicate-finding INTEGER
--dynamic-finding
--effort-for-fixing TEXT
--endpoints INTEGER Multiple values may be separated by commas.
--epss-percentile-max FLOAT The range of EPSS percentiles to filter on;
the min input is a lower bound, the max is
an upper bound. Leaving one empty will skip
that bound (e.g., leaving the min bound
input empty will filter only on the max
bound -- filtering on "less than or equal").
Leading 0 required.
--epss-percentile-min FLOAT The range of EPSS percentiles to filter on;
the min input is a lower bound, the max is
an upper bound. Leaving one empty will skip
that bound (e.g., leaving the min bound
input empty will filter only on the max
bound -- filtering on "less than or equal").
Leading 0 required.
--epss-score-max FLOAT The range of EPSS score percentages to
filter on; the min input is a lower bound,
the max is an upper bound. Leaving one empty
will skip that bound (e.g., leaving the min
bound input empty will filter only on the
max bound -- filtering on "less than or
equal"). Leading 0 required.
--epss-score-min FLOAT The range of EPSS score percentages to
filter on; the min input is a lower bound,
the max is an upper bound. Leaving one empty
will skip that bound (e.g., leaving the min
bound input empty will filter only on the
max bound -- filtering on "less than or
equal"). Leading 0 required.
--exact-title TEXT Finding title exact match (case-insensitive)
--false-p
--file-path TEXT
--finding-group FLOAT Multiple values may be separated by commas.
--fix-available
--fix-version TEXT
--found-by INTEGER Multiple values may be separated by commas.
--has-jira
--has-tags Has tags
--hash-code TEXT
--id INTEGER Multiple values may be separated by commas.
--impact TEXT
--inherited-tags INTEGER Internal use tags sepcifically for
maintaining parity with product. This field
will be present as a subset in the tags
field
--is-mitigated
--jira-change DATETIME The date the linked Jira issue was last
modified. * `None` - Any date * `1` - Today
* `2` - Past 7 days * `3` - Past 30 days *
`4` - Past 90 days * `5` - Current month *
`6` - Current year * `7` - Past year
--jira-creation DATETIME The date a Jira issue was created from this
finding. * `None` - Any date * `1` - Today
* `2` - Past 7 days * `3` - Past 30 days *
`4` - Past 90 days * `5` - Current month *
`6` - Current year * `7` - Past year
--kev-date DATE
--known-exploited
--last-reviewed DATETIME Provides the date the flaw was last
'touched' by a tester. * `None` - Any date
* `1` - Today * `2` - Past 7 days * `3` -
Past 30 days * `4` - Past 90 days * `5` -
Current month * `6` - Current year * `7` -
Past year
--last-reviewed-by INTEGER Multiple values may be separated by commas.
--last-status-update DATETIME
--limit INTEGER Number of results to return per page.
--mitigated DATETIME Denotes if this flaw has been fixed by
storing the date it was fixed. * `None` -
Any date * `1` - Today * `2` - Past 7 days *
`3` - Past 30 days * `4` - Past 90 days *
`5` - Current month * `6` - Current year *
`7` - Past year
--mitigated-after DATETIME Mitigated After
--mitigated-before DATETIME
--mitigated-by INTEGER Multiple values may be separated by commas.
--mitigated-on DATETIME
--mitigation TEXT
--nb-occurences INTEGER Multiple values may be separated by commas.
--not-tag TEXT Not Tag name contains
--not-tags TEXT Comma separated list of exact tags not
present on model
--not-test--engagement--product--tags TEXT
Comma separated list of exact tags not
present on Product
--not-test--engagement--tags TEXT
Comma separated list of exact tags not
present on engagement
--not-test--tags TEXT Comma separated list of exact tags present
on test
--numerical-severity TEXT
-o TEXT Ordering * `active` - Active * `-active` -
Active (descending) * `component_name` -
Component name * `-component_name` -
Component name (descending) *
`component_version` - Component version *
`-component_version` - Component version
(descending) * `created` - Created *
`-created` - Created (descending) *
`last_status_update` - Last status update *
`-last_status_update` - Last status update
(descending) * `last_reviewed` - Last
reviewed * `-last_reviewed` - Last reviewed
(descending) * `cwe` - Cwe * `-cwe` - Cwe
(descending) * `date` - Date * `-date` -
Date (descending) * `duplicate` - Duplicate
* `-duplicate` - Duplicate (descending) *
`dynamic_finding` - Dynamic finding *
`-dynamic_finding` - Dynamic finding
(descending) * `false_p` - False p *
`-false_p` - False p (descending) *
`found_by` - Found by * `-found_by` - Found
by (descending) * `id` - Id * `-id` - Id
(descending) * `is_mitigated` - Is mitigated
* `-is_mitigated` - Is mitigated
(descending) * `numerical_severity` -
Numerical severity * `-numerical_severity` -
Numerical severity (descending) *
`out_of_scope` - Out of scope *
`-out_of_scope` - Out of scope (descending)
* `planned_remediation_date` - Planned
remediation date *
`-planned_remediation_date` - Planned
remediation date (descending) * `severity` -
Severity * `-severity` - Severity
(descending) * `sla_expiration_date` - Sla
expiration date * `-sla_expiration_date` -
Sla expiration date (descending) *
`reviewers` - Reviewers * `-reviewers` -
Reviewers (descending) * `static_finding` -
Static finding * `-static_finding` - Static
finding (descending) *
`test__engagement__product__name` - Test
engagement product name *
`-test__engagement__product__name` - Test
engagement product name (descending) *
`title` - Title * `-title` - Title
(descending) * `under_defect_review` - Under
defect review * `-under_defect_review` -
Under defect review (descending) *
`under_review` - Under review *
`-under_review` - Under review (descending)
* `verified` - Verified * `-verified` -
Verified (descending)
--offset INTEGER The initial index from which to return the
results.
--out-of-scope
--outside-of-sla FLOAT
--param TEXT
--payload TEXT
--planned-remediation-date DATE
--planned-remediation-version TEXT
--product-lifecycle TEXT Comma separated list of exact Product
lifecycles
--product-name TEXT Exact Product Name
--product-name-contains TEXT Product Name Contains
--publish-date DATE
--ransomware-used
--references TEXT
--reporter INTEGER Multiple values may be separated by commas.
--review-requested-by INTEGER Multiple values may be separated by commas.
--reviewers INTEGER Multiple values may be separated by commas.
--risk-acceptance FLOAT
--risk-accepted
--sast-sink-object TEXT
--sast-source-file-path TEXT
--sast-source-line INTEGER Multiple values may be separated by commas.
--sast-source-object TEXT
--scanner-confidence INTEGER Multiple values may be separated by commas.
--service TEXT
--severity TEXT
--severity-justification TEXT
--sla-expiration-date DATE
--sla-start-date DATE
--sonarqube-issue INTEGER Multiple values may be separated by commas.
--static-finding
--steps-to-reproduce TEXT
--tag TEXT Tag name contains
--tags TEXT Comma separated list of exact tags (uses OR
for multiple values)
--tags--and TEXT Comma separated list of exact tags to match
with an AND expression
--test INTEGER
--test--engagement INTEGER Multiple values may be separated by commas.
--test--engagement--product INTEGER
Multiple values may be separated by commas.
--test--engagement--product--prod-type INTEGER
Multiple values may be separated by commas.
--test--engagement--product--tags TEXT
Comma separated list of exact tags present
on Product (uses OR for multiple values)
--test--engagement--product--tags--and TEXT
Comma separated list of exact tags to match
with an AND expression present on Product
--test--engagement--tags TEXT Comma separated list of exact tags present
on engagement (uses OR for multiple values)
--test--engagement--tags--and TEXT
Comma separated list of exact tags to match
with an AND expression present on engagement
--test--tags TEXT Comma separated list of exact tags present
on test (uses OR for multiple values)
--test--tags--and TEXT Comma separated list of exact tags to match
with an AND expression present on test
--test--test-type INTEGER Multiple values may be separated by commas.
--title TEXT
--under-defect-review
--under-review
--unique-id-from-tool TEXT
--updated DATETIME
--verified
--vuln-id-from-tool TEXT
--vulnerability-id TEXT
--help Show this message and exit.
dojo api findings close-create
close_create
Usage:
dojo api findings close-create [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
finding. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--finding-close-request TEXT
--help Show this message and exit.
dojo api findings create
create
Usage:
dojo api findings create [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--mitigated DATETIME
--mitigated-by INTEGER
--test INTEGER
--thread-id INTEGER [default: 0]
--found-by INTEGER
--url TEXT
--tags TEXT
--push-to-jira
--vulnerability-ids TEXT
--reporter INTEGER
--title TEXT A short description of the flaw.
--var-date DATE The date the flaw was discovered.
--sla-start-date DATE (readonly)The date used as start date for
SLA calculation. Set by expiring risk
acceptances. Empty by default, causing a
fallback to 'date'.
--sla-expiration-date DATE (readonly)The date SLA expires for this
finding. Empty by default, causing a
fallback to 'date'.
--cwe INTEGER The CWE number associated with this flaw.
--epss-score FLOAT EPSS score for the CVE. Describes how likely
it is the vulnerability will be exploited in
the next 30 days.
--epss-percentile FLOAT EPSS percentile for the CVE. Describes how
many CVEs are scored at or below this one.
--known-exploited Whether this vulnerability is known to have
been exploited in the wild.
--ransomware-used Whether this vulnerability is known to have
been leveraged as part of a ransomware
campaign.
--kev-date DATE The date the vulnerability was added to the
KEV catalog.
--cvssv3 TEXT Common Vulnerability Scoring System version
3 (CVSS3) score associated with this
finding.
--cvssv3-score FLOAT Numerical CVSSv3 score for the
vulnerability. If the vector is given, the
score is updated while saving the finding.
The value must be between 0-10.
--cvssv4 TEXT Common Vulnerability Scoring System version
4 (CVSS4) score associated with this
finding.
--cvssv4-score FLOAT Numerical CVSSv4 score for the
vulnerability. If the vector is given, the
score is updated while saving the finding.
The value must be between 0-10.
--severity TEXT The severity level of this flaw (Critical,
High, Medium, Low, Info).
--description TEXT Longer more descriptive information about
the flaw.
--mitigation TEXT Text describing how to best fix the flaw.
--fix-available Denotes if there is a fix available for this
flaw.
--fix-version TEXT Version of the affected component in which
the flaw is fixed.
--impact TEXT Text describing the impact this flaw has on
systems, products, enterprise, etc.
--steps-to-reproduce TEXT Text describing the steps that must be
followed in order to reproduce the flaw /
bug.
--severity-justification TEXT Text describing why a certain severity was
associated with this flaw.
--references TEXT The external documentation available for
this flaw.
--active Denotes if this flaw is active or not.
--verified Denotes if this flaw has been manually
verified by the tester.
--false-p Denotes if this flaw has been deemed a false
positive by the tester.
--duplicate Denotes if this flaw is a duplicate of other
flaws reported.
--out-of-scope Denotes if this flaw falls outside the scope
of the test and/or engagement.
--risk-accepted Denotes if this finding has been marked as
an accepted risk.
--under-review Denotes is this flaw is currently being
reviewed.
--under-defect-review Denotes if this finding is under defect
review.
--is-mitigated Denotes if this flaw has been fixed.
--numerical-severity TEXT The numerical representation of the severity
(S0, S1, S2, S3, S4).
--line INTEGER Source line number of the attack vector.
--file-path TEXT Identified file(s) containing the flaw.
--component-name TEXT Name of the affected component (library
name, part of a system, ...).
--component-version TEXT Version of the affected component.
--static-finding Flaw has been detected from a Static
Application Security Testing tool (SAST).
--dynamic-finding Flaw has been detected from a Dynamic
Application Security Testing tool (DAST).
--unique-id-from-tool TEXT Vulnerability technical id from the source
tool. Allows to track unique vulnerabilities
over time across subsequent scans.
--vuln-id-from-tool TEXT Non-unique technical id from the source tool
associated with the vulnerability type.
--sast-source-object TEXT Source object (variable, function...) of the
attack vector.
--sast-sink-object TEXT Sink object (variable, function...) of the
attack vector.
--sast-source-line INTEGER Source line number of the attack vector.
--sast-source-file-path TEXT Source file path of the attack vector.
--nb-occurences INTEGER Number of occurences in the source tool when
several vulnerabilites were found and
aggregated by the scanner.
--publish-date DATE Date when this vulnerability was made
publicly available.
--service TEXT A service is a self-contained piece of
functionality within a Product. This is an
optional field which is used in
deduplication of findings when set.
--planned-remediation-date DATE
The date the flaw is expected to be
remediated.
--planned-remediation-version TEXT
The target version when the vulnerability
should be fixed / remediated
--effort-for-fixing TEXT Effort for fixing / remediating the
vulnerability (Low, Medium, High)
--review-requested-by INTEGER Documents who requested a review for this
finding.
--defect-review-requested-by INTEGER
Documents who requested a defect review for
this flaw.
--sonarqube-issue INTEGER The SonarQube issue associated with this
finding.
--reviewers INTEGER Documents who reviewed the flaw.
--help Show this message and exit.
dojo api findings delete-preview-list
delete_preview_list
Usage:
dojo api findings delete-preview-list [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
finding. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api findings destroy
destroy
Usage:
dojo api findings destroy [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this finding. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api findings duplicate-list
duplicate_list
Usage:
dojo api findings duplicate-list [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this finding. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api findings duplicate-reset-create
duplicate_reset_create
Usage:
dojo api findings duplicate-reset-create [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this finding. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api findings files-create
files_create
Usage:
dojo api findings files-create [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this finding. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--title TEXT
--file PATH
--help Show this message and exit.
dojo api findings files-download-retrieve
files_download_retrieve
Usage:
dojo api findings files-download-retrieve [OPTIONS]
Options:
--file-id TEXT [required]
--id INTEGER A unique integer value identifying this finding. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api findings files-retrieve
files_retrieve
Usage:
dojo api findings files-retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this finding. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api findings generate-report-create
generate_report_create
Usage:
dojo api findings generate-report-create [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--include-finding-notes
--include-finding-images
--include-executive-summary
--include-table-of-contents
--help Show this message and exit.
dojo api findings list
list
Usage:
dojo api findings list [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--active
--component-name TEXT
--component-version TEXT
--created DATETIME Time that the object was initially created,
and saved to the database * `None` - Any
date * `1` - Today * `2` - Past 7 days * `3`
- Past 30 days * `4` - Past 90 days * `5` -
Current month * `6` - Current year * `7` -
Past year
--cvssv3 TEXT
--cvssv3-score FLOAT
--cvssv4 TEXT
--cvssv4-score FLOAT
--cwe INTEGER Multiple values may be separated by commas.
--var-date DATE The date the flaw was discovered. * `None`
- Any date * `1` - Today * `2` - Past 7 days
* `3` - Past 30 days * `4` - Past 90 days *
`5` - Current month * `6` - Current year *
`7` - Past year
--defect-review-requested-by INTEGER
Multiple values may be separated by commas.
--description TEXT
--discovered-after DATE
--discovered-before DATE
--discovered-on DATE
--duplicate
--duplicate-finding INTEGER
--dynamic-finding
--effort-for-fixing TEXT
--endpoints INTEGER Multiple values may be separated by commas.
--epss-percentile-max FLOAT The range of EPSS percentiles to filter on;
the min input is a lower bound, the max is
an upper bound. Leaving one empty will skip
that bound (e.g., leaving the min bound
input empty will filter only on the max
bound -- filtering on "less than or equal").
Leading 0 required.
--epss-percentile-min FLOAT The range of EPSS percentiles to filter on;
the min input is a lower bound, the max is
an upper bound. Leaving one empty will skip
that bound (e.g., leaving the min bound
input empty will filter only on the max
bound -- filtering on "less than or equal").
Leading 0 required.
--epss-score-max FLOAT The range of EPSS score percentages to
filter on; the min input is a lower bound,
the max is an upper bound. Leaving one empty
will skip that bound (e.g., leaving the min
bound input empty will filter only on the
max bound -- filtering on "less than or
equal"). Leading 0 required.
--epss-score-min FLOAT The range of EPSS score percentages to
filter on; the min input is a lower bound,
the max is an upper bound. Leaving one empty
will skip that bound (e.g., leaving the min
bound input empty will filter only on the
max bound -- filtering on "less than or
equal"). Leading 0 required.
--exact-title TEXT Finding title exact match (case-insensitive)
--false-p
--file-path TEXT
--finding-group FLOAT Multiple values may be separated by commas.
--fix-available
--fix-version TEXT
--found-by INTEGER Multiple values may be separated by commas.
--has-jira
--has-tags Has tags
--hash-code TEXT
--id INTEGER Multiple values may be separated by commas.
--impact TEXT
--inherited-tags INTEGER Internal use tags sepcifically for
maintaining parity with product. This field
will be present as a subset in the tags
field
--is-mitigated
--jira-change DATETIME The date the linked Jira issue was last
modified. * `None` - Any date * `1` - Today
* `2` - Past 7 days * `3` - Past 30 days *
`4` - Past 90 days * `5` - Current month *
`6` - Current year * `7` - Past year
--jira-creation DATETIME The date a Jira issue was created from this
finding. * `None` - Any date * `1` - Today
* `2` - Past 7 days * `3` - Past 30 days *
`4` - Past 90 days * `5` - Current month *
`6` - Current year * `7` - Past year
--kev-date DATE
--known-exploited
--last-reviewed DATETIME Provides the date the flaw was last
'touched' by a tester. * `None` - Any date
* `1` - Today * `2` - Past 7 days * `3` -
Past 30 days * `4` - Past 90 days * `5` -
Current month * `6` - Current year * `7` -
Past year
--last-reviewed-by INTEGER Multiple values may be separated by commas.
--last-status-update DATETIME
--limit INTEGER Number of results to return per page.
--mitigated DATETIME Denotes if this flaw has been fixed by
storing the date it was fixed. * `None` -
Any date * `1` - Today * `2` - Past 7 days *
`3` - Past 30 days * `4` - Past 90 days *
`5` - Current month * `6` - Current year *
`7` - Past year
--mitigated-after DATETIME Mitigated After
--mitigated-before DATETIME
--mitigated-by INTEGER Multiple values may be separated by commas.
--mitigated-on DATETIME
--mitigation TEXT
--nb-occurences INTEGER Multiple values may be separated by commas.
--not-tag TEXT Not Tag name contains
--not-tags TEXT Comma separated list of exact tags not
present on model
--not-test--engagement--product--tags TEXT
Comma separated list of exact tags not
present on Product
--not-test--engagement--tags TEXT
Comma separated list of exact tags not
present on engagement
--not-test--tags TEXT Comma separated list of exact tags present
on test
--numerical-severity TEXT
-o TEXT Ordering * `active` - Active * `-active` -
Active (descending) * `component_name` -
Component name * `-component_name` -
Component name (descending) *
`component_version` - Component version *
`-component_version` - Component version
(descending) * `created` - Created *
`-created` - Created (descending) *
`last_status_update` - Last status update *
`-last_status_update` - Last status update
(descending) * `last_reviewed` - Last
reviewed * `-last_reviewed` - Last reviewed
(descending) * `cwe` - Cwe * `-cwe` - Cwe
(descending) * `date` - Date * `-date` -
Date (descending) * `duplicate` - Duplicate
* `-duplicate` - Duplicate (descending) *
`dynamic_finding` - Dynamic finding *
`-dynamic_finding` - Dynamic finding
(descending) * `false_p` - False p *
`-false_p` - False p (descending) *
`found_by` - Found by * `-found_by` - Found
by (descending) * `id` - Id * `-id` - Id
(descending) * `is_mitigated` - Is mitigated
* `-is_mitigated` - Is mitigated
(descending) * `numerical_severity` -
Numerical severity * `-numerical_severity` -
Numerical severity (descending) *
`out_of_scope` - Out of scope *
`-out_of_scope` - Out of scope (descending)
* `planned_remediation_date` - Planned
remediation date *
`-planned_remediation_date` - Planned
remediation date (descending) * `severity` -
Severity * `-severity` - Severity
(descending) * `sla_expiration_date` - Sla
expiration date * `-sla_expiration_date` -
Sla expiration date (descending) *
`reviewers` - Reviewers * `-reviewers` -
Reviewers (descending) * `static_finding` -
Static finding * `-static_finding` - Static
finding (descending) *
`test__engagement__product__name` - Test
engagement product name *
`-test__engagement__product__name` - Test
engagement product name (descending) *
`title` - Title * `-title` - Title
(descending) * `under_defect_review` - Under
defect review * `-under_defect_review` -
Under defect review (descending) *
`under_review` - Under review *
`-under_review` - Under review (descending)
* `verified` - Verified * `-verified` -
Verified (descending)
--offset INTEGER The initial index from which to return the
results.
--out-of-scope
--outside-of-sla FLOAT
--param TEXT
--payload TEXT
--planned-remediation-date DATE
--planned-remediation-version TEXT
--prefetch TEXT List of fields for which to prefetch model
instances and add those to the response
--product-lifecycle TEXT Comma separated list of exact Product
lifecycles
--product-name TEXT Exact Product Name
--product-name-contains TEXT Product Name Contains
--publish-date DATE
--ransomware-used
--references TEXT
--related-fields Expand finding external relations
(engagement, environment, product,
product_type, test, test_type)
--reporter INTEGER Multiple values may be separated by commas.
--review-requested-by INTEGER Multiple values may be separated by commas.
--reviewers INTEGER Multiple values may be separated by commas.
--risk-acceptance FLOAT
--risk-accepted
--sast-sink-object TEXT
--sast-source-file-path TEXT
--sast-source-line INTEGER Multiple values may be separated by commas.
--sast-source-object TEXT
--scanner-confidence INTEGER Multiple values may be separated by commas.
--service TEXT
--severity TEXT
--severity-justification TEXT
--sla-expiration-date DATE
--sla-start-date DATE
--sonarqube-issue INTEGER Multiple values may be separated by commas.
--static-finding
--steps-to-reproduce TEXT
--tag TEXT Tag name contains
--tags TEXT Comma separated list of exact tags (uses OR
for multiple values)
--tags--and TEXT Comma separated list of exact tags to match
with an AND expression
--test INTEGER
--test--engagement INTEGER Multiple values may be separated by commas.
--test--engagement--product INTEGER
Multiple values may be separated by commas.
--test--engagement--product--prod-type INTEGER
Multiple values may be separated by commas.
--test--engagement--product--tags TEXT
Comma separated list of exact tags present
on Product (uses OR for multiple values)
--test--engagement--product--tags--and TEXT
Comma separated list of exact tags to match
with an AND expression present on Product
--test--engagement--tags TEXT Comma separated list of exact tags present
on engagement (uses OR for multiple values)
--test--engagement--tags--and TEXT
Comma separated list of exact tags to match
with an AND expression present on engagement
--test--tags TEXT Comma separated list of exact tags present
on test (uses OR for multiple values)
--test--tags--and TEXT Comma separated list of exact tags to match
with an AND expression present on test
--test--test-type INTEGER Multiple values may be separated by commas.
--title TEXT
--under-defect-review
--under-review
--unique-id-from-tool TEXT
--updated DATETIME
--verified
--vuln-id-from-tool TEXT
--vulnerability-id TEXT
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api findings metadata-create
metadata_create
Usage:
dojo api findings metadata-create [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
finding. [required]
--finding-meta-request TEXT [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--help Show this message and exit.
dojo api findings metadata-destroy
metadata_destroy
Usage:
dojo api findings metadata-destroy [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this finding. [required]
--name INTEGER name of the metadata to retrieve. If name is empty, return
all the metadata
associated with the finding [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api findings metadata-list
metadata_list
Usage:
dojo api findings metadata-list [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this finding. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api findings metadata-update
metadata_update
Usage:
dojo api findings metadata-update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
finding. [required]
--finding-meta-request TEXT [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--help Show this message and exit.
dojo api findings notes-create
notes_create
Usage:
dojo api findings notes-create [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
finding. [required]
--add-new-note-option-request TEXT
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--help Show this message and exit.
dojo api findings notes-retrieve
notes_retrieve
Usage:
dojo api findings notes-retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this finding. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api findings original-create
original_create
Usage:
dojo api findings original-create [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this finding.
[required]
--new-fid INTEGER [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api findings partial-update
partial_update
Usage:
dojo api findings partial-update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
finding. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--patched-finding-request TEXT
--help Show this message and exit.
dojo api findings remove-note-partial-update
remove_note_partial_update
Usage:
dojo api findings remove-note-partial-update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
finding. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--patched-finding-note-request TEXT
--help Show this message and exit.
dojo api findings remove-tags-partial-update
remove_tags_partial_update
Usage:
dojo api findings remove-tags-partial-update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this finding.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--patched-tag-request TEXT
--help Show this message and exit.
dojo api findings remove-tags-update
remove_tags_update
Usage:
dojo api findings remove-tags-update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this finding.
[required]
--tag-request TEXT [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api findings request-response-create
request_response_create
Usage:
dojo api findings request-response-create [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
finding. [required]
--burp-raw-request-response-request TEXT
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--help Show this message and exit.
dojo api findings request-response-retrieve
request_response_retrieve
Usage:
dojo api findings request-response-retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this finding. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api findings retrieve
retrieve
Usage:
dojo api findings retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this finding.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--prefetch TEXT List of fields for which to prefetch model instances and
add those to the response
--related-fields Expand finding external relations (engagement,
environment, product,
product_type, test, test_type)
--help Show this message and exit.
dojo api findings tags-create
tags_create
Usage:
dojo api findings tags-create [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this finding.
[required]
--tag-request TEXT [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api findings tags-retrieve
tags_retrieve
Usage:
dojo api findings tags-retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this finding. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api findings update
update
Usage:
dojo api findings update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this finding.
[required]
--finding-request TEXT [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api findings verify-create
verify_create
Usage:
dojo api findings verify-create [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
finding. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--finding-verify-request TEXT
--help Show this message and exit.
dojo api global-roles
methods from GlobalRolesApi.
Usage:
dojo api global-roles [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
- create: create
- delete-preview-list: delete_preview_list
- destroy: destroy
- list: list
- partial-update: partial_update
- retrieve: retrieve
- update: update
dojo api global-roles create
create
Usage:
dojo api global-roles create [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--user INTEGER
--group INTEGER
--role INTEGER The global role will be applied to all product types and
products.
--help Show this message and exit.
dojo api global-roles delete-preview-list
delete_preview_list
Usage:
dojo api global-roles delete-preview-list [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
global_ role. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api global-roles destroy
destroy
Usage:
dojo api global-roles destroy [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this global_ role.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api global-roles list
list
Usage:
dojo api global-roles list [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--group INTEGER
--id INTEGER
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
--prefetch TEXT List of fields for which to prefetch model
instances and add those to the response
--role INTEGER
--user INTEGER
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api global-roles partial-update
partial_update
Usage:
dojo api global-roles partial-update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
global_ role. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--patched-global-role-request TEXT
--help Show this message and exit.
dojo api global-roles retrieve
retrieve
Usage:
dojo api global-roles retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this global_ role.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--prefetch TEXT List of fields for which to prefetch model instances and
add those to the response
--help Show this message and exit.
dojo api global-roles update
update
Usage:
dojo api global-roles update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this global_
role. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--global-role-request TEXT
--help Show this message and exit.
dojo api import-languages
create
Usage:
dojo api import-languages [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--product INTEGER
--file PATH
--help Show this message and exit.
dojo api import-scan
create
Usage:
dojo api import-scan [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--scan-date DATE Scan completion date will be used on all
findings.
--minimum-severity TEXT Minimum severity level to be imported *
`Info` - Info * `Low` - Low * `Medium` -
Medium * `High` - High * `Critical` -
Critical
--active Force findings to be active/inactive or
default to the original tool (None)
--verified Force findings to be verified/not verified
or default to the original tool (None)
--endpoint-to-add INTEGER Enter the ID of an Endpoint that is
associated with the target Product. New
Findings will be added to that Endpoint.
--file PATH
--product-type-name TEXT Also referred to as 'Organization' name.
--product-name TEXT Also referred to as 'Asset' name.
--engagement-name TEXT
--engagement-end-date DATE End Date for Engagement. Default is current
time + 365 days. Required format year-month-
day
--source-code-management-uri TEXT
Resource link to source code
--test-title TEXT
--auto-create-context
--deduplication-on-engagement
--lead INTEGER
--push-to-jira
--environment TEXT
--build-id TEXT ID of the build that was scanned.
--branch-tag TEXT Branch or Tag that was scanned.
--commit-hash TEXT Commit that was scanned.
--api-scan-configuration INTEGER
--service TEXT A service is a self-contained piece of
functionality within a Product. This is an
optional field which is used in
deduplication and closing of old findings
when set. This affects the whole
engagement/product depending on your
deduplication scope.
--group-by TEXT Choose an option to automatically group new
findings by the chosen option. *
`component_name` - Component Name *
`component_name+component_version` -
Component Name + Version * `file_path` -
File path * `finding_title` - Finding Title
* `vuln_id_from_tool` - Vulnerability ID
from Tool
--create-finding-groups-for-all-findings
If set to false, finding groups will only be
created when there is more than one grouped
finding
--apply-tags-to-findings If set to True, the tags will be applied to
the findings
--apply-tags-to-endpoints If set to True, the tags will be applied to
the locations
--scan-type TEXT * `Acunetix Scan` - Acunetix Scanner *
`Anchore Engine Scan` - Anchore Engine Scan
* `Anchore Enterprise Policy Check` -
Anchore Enterprise Policy Check * `Anchore
Grype` - Anchore Grype * `Anchore Grype
detailed` - Anchore Grype detailed *
`AnchoreCTL Policies Report` - AnchoreCTL
Policies Report * `AnchoreCTL Vuln Report` -
AnchoreCTL Vuln Report * `AppCheck Web
Application Scanner` - AppCheck Web
Application Scanner * `AppSpider Scan` -
AppSpider Scan * `Aqua Scan` - Aqua Scan *
`Arachni Scan` - Arachni Scan * `AuditJS
Scan` - AuditJS Scan * `AWS Inspector2 Scan`
- AWS Inspector2 Scan * `AWS Prowler Scan` -
AWS Prowler Scan * `AWS Prowler V3` - AWS
Prowler V3 * `AWS Security Finding Format
(ASFF) Scan` - AWS Security Finding Format
(ASFF) * `AWS Security Hub Scan` - AWS
Security Hub Scan * `Azure Security Center
Recommendations Scan` - Azure Security
Center Recommendations Scan * `Bandit Scan`
- Bandit Scan * `Bearer CLI` - Bearer CLI *
`BlackDuck API` - BlackDuck API * `Blackduck
Binary Analysis` - Blackduck Binary Analysis
* `Blackduck Component Risk` - Blackduck
Component Risk * `Blackduck Hub Scan` -
Blackduck Hub Scan * `Brakeman Scan` -
Brakeman Scan * `Bugcrowd API Import` -
Bugcrowd API Import * `BugCrowd Scan` -
BugCrowd Scan * `Bundler-Audit Scan` -
Bundler-Audit Scan * `Burp Dastardly Scan` -
Burp Dastardly Scan * `Burp Enterprise Scan`
- Burp Enterprise Scan (RENAMED to Burp
Suite DAST Scan) * `Burp REST API` - Burp
REST API * `Burp Scan` - Burp Scan * `Burp
GraphQL API` - Burp Suite DAST GraphQL API *
`Burp Suite DAST Scan` - Burp Suite DAST
Scan * `CargoAudit Scan` - CargoAudit Scan *
`Checkmarx CxFlow SAST` - Checkmarx CxFlow
SAST * `Checkmarx One Scan` - Checkmarx One
Scan * `Checkmarx OSA` - Checkmarx OSA *
`Checkmarx Scan` - Checkmarx Scan *
`Checkmarx Scan detailed` - Checkmarx Scan
detailed * `Checkov Scan` - Checkov Scan *
`Chef Inspect Log` - Chef Inspect Log *
`Choctaw Hog Scan` - Choctaw Hog Scan *
`Clair Scan` - Clair Scan * `Cloudflare
Insights` - Cloudflare Insights *
`Cloudsploit Scan` - Cloudsploit Scan *
`Cobalt.io API Import` - Cobalt.io API
Import * `Cobalt.io Scan` - Cobalt.io Scan *
`Codechecker Report native` - Codechecker
Report native * `Contrast Scan` - Contrast
Scan * `Coverity API` - Coverity API *
`Coverity Scan JSON Report` - Coverity Scan
JSON Report * `Crashtest Security JSON File`
- Crashtest Security JSON File * `Crashtest
Security XML File` - Crashtest Security XML
File * `CredScan Scan` - CredScan Scan *
`Crunch42 Scan` - Crunch42 Scan *
`Cyberwatch scan (Galeax)` - Cyberwatch scan
(Galeax) * `CycloneDX Scan` - CycloneDX Scan
* `Cycognito Scan` - Cycognito Scan *
`DawnScanner Scan` - DawnScanner Scan *
`Deepfence Threatmapper Report` - Deepfence
Threatmapper Report * `Dependency Check
Scan` - Dependency Check Scan * `Dependency
Track Finding Packaging Format (FPF) Export`
- Dependency Track Finding Packaging Format
(FPF) Export * `Detect-secrets Scan` -
Detect-secrets Scan * `docker-bench-security
Scan` - docker-bench-security Scan * `Dockle
Scan` - Dockle Scan * `DrHeader JSON
Importer` - DrHeader JSON Importer * `DSOP
Scan` - DSOP Scan * `Duroc Hog Scan` - Duroc
Hog Scan * `Edgescan Scan` - Edgescan Scan *
`ESLint Scan` - ESLint Scan * `Essex Hog
Scan` - Essex Hog Scan * `Fortify Scan` -
Fortify Scan * `Generic Findings Import` -
Generic Findings Import * `Ggshield Scan` -
Ggshield Scan * `Github SAST Scan` - Github
SAST Scan * `Github Secrets Detection Report
Scan` - Github Secrets Detection Report Scan
* `Github Vulnerability Scan` - Github
Vulnerability Scan * `GitLab API Fuzzing
Report Scan` - GitLab API Fuzzing Report
Scan * `GitLab Container Scan` - GitLab
Container Scan Scan * `GitLab DAST Report` -
GitLab DAST Report * `GitLab Dependency
Scanning Report` - GitLab Dependency
Scanning Report * `GitLab SAST Report` -
GitLab SAST Report * `GitLab Secret
Detection Report` - GitLab Secret Detection
Report * `Gitleaks Scan` - Gitleaks Scan *
`Google Cloud Artifact Vulnerability Scan` -
Google Cloud Artifact Vulnerability Scan *
`Gosec Scanner` - Gosec Scanner * `Gottingen
Hog Scan` - Gottingen Hog Scan *
`Govulncheck Scanner` - Govulncheck Scanner
* `HackerOne Cases` - HackerOne Cases *
`Hadolint Dockerfile check` - Hadolint
Dockerfile check * `Harbor Vulnerability
Scan` - Harbor Vulnerability Scan * `HCL
AppScan on Cloud SAST XML` - HCL AppScan on
Cloud SAST XML * `HCLAppScan XML` -
HCLAppScan XML * `Horusec Scan` - Horusec
Scan * `Humble Json Importer` - Humble Json
Importer * `HuskyCI Report` - HuskyCI Report
* `Hydra Scan` - Hydra Scan * `IBM AppScan
DAST` - IBM AppScan DAST * `Immuniweb Scan`
- Immuniweb Scan * `IntSights Report` -
IntSights Report * `Invicti Scan` - Invicti
Scan * `IriusRisk Threats Scan` - IriusRisk
Threats Scan * `JFrog Xray API Summary
Artifact Scan` - JFrog Xray API Summary
Artifact Scan * `JFrog Xray On Demand Binary
Scan` - JFrog Xray On Demand Binary Scan *
`JFrog Xray Scan` - JFrog Xray Scan * `JFrog
Xray Unified Scan` - JFrog Xray Unified Scan
* `KICS Scan` - KICS Scan * `Kiuwan SCA
Scan` - Kiuwan SCA Scan * `Kiuwan Scan` -
Kiuwan Scan * `KrakenD Audit Scan` - KrakenD
Audit Scan * `kube-bench Scan` - kube-bench
Scan * `Kubeaudit Scan` - Kubeaudit Scan *
`KubeHunter Scan` - KubeHunter Scan *
`Kubescape JSON Importer` - Kubescape JSON
Importer * `Legitify Scan` - Legitify Scan *
`Mayhem SARIF Report` - Mayhem SARIF Report
* `Mend Scan` - Mend Scan * `Meterian Scan`
- Meterian Scan * `Microfocus Webinspect
Scan` - Microfocus Webinspect Scan * `MobSF
Scan` - MobSF Scan * `Mobsfscan Scan` -
MobSF Scan * `MobSF Scorecard Scan` - MobSF
Scorecard Scan * `Mozilla Observatory Scan`
- Mozilla Observatory Scan * `MSDefender
Parser` - MSDefender Parser * `n0s1 Scanner`
- n0s1 Scanner * `Nancy Scan` - Nancy Scan *
`Netsparker Scan` - Netsparker Scan *
`NeuVector (compliance)` - NeuVector
(compliance) * `NeuVector (REST)` -
NeuVector (REST) * `Nexpose Scan` - Nexpose
Scan * `Nikto Scan` - Nikto Scan * `Nmap
Scan` - Nmap Scan * `Node Security Platform
Scan` - Node Security Platform Scan * `Nosey
Parker Scan` - Nosey Parker Scan * `NPM
Audit Scan` - NPM Audit Scan * `NPM Audit
v7+ Scan` - NPM Audit v7+ Scan * `Nuclei
Scan` - Nuclei Scan * `OpenReports` -
OpenReports * `Openscap Vulnerability Scan`
- Openscap Vulnerability Scan * `OpenVAS
Parser` - OpenVAS Parser * `OpenVAS Parser
v2` - OpenVAS Parser v2 * `Orca Security
Alerts` - Orca Security Alerts * `ORT
evaluated model Importer` - ORT evaluated
model Importer * `OssIndex Devaudit SCA Scan
Importer` - OssIndex Devaudit SCA Scan
Importer * `OSV Scan` - OSV Scan *
`Outpost24 Scan` - Outpost24 Scan * `PHP
Security Audit v2` - PHP Security Audit v2 *
`PHP Symfony Security Check` - PHP Symfony
Security Check * `PingCastle` - PingCastle *
`pip-audit Scan` - pip-audit Scan * `PMD
Scan` - PMD Scan * `Popeye Scan` - Popeye
Scan * `Progpilot Scan` - Progpilot Scan *
`Prowler Scan` - Prowler Scan * `PTART
Report` - PTART Report * `PWN SAST` - PWN
SAST * `Qualys Hacker Guardian Scan` -
Qualys Hacker Guardian Scan * `Qualys
Infrastructure Scan (WebGUI XML)` - Qualys
Infrastructure Scan (WebGUI XML) * `Qualys
Scan` - Qualys Scan * `Qualys Webapp Scan` -
Qualys Webapp Scan * `Rapplex Scan` -
Rapplex Scan * `Red Hat Satellite` - Red Hat
Satellite * `Retire.js Scan` - Retire.js
Scan * `ReversingLabs Spectra Assure` -
ReversingLabs Spectra Assure * `Risk Recon
API Importer` - Risk Recon API Importer *
`Rubocop Scan` - Rubocop Scan * `Rusty Hog
Scan` - Rusty Hog Scan * `SARIF` - SARIF *
`Scantist Scan` - Scantist Scan * `Scout
Suite Scan` - Scout Suite Scan * `Semgrep
JSON Report` - Semgrep JSON Report *
`Semgrep Pro JSON Report` - Semgrep Pro JSON
Report * `SKF Scan` - SKF Scan * `Snyk Code
Scan` - Snyk Code Scan * `Snyk Issue API
Scan` - Snyk Issue API Scan * `Snyk Scan` -
Snyk Scan * `Solar Appscreener Scan` - Solar
Appscreener Scan Detailed_Results.csv *
`SonarQube API Import` - SonarQube API
Import * `SonarQube Scan` - SonarQube Scan *
`SonarQube Scan detailed` - SonarQube Scan
detailed * `Sonatype Application Scan` -
Sonatype Application Scan * `SpotBugs Scan`
- SpotBugs Scan * `SSH Audit Importer` - SSH
Audit Importer * `SSL Labs Scan` - SSL Labs
Scan * `Sslscan` - Sslscan * `Sslyze Scan` -
Sslyze Scan * `SSLyze Scan (JSON)` - SSLyze
Scan (JSON) * `StackHawk HawkScan` -
StackHawk HawkScan * `Sysdig CLI Report` -
Sysdig CLI Report Scan * `Sysdig
Vulnerability Report` - Sysdig Vulnerability
Report Scan * `Talisman Scan` - Talisman
Scan * `Tenable Scan` - Tenable Scan *
`Terrascan Scan` - Terrascan Scan * `Testssl
Scan` - Testssl Scan * `TFSec Scan` - TFSec
Scan * `Threagile risks report` - Threagile
risks report * `ThreatComposer Scan` -
ThreatComposer Scan * `Trivy Operator Scan`
- Trivy Operator Scan * `Trivy Scan` - Trivy
Scan * `Trufflehog Scan` - Trufflehog Scan *
`Trufflehog3 Scan` - Trufflehog3 Scan *
`Trustwave Fusion API Scan` - Trustwave
Fusion API Scan * `Trustwave Scan (CSV)` -
Trustwave Scan (CSV) * `Twistlock Image
Scan` - Twistlock Image Scan * `VCG Scan` -
VCG Scan * `Veracode Scan` - Veracode Scan *
`Veracode SourceClear Scan` - Veracode
SourceClear Scan * `Vulners` - Vulners *
`Wapiti Scan` - Wapiti Scan * `Wazuh` -
Wazuh * `WFuzz JSON report` - WFuzz JSON
report * `Whispers Scan` - Whispers Scan *
`WhiteHat Sentinel` - WhiteHat Sentinel *
`Wiz Scan` - Wiz Scan * `Wizcli Dir Scan` -
Wizcli Dir Scan * `Wizcli IaC Scan` - Wizcli
IaC Scan * `Wizcli Img Scan` - Wizcli Img
Scan * `Wpscan` - Wpscan * `Xanitizer Scan`
- Xanitizer Scan * `Xeol Parser` - Xeol
Parser * `Yarn Audit Scan` - Yarn Audit Scan
* `ZAP Scan` - ZAP Scan * `Zora Parser` -
Zora Parser
--engagement INTEGER
--tags TEXT Add tags that help describe this scan.
--close-old-findings Old findings no longer present in the new
report get closed as mitigated when
importing. If service has been set, only the
findings for this service will be closed; if
no service is set, only findings without a
service will be closed. This only affects
findings within the same engagement.
--close-old-findings-product-scope
Old findings no longer present in the new
report get closed as mitigated when
importing. If service has been set, only the
findings for this service will be closed; if
no service is set, only findings without a
service will be closed. This only affects
findings within the same product.By default,
it is false meaning that only old findings
of the same type in the engagement are in
scope.
--version TEXT Version that was scanned.
--help Show this message and exit.
dojo api jira-configurations
methods from JiraConfigurationsApi.
Usage:
dojo api jira-configurations [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
- create: create
- delete-preview-list: delete_preview_list
- destroy: destroy
- list: list
- partial-update: partial_update
- retrieve: retrieve
- update: update
dojo api jira-configurations create
create
Usage:
dojo api jira-configurations create [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--configuration-name TEXT Enter a name to give to this configuration
--url TEXT For more information how to configure Jira,
read the DefectDojo documentation.
--username TEXT Username or Email Address, see DefectDojo
documentation for more information.
--password TEXT Password or API Token, see DefectDojo
documentation for more information.
--default-issue-type TEXT You can define extra issue types in
settings.py * `Task` - Task * `Story` -
Story * `Epic` - Epic * `Spike` - Spike *
`Bug` - Bug * `Security` - Security
--issue-template-dir TEXT Choose the folder containing the Django
templates used to render the JIRA issue
description. These are stored in
dojo/templates/issue-trackers. Leave empty
to use the default jira_full templates.
--epic-name-id INTEGER To obtain the 'Epic name id' visit
https://<YOUR JIRA URL>/rest/api/2/field and
search for Epic Name. Copy the number out of
cf[number] and paste it here.
--open-status-key INTEGER Transition ID to Re-Open JIRA issues, visit
https://<YOUR JIRA
URL>/rest/api/latest/issue/<ANY VALID ISSUE
KEY>/transitions?expand=transitions.fields
to find the ID for your JIRA instance
--close-status-key INTEGER Transition ID to Close JIRA issues, visit
https://<YOUR JIRA
URL>/rest/api/latest/issue/<ANY VALID ISSUE
KEY>/transitions?expand=transitions.fields
to find the ID for your JIRA instance
--info-mapping-severity TEXT Maps to the 'Priority' field in Jira. For
example: Info
--low-mapping-severity TEXT Maps to the 'Priority' field in Jira. For
example: Low
--medium-mapping-severity TEXT Maps to the 'Priority' field in Jira. For
example: Medium
--high-mapping-severity TEXT Maps to the 'Priority' field in Jira. For
example: High
--critical-mapping-severity TEXT
Maps to the 'Priority' field in Jira. For
example: Critical
--finding-text TEXT Additional text that will be added to the
finding in Jira. For example including how
the finding was created or who to contact
for more information.
--accepted-mapping-resolution TEXT
JIRA issues that are closed in JIRA with one
of these resolutions will result in the
Finding becoming Risk Accepted in Defect
Dojo. JIRA issues that are closed in JIRA
with one of these resolutions will result in
the Finding becoming Risk Accepted in Defect
Dojo. The expiration time for this Risk
Acceptance will be determined by the "Risk
acceptance form default days" in "System
Settings". This mapping is not used when
Findings are pushed to JIRA. In that case
the Risk Accepted Findings are closed in
JIRA and JIRA sets the default resolution.
--false-positive-mapping-resolution TEXT
JIRA issues that are closed in JIRA with one
of these resolutions will result in the
Finding being marked as False Positive
Defect Dojo. This mapping is not used when
Findings are pushed to JIRA. In that case
the Finding is closed in JIRA and JIRA sets
the default resolution.
--global-jira-sla-notification This setting can be overidden at the Product
level
--finding-jira-sync If enabled, this will sync changes to a
Finding automatically to JIRA
--help Show this message and exit.
dojo api jira-configurations delete-preview-list
delete_preview_list
Usage:
dojo api jira-configurations delete-preview-list [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this jir
a_ instance. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api jira-configurations destroy
destroy
Usage:
dojo api jira-configurations destroy [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this jir a_ instance.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api jira-configurations list
list
Usage:
dojo api jira-configurations list [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--id INTEGER
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
--url TEXT
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api jira-configurations partial-update
partial_update
Usage:
dojo api jira-configurations partial-update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this jir
a_ instance. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--patched-jira-instance-request TEXT
--help Show this message and exit.
dojo api jira-configurations retrieve
retrieve
Usage:
dojo api jira-configurations retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this jir a_ instance.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api jira-configurations update
update
Usage:
dojo api jira-configurations update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this jir a_
instance. [required]
--jira-instance-request TEXT [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--help Show this message and exit.
dojo api jira-finding-mappings
methods from JiraFindingMappingsApi.
Usage:
dojo api jira-finding-mappings [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
- create: create
- delete-preview-list: delete_preview_list
- destroy: destroy
- list: list
- partial-update: partial_update
- retrieve: retrieve
- update: update
dojo api jira-finding-mappings create
create
Usage:
dojo api jira-finding-mappings create [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--jira-id TEXT
--jira-key TEXT
--jira-creation DATETIME The date a Jira issue was created from this
finding.
--jira-change DATETIME The date the linked Jira issue was last modified.
--jira-project INTEGER
--finding INTEGER
--engagement INTEGER
--finding-group INTEGER
--help Show this message and exit.
dojo api jira-finding-mappings delete-preview-list
delete_preview_list
Usage:
dojo api jira-finding-mappings delete-preview-list [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this jir
a_ issue. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api jira-finding-mappings destroy
destroy
Usage:
dojo api jira-finding-mappings destroy [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this jir a_ issue.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api jira-finding-mappings list
list
Usage:
dojo api jira-finding-mappings list [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--engagement INTEGER
--finding INTEGER
--finding-group INTEGER
--id INTEGER
--jira-id TEXT
--jira-key TEXT
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api jira-finding-mappings partial-update
partial_update
Usage:
dojo api jira-finding-mappings partial-update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this jir
a_ issue. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--patched-jira-issue-request TEXT
--help Show this message and exit.
dojo api jira-finding-mappings retrieve
retrieve
Usage:
dojo api jira-finding-mappings retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this jir a_ issue.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api jira-finding-mappings update
update
Usage:
dojo api jira-finding-mappings update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this jir a_
issue. [required]
--jira-issue-request TEXT [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api jira-instances
methods from JiraInstancesApi.
Usage:
dojo api jira-instances [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
- create: create
- delete-preview-list: delete_preview_list
- destroy: destroy
- list: list
- partial-update: partial_update
- retrieve: retrieve
- update: update
dojo api jira-instances create
create
Usage:
dojo api jira-instances create [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--configuration-name TEXT Enter a name to give to this configuration
--url TEXT For more information how to configure Jira,
read the DefectDojo documentation.
--username TEXT Username or Email Address, see DefectDojo
documentation for more information.
--password TEXT Password or API Token, see DefectDojo
documentation for more information.
--default-issue-type TEXT You can define extra issue types in
settings.py * `Task` - Task * `Story` -
Story * `Epic` - Epic * `Spike` - Spike *
`Bug` - Bug * `Security` - Security
--issue-template-dir TEXT Choose the folder containing the Django
templates used to render the JIRA issue
description. These are stored in
dojo/templates/issue-trackers. Leave empty
to use the default jira_full templates.
--epic-name-id INTEGER To obtain the 'Epic name id' visit
https://<YOUR JIRA URL>/rest/api/2/field and
search for Epic Name. Copy the number out of
cf[number] and paste it here.
--open-status-key INTEGER Transition ID to Re-Open JIRA issues, visit
https://<YOUR JIRA
URL>/rest/api/latest/issue/<ANY VALID ISSUE
KEY>/transitions?expand=transitions.fields
to find the ID for your JIRA instance
--close-status-key INTEGER Transition ID to Close JIRA issues, visit
https://<YOUR JIRA
URL>/rest/api/latest/issue/<ANY VALID ISSUE
KEY>/transitions?expand=transitions.fields
to find the ID for your JIRA instance
--info-mapping-severity TEXT Maps to the 'Priority' field in Jira. For
example: Info
--low-mapping-severity TEXT Maps to the 'Priority' field in Jira. For
example: Low
--medium-mapping-severity TEXT Maps to the 'Priority' field in Jira. For
example: Medium
--high-mapping-severity TEXT Maps to the 'Priority' field in Jira. For
example: High
--critical-mapping-severity TEXT
Maps to the 'Priority' field in Jira. For
example: Critical
--finding-text TEXT Additional text that will be added to the
finding in Jira. For example including how
the finding was created or who to contact
for more information.
--accepted-mapping-resolution TEXT
JIRA issues that are closed in JIRA with one
of these resolutions will result in the
Finding becoming Risk Accepted in Defect
Dojo. JIRA issues that are closed in JIRA
with one of these resolutions will result in
the Finding becoming Risk Accepted in Defect
Dojo. The expiration time for this Risk
Acceptance will be determined by the "Risk
acceptance form default days" in "System
Settings". This mapping is not used when
Findings are pushed to JIRA. In that case
the Risk Accepted Findings are closed in
JIRA and JIRA sets the default resolution.
--false-positive-mapping-resolution TEXT
JIRA issues that are closed in JIRA with one
of these resolutions will result in the
Finding being marked as False Positive
Defect Dojo. This mapping is not used when
Findings are pushed to JIRA. In that case
the Finding is closed in JIRA and JIRA sets
the default resolution.
--global-jira-sla-notification This setting can be overidden at the Product
level
--finding-jira-sync If enabled, this will sync changes to a
Finding automatically to JIRA
--help Show this message and exit.
dojo api jira-instances delete-preview-list
delete_preview_list
Usage:
dojo api jira-instances delete-preview-list [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this jir
a_ instance. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api jira-instances destroy
destroy
Usage:
dojo api jira-instances destroy [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this jir a_ instance.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api jira-instances list
list
Usage:
dojo api jira-instances list [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--id INTEGER
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
--url TEXT
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api jira-instances partial-update
partial_update
Usage:
dojo api jira-instances partial-update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this jir
a_ instance. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--patched-jira-instance-request TEXT
--help Show this message and exit.
dojo api jira-instances retrieve
retrieve
Usage:
dojo api jira-instances retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this jir a_ instance.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api jira-instances update
update
Usage:
dojo api jira-instances update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this jir a_
instance. [required]
--jira-instance-request TEXT [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--help Show this message and exit.
dojo api jira-product-configurations
methods from JiraProductConfigurationsApi.
Usage:
dojo api jira-product-configurations [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
- create: create
- delete-preview-list: delete_preview_list
- destroy: destroy
- list: list
- partial-update: partial_update
- retrieve: retrieve
- update: update
dojo api jira-product-configurations create
create
Usage:
dojo api jira-product-configurations create [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--project-key TEXT
--issue-template-dir TEXT Choose the folder containing the Django
templates used to render the JIRA issue
description. These are stored in
dojo/templates/issue-trackers. Leave empty
to use the default jira_full templates.
--component TEXT
--custom-fields TEXT JIRA custom field JSON mapping of Id to
value, e.g. {"customfield_10122": [{"name":
"8.0.1"}]}
--default-assignee TEXT JIRA default assignee (name). If left blank
then it defaults to whatever is configured
in JIRA.
--jira-labels TEXT JIRA issue labels space seperated
--add-vulnerability-id-to-jira-label
--push-all-issues Automatically create JIRA tickets for
verified findings, assuming
enforce_verified_status is True, or for all
findings otherwise. Once linked, the JIRA
ticket will continue to sync, regardless of
status in DefectDojo.
--enable-engagement-epic-mapping
--epic-issue-type-name TEXT The name of the of structure that represents
an Epic
--push-notes
--product-jira-sla-notification
--risk-acceptance-expiration-notification
--enabled When disabled, Findings will no longer be
pushed to Jira, even if they have already
been pushed previously.
--jira-instance INTEGER
--product INTEGER
--engagement INTEGER
--help Show this message and exit.
dojo api jira-product-configurations delete-preview-list
delete_preview_list
Usage:
dojo api jira-product-configurations delete-preview-list [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this jir
a_ project. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api jira-product-configurations destroy
destroy
Usage:
dojo api jira-product-configurations destroy [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this jir a_ project.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api jira-product-configurations list
list
Usage:
dojo api jira-product-configurations list [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--component TEXT
--enable-engagement-epic-mapping
--enabled
--engagement INTEGER
--id INTEGER
--jira-instance INTEGER
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
--prefetch TEXT List of fields for which to prefetch model
instances and add those to the response
--product INTEGER
--project-key TEXT
--push-all-issues
--push-notes
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api jira-product-configurations partial-update
partial_update
Usage:
dojo api jira-product-configurations partial-update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this jir
a_ project. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--patched-jira-project-request TEXT
--help Show this message and exit.
dojo api jira-product-configurations retrieve
retrieve
Usage:
dojo api jira-product-configurations retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this jir a_ project.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--prefetch TEXT List of fields for which to prefetch model instances and
add those to the response
--help Show this message and exit.
dojo api jira-product-configurations update
update
Usage:
dojo api jira-product-configurations update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this jir a_
project. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--jira-project-request TEXT
--help Show this message and exit.
dojo api jira-projects
methods from JiraProjectsApi.
Usage:
dojo api jira-projects [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
- create: create
- delete-preview-list: delete_preview_list
- destroy: destroy
- list: list
- partial-update: partial_update
- retrieve: retrieve
- update: update
dojo api jira-projects create
create
Usage:
dojo api jira-projects create [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--project-key TEXT
--issue-template-dir TEXT Choose the folder containing the Django
templates used to render the JIRA issue
description. These are stored in
dojo/templates/issue-trackers. Leave empty
to use the default jira_full templates.
--component TEXT
--custom-fields TEXT JIRA custom field JSON mapping of Id to
value, e.g. {"customfield_10122": [{"name":
"8.0.1"}]}
--default-assignee TEXT JIRA default assignee (name). If left blank
then it defaults to whatever is configured
in JIRA.
--jira-labels TEXT JIRA issue labels space seperated
--add-vulnerability-id-to-jira-label
--push-all-issues Automatically create JIRA tickets for
verified findings, assuming
enforce_verified_status is True, or for all
findings otherwise. Once linked, the JIRA
ticket will continue to sync, regardless of
status in DefectDojo.
--enable-engagement-epic-mapping
--epic-issue-type-name TEXT The name of the of structure that represents
an Epic
--push-notes
--product-jira-sla-notification
--risk-acceptance-expiration-notification
--enabled When disabled, Findings will no longer be
pushed to Jira, even if they have already
been pushed previously.
--jira-instance INTEGER
--product INTEGER
--engagement INTEGER
--help Show this message and exit.
dojo api jira-projects delete-preview-list
delete_preview_list
Usage:
dojo api jira-projects delete-preview-list [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this jir
a_ project. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api jira-projects destroy
destroy
Usage:
dojo api jira-projects destroy [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this jir a_ project.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api jira-projects list
list
Usage:
dojo api jira-projects list [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--component TEXT
--enable-engagement-epic-mapping
--enabled
--engagement INTEGER
--id INTEGER
--jira-instance INTEGER
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
--prefetch TEXT List of fields for which to prefetch model
instances and add those to the response
--product INTEGER
--project-key TEXT
--push-all-issues
--push-notes
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api jira-projects partial-update
partial_update
Usage:
dojo api jira-projects partial-update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this jir
a_ project. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--patched-jira-project-request TEXT
--help Show this message and exit.
dojo api jira-projects retrieve
retrieve
Usage:
dojo api jira-projects retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this jir a_ project.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--prefetch TEXT List of fields for which to prefetch model instances and
add those to the response
--help Show this message and exit.
dojo api jira-projects update
update
Usage:
dojo api jira-projects update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this jir a_
project. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--jira-project-request TEXT
--help Show this message and exit.
dojo api language-types
methods from LanguageTypesApi.
Usage:
dojo api language-types [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
- create: create
- delete-preview-list: delete_preview_list
- destroy: destroy
- list: list
- partial-update: partial_update
- retrieve: retrieve
- update: update
dojo api language-types create
create
Usage:
dojo api language-types create [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--language TEXT
--color TEXT
--help Show this message and exit.
dojo api language-types delete-preview-list
delete_preview_list
Usage:
dojo api language-types delete-preview-list [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
language_ type. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api language-types destroy
destroy
Usage:
dojo api language-types destroy [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this language_ type.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api language-types list
list
Usage:
dojo api language-types list [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--color TEXT
--id INTEGER
--language TEXT
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api language-types partial-update
partial_update
Usage:
dojo api language-types partial-update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
language_ type. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--patched-language-type-request TEXT
--help Show this message and exit.
dojo api language-types retrieve
retrieve
Usage:
dojo api language-types retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this language_ type.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api language-types update
update
Usage:
dojo api language-types update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
language_ type. [required]
--language-type-request TEXT [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--help Show this message and exit.
dojo api languages
methods from LanguagesApi.
Usage:
dojo api languages [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
- create: create
- delete-preview-list: delete_preview_list
- destroy: destroy
- list: list
- partial-update: partial_update
- retrieve: retrieve
- update: update
dojo api languages create
create
Usage:
dojo api languages create [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--files INTEGER
--blank INTEGER
--comment INTEGER
--code INTEGER
--language INTEGER
--product INTEGER
--user INTEGER
--help Show this message and exit.
dojo api languages delete-preview-list
delete_preview_list
Usage:
dojo api languages delete-preview-list [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
languages. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api languages destroy
destroy
Usage:
dojo api languages destroy [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this languages. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api languages list
list
Usage:
dojo api languages list [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--id INTEGER
--language INTEGER
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
--prefetch TEXT List of fields for which to prefetch model
instances and add those to the response
--product INTEGER
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api languages partial-update
partial_update
Usage:
dojo api languages partial-update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
languages. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--patched-language-request TEXT
--help Show this message and exit.
dojo api languages retrieve
retrieve
Usage:
dojo api languages retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this languages.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--prefetch TEXT List of fields for which to prefetch model instances and
add those to the response
--help Show this message and exit.
dojo api languages update
update
Usage:
dojo api languages update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this languages.
[required]
--language-request TEXT [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api metadata
methods from MetadataApi.
Usage:
dojo api metadata [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
- batch-create: batch_create
- batch-partial-update: batch_partial_update
- create: create
- delete-preview-list: delete_preview_list
- destroy: destroy
- list: list
- partial-update: partial_update
- retrieve: retrieve
- update: update
dojo api metadata batch-create
batch_create
Usage:
dojo api metadata batch-create [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--product INTEGER
--endpoint INTEGER
--finding INTEGER
--metadata TEXT
--help Show this message and exit.
dojo api metadata batch-partial-update
batch_partial_update
Usage:
dojo api metadata batch-partial-update [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--product INTEGER
--endpoint INTEGER
--finding INTEGER
--metadata TEXT
--help Show this message and exit.
dojo api metadata create
create
Usage:
dojo api metadata create [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--product INTEGER
--endpoint INTEGER
--location INTEGER
--finding INTEGER
--name TEXT
--value TEXT
--help Show this message and exit.
dojo api metadata delete-preview-list
delete_preview_list
Usage:
dojo api metadata delete-preview-list [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this dojo
meta. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api metadata destroy
destroy
Usage:
dojo api metadata destroy [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this dojo meta. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api metadata list
list
Usage:
dojo api metadata list [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--endpoint INTEGER
--finding INTEGER
--id INTEGER
--limit INTEGER Number of results to return per page.
--location INTEGER
--name TEXT
--name-case-insensitive TEXT
--offset INTEGER The initial index from which to return the
results.
--product INTEGER
--value TEXT
--value-case-insensitive TEXT
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api metadata partial-update
partial_update
Usage:
dojo api metadata partial-update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this dojo
meta. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--patched-meta-request TEXT
--help Show this message and exit.
dojo api metadata retrieve
retrieve
Usage:
dojo api metadata retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this dojo meta. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api metadata update
update
Usage:
dojo api metadata update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this dojo meta.
[required]
--meta-request TEXT [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api network-locations
methods from NetworkLocationsApi.
Usage:
dojo api network-locations [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
- create: create
- delete-preview-list: delete_preview_list
- destroy: destroy
- list: list
- partial-update: partial_update
- retrieve: retrieve
- update: update
dojo api network-locations create
create
Usage:
dojo api network-locations create [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--location TEXT Location of network testing: Examples: VPN, Internet or
Internal.
--help Show this message and exit.
dojo api network-locations delete-preview-list
delete_preview_list
Usage:
dojo api network-locations delete-preview-list [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
network_ locations. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api network-locations destroy
destroy
Usage:
dojo api network-locations destroy [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this network_ locations.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api network-locations list
list
Usage:
dojo api network-locations list [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--id INTEGER
--limit INTEGER Number of results to return per page.
--location TEXT
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api network-locations partial-update
partial_update
Usage:
dojo api network-locations partial-update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
network_ locations. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--patched-network-locations-request TEXT
--help Show this message and exit.
dojo api network-locations retrieve
retrieve
Usage:
dojo api network-locations retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this network_ locations.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api network-locations update
update
Usage:
dojo api network-locations update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
network_ locations. [required]
--network-locations-request TEXT
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--help Show this message and exit.
dojo api note-type
methods from NoteTypeApi.
Usage:
dojo api note-type [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
- create: create
- delete-preview-list: delete_preview_list
- destroy: destroy
- list: list
- partial-update: partial_update
- retrieve: retrieve
- update: update
dojo api note-type create
create
Usage:
dojo api note-type create [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--name TEXT
--description TEXT
--is-single
--is-active
--is-mandatory
--help Show this message and exit.
dojo api note-type delete-preview-list
delete_preview_list
Usage:
dojo api note-type delete-preview-list [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
note_ type. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api note-type destroy
destroy
Usage:
dojo api note-type destroy [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this note_ type.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api note-type list
list
Usage:
dojo api note-type list [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--description TEXT
--id INTEGER
--is-active
--is-mandatory
--is-single
--limit INTEGER Number of results to return per page.
--name TEXT
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api note-type partial-update
partial_update
Usage:
dojo api note-type partial-update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
note_ type. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--patched-note-type-request TEXT
--help Show this message and exit.
dojo api note-type retrieve
retrieve
Usage:
dojo api note-type retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this note_ type.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api note-type update
update
Usage:
dojo api note-type update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this note_
type. [required]
--note-type-request TEXT [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api notes
methods from NotesApi.
Usage:
dojo api notes [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
- list: list
- partial-update: partial_update
- retrieve: retrieve
- update: update
dojo api notes list
list
Usage:
dojo api notes list [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--author INTEGER
--var-date DATETIME
--edit-time DATETIME
--edited
--editor INTEGER
--entry TEXT
--id INTEGER
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
--private
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api notes partial-update
partial_update
Usage:
dojo api notes partial-update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this notes.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--patched-note-request TEXT
--help Show this message and exit.
dojo api notes retrieve
retrieve
Usage:
dojo api notes retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this notes. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api notes update
update
Usage:
dojo api notes update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this notes.
[required]
--note-request TEXT [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api notification-webhooks
methods from NotificationWebhooksApi.
Usage:
dojo api notification-webhooks [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
- create: create
- delete-preview-list: delete_preview_list
- destroy: destroy
- list: list
- partial-update: partial_update
- retrieve: retrieve
- update: update
dojo api notification-webhooks create
create
Usage:
dojo api notification-webhooks create [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--name TEXT Name of the incoming webhook
--url TEXT The full URL of the incoming webhook
--header-name TEXT Name of the header required for interacting with
Webhook endpoint
--header-value TEXT Content of the header required for interacting with
Webhook endpoint
--owner INTEGER Owner/receiver of notification, if empty processed as
system notification
--help Show this message and exit.
dojo api notification-webhooks delete-preview-list
delete_preview_list
Usage:
dojo api notification-webhooks delete-preview-list [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
notification_ webhooks. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api notification-webhooks destroy
destroy
Usage:
dojo api notification-webhooks destroy [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this notification_
webhooks. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api notification-webhooks list
list
Usage:
dojo api notification-webhooks list [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--first-error DATETIME
--header-name TEXT
--header-value TEXT
--last-error DATETIME
--limit INTEGER Number of results to return per page.
--name TEXT
--note TEXT
--offset INTEGER The initial index from which to return the
results.
--owner INTEGER
--status TEXT Status of the incoming webhook * `active` -
Active * `active_tmp` - Active but 5xx (or
similar) error detected * `inactive_tmp` -
Temporary inactive because of 5xx (or
similar) error * `inactive_permanent` -
Permanently inactive
--url TEXT
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api notification-webhooks partial-update
partial_update
Usage:
dojo api notification-webhooks partial-update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
notification_ webhooks. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--patched-notification-webhooks-request TEXT
--help Show this message and exit.
dojo api notification-webhooks retrieve
retrieve
Usage:
dojo api notification-webhooks retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this notification_
webhooks. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api notification-webhooks update
update
Usage:
dojo api notification-webhooks update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
notification_ webhooks. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--notification-webhooks-request TEXT
--help Show this message and exit.
dojo api notifications
methods from NotificationsApi.
Usage:
dojo api notifications [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
- create: create
- delete-preview-list: delete_preview_list
- destroy: destroy
- list: list
- partial-update: partial_update
- retrieve: retrieve
- update: update
dojo api notifications create
create
Usage:
dojo api notifications create [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--product INTEGER
--user INTEGER
--product-type-added TEXT
--product-added TEXT
--engagement-added TEXT
--test-added TEXT
--scan-added TEXT
--jira-update TEXT
--upcoming-engagement TEXT
--stale-engagement TEXT
--auto-close-engagement TEXT
--close-engagement TEXT
--user-mentioned TEXT
--code-review TEXT
--review-requested TEXT
--other TEXT
--sla-breach TEXT
--sla-breach-combined TEXT
--risk-acceptance-expiration TEXT
--template
--scan-added-empty TEXT Triggered whenever an (re-)import has been
done (even if that created/updated/closed no
findings). * `slack` - slack * `msteams` -
msteams * `mail` - mail * `webhooks` -
webhooks * `alert` - alert
--help Show this message and exit.
dojo api notifications delete-preview-list
delete_preview_list
Usage:
dojo api notifications delete-preview-list [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
notifications. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api notifications destroy
destroy
Usage:
dojo api notifications destroy [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this notifications.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api notifications list
list
Usage:
dojo api notifications list [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--id INTEGER
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
--prefetch TEXT List of fields for which to prefetch model
instances and add those to the response
--product INTEGER
--template
--user INTEGER
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api notifications partial-update
partial_update
Usage:
dojo api notifications partial-update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
notifications. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--patched-notifications-request TEXT
--help Show this message and exit.
dojo api notifications retrieve
retrieve
Usage:
dojo api notifications retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this notifications.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--prefetch TEXT List of fields for which to prefetch model instances and
add those to the response
--help Show this message and exit.
dojo api notifications update
update
Usage:
dojo api notifications update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
notifications. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--notifications-request TEXT
--help Show this message and exit.
dojo api oa3
schema_retrieve
Usage:
dojo api oa3 [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--format TEXT
--lang TEXT
--help Show this message and exit.
dojo api organization-groups
methods from OrganizationGroupsApi.
Usage:
dojo api organization-groups [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
- create: create
- delete-preview-list: delete_preview_list
- destroy: destroy
- list: list
- retrieve: retrieve
- update: update
dojo api organization-groups create
create
Usage:
dojo api organization-groups create [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--organization INTEGER
--group INTEGER
--role INTEGER
--help Show this message and exit.
dojo api organization-groups delete-preview-list
delete_preview_list
Usage:
dojo api organization-groups delete-preview-list [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
product_ type_ group. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api organization-groups destroy
destroy
Usage:
dojo api organization-groups destroy [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this product_ type_ group.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api organization-groups list
list
Usage:
dojo api organization-groups list [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--asset-type-id FLOAT
--group-id INTEGER
--id INTEGER
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
--prefetch TEXT List of fields for which to prefetch model
instances and add those to the response
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api organization-groups retrieve
retrieve
Usage:
dojo api organization-groups retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this product_ type_
group. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--prefetch TEXT List of fields for which to prefetch model instances and
add those to the response
--help Show this message and exit.
dojo api organization-groups update
update
Usage:
dojo api organization-groups update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
product_ type_ group. [required]
--organization-group-request TEXT
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--help Show this message and exit.
dojo api organization-members
methods from OrganizationMembersApi.
Usage:
dojo api organization-members [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
- create: create
- delete-preview-list: delete_preview_list
- destroy: destroy
- list: list
- retrieve: retrieve
- update: update
dojo api organization-members create
create
Usage:
dojo api organization-members create [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--organization INTEGER
--user INTEGER
--role INTEGER
--help Show this message and exit.
dojo api organization-members delete-preview-list
delete_preview_list
Usage:
dojo api organization-members delete-preview-list [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
product_ type_ member. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api organization-members destroy
destroy
Usage:
dojo api organization-members destroy [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this product_ type_ member.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api organization-members list
list
Usage:
dojo api organization-members list [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--id INTEGER
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
--organization-id FLOAT
--prefetch TEXT List of fields for which to prefetch model
instances and add those to the response
--user-id INTEGER
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api organization-members retrieve
retrieve
Usage:
dojo api organization-members retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this product_ type_
member. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--prefetch TEXT List of fields for which to prefetch model instances and
add those to the response
--help Show this message and exit.
dojo api organization-members update
update
Usage:
dojo api organization-members update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
product_ type_ member. [required]
--organization-member-request TEXT
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--help Show this message and exit.
dojo api organizations
methods from OrganizationsApi.
Usage:
dojo api organizations [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
- create: create
- delete-preview-list: delete_preview_list
- destroy: destroy
- generate-report-create: generate_report_create
- list: list
- partial-update: partial_update
- retrieve: retrieve
- update: update
dojo api organizations create
create
Usage:
dojo api organizations create [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--critical-asset
--key-asset
--name TEXT
--description TEXT
--help Show this message and exit.
dojo api organizations delete-preview-list
delete_preview_list
Usage:
dojo api organizations delete-preview-list [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
product_ type. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api organizations destroy
destroy
Usage:
dojo api organizations destroy [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this product_ type.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api organizations generate-report-create
generate_report_create
Usage:
dojo api organizations generate-report-create [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
product_ type. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--report-generate-option-request TEXT
--help Show this message and exit.
dojo api organizations list
list
Usage:
dojo api organizations list [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--created DATETIME
--critical-asset
--id INTEGER
--key-asset
--limit INTEGER Number of results to return per page.
--name TEXT
--offset INTEGER The initial index from which to return the
results.
--prefetch TEXT List of fields for which to prefetch model
instances and add those to the response
--updated DATETIME
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api organizations partial-update
partial_update
Usage:
dojo api organizations partial-update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
product_ type. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--patched-organization-request TEXT
--help Show this message and exit.
dojo api organizations retrieve
retrieve
Usage:
dojo api organizations retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this product_ type.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--prefetch TEXT List of fields for which to prefetch model instances and
add those to the response
--help Show this message and exit.
dojo api organizations update
update
Usage:
dojo api organizations update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
product_ type. [required]
--organization-request TEXT [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--help Show this message and exit.
dojo api product-api-scan-configurations
methods from ProductApiScanConfigurationsApi.
Usage:
dojo api product-api-scan-configurations [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
- create: create
- delete-preview-list: delete_preview_list
- destroy: destroy
- list: list
- partial-update: partial_update
- retrieve: retrieve
- update: update
dojo api product-api-scan-configurations create
create
Usage:
dojo api product-api-scan-configurations create [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--service-key-1 TEXT
--service-key-2 TEXT
--service-key-3 TEXT
--product INTEGER
--tool-configuration INTEGER
--help Show this message and exit.
dojo api product-api-scan-configurations delete-preview-list
delete_preview_list
Usage:
dojo api product-api-scan-configurations delete-preview-list
[OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
product_ap i_ scan_ configuration.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api product-api-scan-configurations destroy
destroy
Usage:
dojo api product-api-scan-configurations destroy [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this product_ap i_ scan_
configuration. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api product-api-scan-configurations list
list
Usage:
dojo api product-api-scan-configurations list [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--id INTEGER
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
--prefetch TEXT List of fields for which to prefetch model
instances and add those to the response
--product INTEGER
--service-key-1 TEXT
--service-key-2 TEXT
--service-key-3 TEXT
--tool-configuration INTEGER
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api product-api-scan-configurations partial-update
partial_update
Usage:
dojo api product-api-scan-configurations partial-update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
product_ap i_ scan_ configuration.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--patched-product-api-scan-configuration-request TEXT
--help Show this message and exit.
dojo api product-api-scan-configurations retrieve
retrieve
Usage:
dojo api product-api-scan-configurations retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this product_ap i_ scan_
configuration. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--prefetch TEXT List of fields for which to prefetch model instances and
add those to the response
--help Show this message and exit.
dojo api product-api-scan-configurations update
update
Usage:
dojo api product-api-scan-configurations update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
product_ap i_ scan_ configuration.
[required]
--product-api-scan-configuration-request TEXT
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--help Show this message and exit.
dojo api product-groups
methods from ProductGroupsApi.
Usage:
dojo api product-groups [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
- create: create
- delete-preview-list: delete_preview_list
- destroy: destroy
- list: list
- retrieve: retrieve
- update: update
dojo api product-groups create
create
Usage:
dojo api product-groups create [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--product INTEGER
--group INTEGER
--role INTEGER
--help Show this message and exit.
dojo api product-groups delete-preview-list
delete_preview_list
Usage:
dojo api product-groups delete-preview-list [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
product_ group. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api product-groups destroy
destroy
Usage:
dojo api product-groups destroy [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this product_ group.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api product-groups list
list
Usage:
dojo api product-groups list [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--group-id INTEGER
--id INTEGER
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
--prefetch TEXT List of fields for which to prefetch model
instances and add those to the response
--product-id INTEGER
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api product-groups retrieve
retrieve
Usage:
dojo api product-groups retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this product_ group.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--prefetch TEXT List of fields for which to prefetch model instances and
add those to the response
--help Show this message and exit.
dojo api product-groups update
update
Usage:
dojo api product-groups update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
product_ group. [required]
--product-group-request TEXT [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--help Show this message and exit.
dojo api product-members
methods from ProductMembersApi.
Usage:
dojo api product-members [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
- create: create
- delete-preview-list: delete_preview_list
- destroy: destroy
- list: list
- retrieve: retrieve
- update: update
dojo api product-members create
create
Usage:
dojo api product-members create [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--product INTEGER
--user INTEGER
--role INTEGER
--help Show this message and exit.
dojo api product-members delete-preview-list
delete_preview_list
Usage:
dojo api product-members delete-preview-list [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
product_ member. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api product-members destroy
destroy
Usage:
dojo api product-members destroy [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this product_ member.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api product-members list
list
Usage:
dojo api product-members list [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--id INTEGER
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
--prefetch TEXT List of fields for which to prefetch model
instances and add those to the response
--product-id INTEGER
--user-id INTEGER
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api product-members retrieve
retrieve
Usage:
dojo api product-members retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this product_ member.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--prefetch TEXT List of fields for which to prefetch model instances and
add those to the response
--help Show this message and exit.
dojo api product-members update
update
Usage:
dojo api product-members update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
product_ member. [required]
--product-member-request TEXT [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--help Show this message and exit.
dojo api product-type-groups
methods from ProductTypeGroupsApi.
Usage:
dojo api product-type-groups [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
- create: create
- delete-preview-list: delete_preview_list
- destroy: destroy
- list: list
- retrieve: retrieve
- update: update
dojo api product-type-groups create
create
Usage:
dojo api product-type-groups create [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--product-type INTEGER
--group INTEGER
--role INTEGER
--help Show this message and exit.
dojo api product-type-groups delete-preview-list
delete_preview_list
Usage:
dojo api product-type-groups delete-preview-list [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
product_ type_ group. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api product-type-groups destroy
destroy
Usage:
dojo api product-type-groups destroy [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this product_ type_ group.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api product-type-groups list
list
Usage:
dojo api product-type-groups list [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--group-id INTEGER
--id INTEGER
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
--prefetch TEXT List of fields for which to prefetch model
instances and add those to the response
--product-type-id INTEGER
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api product-type-groups retrieve
retrieve
Usage:
dojo api product-type-groups retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this product_ type_
group. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--prefetch TEXT List of fields for which to prefetch model instances and
add those to the response
--help Show this message and exit.
dojo api product-type-groups update
update
Usage:
dojo api product-type-groups update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
product_ type_ group. [required]
--product-type-group-request TEXT
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--help Show this message and exit.
dojo api product-type-members
methods from ProductTypeMembersApi.
Usage:
dojo api product-type-members [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
- create: create
- delete-preview-list: delete_preview_list
- destroy: destroy
- list: list
- retrieve: retrieve
- update: update
dojo api product-type-members create
create
Usage:
dojo api product-type-members create [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--product-type INTEGER
--user INTEGER
--role INTEGER
--help Show this message and exit.
dojo api product-type-members delete-preview-list
delete_preview_list
Usage:
dojo api product-type-members delete-preview-list [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
product_ type_ member. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api product-type-members destroy
destroy
Usage:
dojo api product-type-members destroy [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this product_ type_ member.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api product-type-members list
list
Usage:
dojo api product-type-members list [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--id INTEGER
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
--prefetch TEXT List of fields for which to prefetch model
instances and add those to the response
--product-type-id INTEGER
--user-id INTEGER
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api product-type-members retrieve
retrieve
Usage:
dojo api product-type-members retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this product_ type_
member. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--prefetch TEXT List of fields for which to prefetch model instances and
add those to the response
--help Show this message and exit.
dojo api product-type-members update
update
Usage:
dojo api product-type-members update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
product_ type_ member. [required]
--product-type-member-request TEXT
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--help Show this message and exit.
dojo api product-types
methods from ProductTypesApi.
Usage:
dojo api product-types [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
- create: create
- delete-preview-list: delete_preview_list
- destroy: destroy
- generate-report-create: generate_report_create
- list: list
- partial-update: partial_update
- retrieve: retrieve
- update: update
dojo api product-types create
create
Usage:
dojo api product-types create [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--name TEXT
--description TEXT
--critical-product
--key-product
--help Show this message and exit.
dojo api product-types delete-preview-list
delete_preview_list
Usage:
dojo api product-types delete-preview-list [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
product_ type. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api product-types destroy
destroy
Usage:
dojo api product-types destroy [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this product_ type.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api product-types generate-report-create
generate_report_create
Usage:
dojo api product-types generate-report-create [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
product_ type. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--report-generate-option-request TEXT
--help Show this message and exit.
dojo api product-types list
list
Usage:
dojo api product-types list [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--created DATETIME
--critical-product
--id INTEGER
--key-product
--limit INTEGER Number of results to return per page.
--name TEXT
--offset INTEGER The initial index from which to return the
results.
--prefetch TEXT List of fields for which to prefetch model
instances and add those to the response
--updated DATETIME
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api product-types partial-update
partial_update
Usage:
dojo api product-types partial-update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
product_ type. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--patched-product-type-request TEXT
--help Show this message and exit.
dojo api product-types retrieve
retrieve
Usage:
dojo api product-types retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this product_ type.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--prefetch TEXT List of fields for which to prefetch model instances and
add those to the response
--help Show this message and exit.
dojo api product-types update
update
Usage:
dojo api product-types update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
product_ type. [required]
--product-type-request TEXT [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--help Show this message and exit.
dojo api products
methods from ProductsApi.
Usage:
dojo api products [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
- create: create
- delete-preview-list: delete_preview_list
- destroy: destroy
- generate-report-create: generate_report_create
- list: list
- partial-update: partial_update
- retrieve: retrieve
- update: update
dojo api products create
create
Usage:
dojo api products create [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--business-criticality TEXT * `very high` - Very High * `high` - High *
`medium` - Medium * `low` - Low * `very low`
- Very Low * `none` - None
--platform TEXT * `web service` - API * `desktop` - Desktop
* `iot` - Internet of Things * `mobile` -
Mobile * `web` - Web
--lifecycle TEXT * `construction` - Construction *
`production` - Production * `retirement` -
Retirement
--origin TEXT * `third party library` - Third Party
Library * `purchased` - Purchased *
`contractor` - Contractor Developed *
`internal` - Internally Developed * `open
source` - Open Source * `outsourced` -
Outsourced
--tags TEXT
--name TEXT
--description TEXT
--prod-numeric-grade INTEGER
--user-records INTEGER Estimate the number of user records within
the application.
--revenue TEXT Estimate the application's revenue.
--external-audience Specify if the application is used by people
outside the organization.
--internet-accessible Specify if the application is accessible
from the public internet.
--enable-product-tag-inheritance
Enables product tag inheritance. Any tags
added on a product will automatically be
added to all Engagements, Tests, and
Findings
--enable-simple-risk-acceptance
Allows simple risk acceptance by
checking/unchecking a checkbox.
--enable-full-risk-acceptance Allows full risk acceptance using a risk
acceptance form, expiration date, uploaded
proof, etc.
--disable-sla-breach-notifications
Disable SLA breach notifications if
configured in the global settings
--product-manager INTEGER
--technical-contact INTEGER
--team-manager INTEGER
--prod-type INTEGER
--sla-configuration INTEGER
--regulations INTEGER
--help Show this message and exit.
dojo api products delete-preview-list
delete_preview_list
Usage:
dojo api products delete-preview-list [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
product. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api products destroy
destroy
Usage:
dojo api products destroy [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this product. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api products generate-report-create
generate_report_create
Usage:
dojo api products generate-report-create [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
product. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--report-generate-option-request TEXT
--help Show this message and exit.
dojo api products list
list
Usage:
dojo api products list [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--business-criticality TEXT * `very high` - Very High * `high` - High *
`medium` - Medium * `low` - Low * `very low`
- Very Low * `none` - None
--created DATETIME Time that the object was initially created,
and saved to the database * `None` - Any
date * `1` - Today * `2` - Past 7 days * `3`
- Past 30 days * `4` - Past 90 days * `5` -
Current month * `6` - Current year * `7` -
Past year
--description TEXT
--external-audience
--has-tags Has tags
--id INTEGER Multiple values may be separated by commas.
--internet-accessible
--lifecycle TEXT * `construction` - Construction *
`production` - Production * `retirement` -
Retirement
--limit INTEGER Number of results to return per page.
--name TEXT
--name-exact TEXT
--not-tag TEXT Not Tag name contains
--not-tags TEXT Comma separated list of exact tags not
present on Product
-o TEXT Ordering * `id` - Id * `-id` - Id
(descending) * `tid` - Tid * `-tid` - Tid
(descending) * `name` - Name * `-name` -
Name (descending) * `created` - Created *
`-created` - Created (descending) *
`prod_numeric_grade` - Prod numeric grade *
`-prod_numeric_grade` - Prod numeric grade
(descending) * `business_criticality` -
Business criticality *
`-business_criticality` - Business
criticality (descending) * `platform` -
Platform * `-platform` - Platform
(descending) * `lifecycle` - Lifecycle *
`-lifecycle` - Lifecycle (descending) *
`origin` - Origin * `-origin` - Origin
(descending) * `revenue` - Revenue *
`-revenue` - Revenue (descending) *
`external_audience` - External audience *
`-external_audience` - External audience
(descending) * `internet_accessible` -
Internet accessible * `-internet_accessible`
- Internet accessible (descending) *
`product_manager` - Product manager *
`-product_manager` - Product manager
(descending) * `product_manager__first_name`
- Product manager first name *
`-product_manager__first_name` - Product
manager first name (descending) *
`product_manager__last_name` - Product
manager last name *
`-product_manager__last_name` - Product
manager last name (descending) *
`technical_contact` - Technical contact *
`-technical_contact` - Technical contact
(descending) *
`technical_contact__first_name` - Technical
contact first name *
`-technical_contact__first_name` - Technical
contact first name (descending) *
`technical_contact__last_name` - Technical
contact last name *
`-technical_contact__last_name` - Technical
contact last name (descending) *
`team_manager` - Team manager *
`-team_manager` - Team manager (descending)
* `team_manager__first_name` - Team manager
first name * `-team_manager__first_name` -
Team manager first name (descending) *
`team_manager__last_name` - Team manager
last name * `-team_manager__last_name` -
Team manager last name (descending) *
`prod_type` - Prod type * `-prod_type` -
Prod type (descending) * `prod_type__name` -
Prod type name * `-prod_type__name` - Prod
type name (descending) * `updated` -
Updated * `-updated` - Updated (descending)
* `user_records` - User records *
`-user_records` - User records (descending)
--offset INTEGER The initial index from which to return the
results.
--origin TEXT * `third party library` - Third Party
Library * `purchased` - Purchased *
`contractor` - Contractor Developed *
`internal` - Internally Developed * `open
source` - Open Source * `outsourced` -
Outsourced
--outside-of-sla FLOAT
--platform TEXT * `web service` - API * `desktop` - Desktop
* `iot` - Internet of Things * `mobile` -
Mobile * `web` - Web
--prefetch TEXT List of fields for which to prefetch model
instances and add those to the response
--prod-numeric-grade INTEGER Multiple values may be separated by commas.
--prod-type INTEGER Multiple values may be separated by commas.
--product-manager INTEGER Multiple values may be separated by commas.
--regulations INTEGER Multiple values may be separated by commas.
--revenue FLOAT
--tag TEXT Tag name contains
--tags TEXT Comma separated list of exact tags (uses OR
for multiple values)
--tags--and TEXT Comma separated list of exact tags to match
with an AND expression
--team-manager INTEGER Multiple values may be separated by commas.
--technical-contact INTEGER Multiple values may be separated by commas.
--tid INTEGER Multiple values may be separated by commas.
--updated DATETIME Time that the object was most recently saved
to the database * `None` - Any date * `1` -
Today * `2` - Past 7 days * `3` - Past 30
days * `4` - Past 90 days * `5` - Current
month * `6` - Current year * `7` - Past year
--user-records INTEGER Multiple values may be separated by commas.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api products partial-update
partial_update
Usage:
dojo api products partial-update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
product. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--patched-product-request TEXT
--help Show this message and exit.
dojo api products retrieve
retrieve
Usage:
dojo api products retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this product.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--prefetch TEXT List of fields for which to prefetch model instances and
add those to the response
--help Show this message and exit.
dojo api products update
update
Usage:
dojo api products update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this product.
[required]
--product-request TEXT [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api questionnaire-answered-questionnaires
methods from QuestionnaireAnsweredQuestionnairesApi.
Usage:
dojo api questionnaire-answered-questionnaires [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
dojo api questionnaire-answered-questionnaires list
(Deprecated) list
Usage:
dojo api questionnaire-answered-questionnaires list [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
--prefetch TEXT List of fields for which to prefetch model
instances and add those to the response
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api questionnaire-answered-questionnaires retrieve
(Deprecated) retrieve
Usage:
dojo api questionnaire-answered-questionnaires retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this Answered Engagement
Survey. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--prefetch TEXT List of fields for which to prefetch model instances and
add those to the response
--help Show this message and exit.
dojo api questionnaire-answers
methods from QuestionnaireAnswersApi.
Usage:
dojo api questionnaire-answers [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
dojo api questionnaire-answers list
(Deprecated) list
Usage:
dojo api questionnaire-answers list [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api questionnaire-answers retrieve
(Deprecated) retrieve
Usage:
dojo api questionnaire-answers retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this answer. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api questionnaire-engagement-questionnaires
methods from QuestionnaireEngagementQuestionnairesApi.
Usage:
dojo api questionnaire-engagement-questionnaires [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
- link-engagement-create: (Deprecated) link_engagement_create
- list: (Deprecated) list
- retrieve: (Deprecated) retrieve
dojo api questionnaire-engagement-questionnaires link-engagement-create
(Deprecated) link_engagement_create
Usage:
dojo api questionnaire-engagement-questionnaires link-engagement-create
[OPTIONS]
Options:
--engagement-id INTEGER [required]
--id INTEGER A unique integer value identifying this Engagement
Survey. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api questionnaire-engagement-questionnaires list
(Deprecated) list
Usage:
dojo api questionnaire-engagement-questionnaires list [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api questionnaire-engagement-questionnaires retrieve
(Deprecated) retrieve
Usage:
dojo api questionnaire-engagement-questionnaires retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this Engagement Survey.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api questionnaire-general-questionnaires
methods from QuestionnaireGeneralQuestionnairesApi.
Usage:
dojo api questionnaire-general-questionnaires [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
dojo api questionnaire-general-questionnaires list
(Deprecated) list
Usage:
dojo api questionnaire-general-questionnaires list [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api questionnaire-general-questionnaires retrieve
(Deprecated) retrieve
Usage:
dojo api questionnaire-general-questionnaires retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this General Engagement
Survey. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api questionnaire-questions
methods from QuestionnaireQuestionsApi.
Usage:
dojo api questionnaire-questions [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
dojo api questionnaire-questions list
(Deprecated) list
Usage:
dojo api questionnaire-questions list [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api questionnaire-questions retrieve
(Deprecated) retrieve
Usage:
dojo api questionnaire-questions retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this question. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api regulations
methods from RegulationsApi.
Usage:
dojo api regulations [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
- create: create
- delete-preview-list: delete_preview_list
- destroy: destroy
- list: list
- partial-update: partial_update
- retrieve: retrieve
- update: update
dojo api regulations create
create
Usage:
dojo api regulations create [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--name TEXT The name of the regulation.
--acronym TEXT A shortened representation of the name.
--category TEXT The subject of the regulation. * `privacy` - Privacy *
`finance` - Finance * `education` - Education *
`medical` - Medical * `corporate` - Corporate *
`security` - Security * `government` - Government *
`other` - Other
--jurisdiction TEXT The territory over which the regulation applies.
--description TEXT Information about the regulation's purpose.
--reference TEXT An external URL for more information.
--help Show this message and exit.
dojo api regulations delete-preview-list
delete_preview_list
Usage:
dojo api regulations delete-preview-list [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
regulation. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api regulations destroy
destroy
Usage:
dojo api regulations destroy [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this regulation.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api regulations list
list
Usage:
dojo api regulations list [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--description TEXT
--id INTEGER
--limit INTEGER Number of results to return per page.
--name TEXT
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api regulations partial-update
partial_update
Usage:
dojo api regulations partial-update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
regulation. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--patched-regulation-request TEXT
--help Show this message and exit.
dojo api regulations retrieve
retrieve
Usage:
dojo api regulations retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this regulation.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api regulations update
update
Usage:
dojo api regulations update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
regulation. [required]
--regulation-request TEXT [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api reimport-scan
create
Usage:
dojo api reimport-scan [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--scan-date DATE Scan completion date will be used on all
findings.
--minimum-severity TEXT Minimum severity level to be imported *
`Info` - Info * `Low` - Low * `Medium` -
Medium * `High` - High * `Critical` -
Critical
--active Force findings to be active/inactive or
default to the original tool (None)
--verified Force findings to be verified/not verified
or default to the original tool (None)
--endpoint-to-add INTEGER Enter the ID of an Endpoint that is
associated with the target Product. New
Findings will be added to that Endpoint.
--file PATH
--product-type-name TEXT Also referred to as 'Organization' name.
--product-name TEXT Also referred to as 'Asset' name.
--engagement-name TEXT
--engagement-end-date DATE End Date for Engagement. Default is current
time + 365 days. Required format year-month-
day
--source-code-management-uri TEXT
Resource link to source code
--test-title TEXT
--auto-create-context
--deduplication-on-engagement
--lead INTEGER
--push-to-jira
--environment TEXT
--build-id TEXT ID of the build that was scanned.
--branch-tag TEXT Branch or Tag that was scanned.
--commit-hash TEXT Commit that was scanned.
--api-scan-configuration INTEGER
--service TEXT A service is a self-contained piece of
functionality within a Product. This is an
optional field which is used in
deduplication and closing of old findings
when set. This affects the whole
engagement/product depending on your
deduplication scope.
--group-by TEXT Choose an option to automatically group new
findings by the chosen option. *
`component_name` - Component Name *
`component_name+component_version` -
Component Name + Version * `file_path` -
File path * `finding_title` - Finding Title
* `vuln_id_from_tool` - Vulnerability ID
from Tool
--create-finding-groups-for-all-findings
If set to false, finding groups will only be
created when there is more than one grouped
finding
--apply-tags-to-findings If set to True, the tags will be applied to
the findings
--apply-tags-to-endpoints If set to True, the tags will be applied to
the locations
--do-not-reactivate Select if the import should ignore active
findings from the report, useful for triage-
less scanners. Will keep existing findings
closed, without reactivating them. For more
information check the docs.
--scan-type TEXT * `Acunetix Scan` - Acunetix Scanner *
`Anchore Engine Scan` - Anchore Engine Scan
* `Anchore Enterprise Policy Check` -
Anchore Enterprise Policy Check * `Anchore
Grype` - Anchore Grype * `Anchore Grype
detailed` - Anchore Grype detailed *
`AnchoreCTL Policies Report` - AnchoreCTL
Policies Report * `AnchoreCTL Vuln Report` -
AnchoreCTL Vuln Report * `AppCheck Web
Application Scanner` - AppCheck Web
Application Scanner * `AppSpider Scan` -
AppSpider Scan * `Aqua Scan` - Aqua Scan *
`Arachni Scan` - Arachni Scan * `AuditJS
Scan` - AuditJS Scan * `AWS Inspector2 Scan`
- AWS Inspector2 Scan * `AWS Prowler Scan` -
AWS Prowler Scan * `AWS Prowler V3` - AWS
Prowler V3 * `AWS Security Finding Format
(ASFF) Scan` - AWS Security Finding Format
(ASFF) * `AWS Security Hub Scan` - AWS
Security Hub Scan * `Azure Security Center
Recommendations Scan` - Azure Security
Center Recommendations Scan * `Bandit Scan`
- Bandit Scan * `Bearer CLI` - Bearer CLI *
`BlackDuck API` - BlackDuck API * `Blackduck
Binary Analysis` - Blackduck Binary Analysis
* `Blackduck Component Risk` - Blackduck
Component Risk * `Blackduck Hub Scan` -
Blackduck Hub Scan * `Brakeman Scan` -
Brakeman Scan * `Bugcrowd API Import` -
Bugcrowd API Import * `BugCrowd Scan` -
BugCrowd Scan * `Bundler-Audit Scan` -
Bundler-Audit Scan * `Burp Dastardly Scan` -
Burp Dastardly Scan * `Burp Enterprise Scan`
- Burp Enterprise Scan (RENAMED to Burp
Suite DAST Scan) * `Burp REST API` - Burp
REST API * `Burp Scan` - Burp Scan * `Burp
GraphQL API` - Burp Suite DAST GraphQL API *
`Burp Suite DAST Scan` - Burp Suite DAST
Scan * `CargoAudit Scan` - CargoAudit Scan *
`Checkmarx CxFlow SAST` - Checkmarx CxFlow
SAST * `Checkmarx One Scan` - Checkmarx One
Scan * `Checkmarx OSA` - Checkmarx OSA *
`Checkmarx Scan` - Checkmarx Scan *
`Checkmarx Scan detailed` - Checkmarx Scan
detailed * `Checkov Scan` - Checkov Scan *
`Chef Inspect Log` - Chef Inspect Log *
`Choctaw Hog Scan` - Choctaw Hog Scan *
`Clair Scan` - Clair Scan * `Cloudflare
Insights` - Cloudflare Insights *
`Cloudsploit Scan` - Cloudsploit Scan *
`Cobalt.io API Import` - Cobalt.io API
Import * `Cobalt.io Scan` - Cobalt.io Scan *
`Codechecker Report native` - Codechecker
Report native * `Contrast Scan` - Contrast
Scan * `Coverity API` - Coverity API *
`Coverity Scan JSON Report` - Coverity Scan
JSON Report * `Crashtest Security JSON File`
- Crashtest Security JSON File * `Crashtest
Security XML File` - Crashtest Security XML
File * `CredScan Scan` - CredScan Scan *
`Crunch42 Scan` - Crunch42 Scan *
`Cyberwatch scan (Galeax)` - Cyberwatch scan
(Galeax) * `CycloneDX Scan` - CycloneDX Scan
* `Cycognito Scan` - Cycognito Scan *
`DawnScanner Scan` - DawnScanner Scan *
`Deepfence Threatmapper Report` - Deepfence
Threatmapper Report * `Dependency Check
Scan` - Dependency Check Scan * `Dependency
Track Finding Packaging Format (FPF) Export`
- Dependency Track Finding Packaging Format
(FPF) Export * `Detect-secrets Scan` -
Detect-secrets Scan * `docker-bench-security
Scan` - docker-bench-security Scan * `Dockle
Scan` - Dockle Scan * `DrHeader JSON
Importer` - DrHeader JSON Importer * `DSOP
Scan` - DSOP Scan * `Duroc Hog Scan` - Duroc
Hog Scan * `Edgescan Scan` - Edgescan Scan *
`ESLint Scan` - ESLint Scan * `Essex Hog
Scan` - Essex Hog Scan * `Fortify Scan` -
Fortify Scan * `Generic Findings Import` -
Generic Findings Import * `Ggshield Scan` -
Ggshield Scan * `Github SAST Scan` - Github
SAST Scan * `Github Secrets Detection Report
Scan` - Github Secrets Detection Report Scan
* `Github Vulnerability Scan` - Github
Vulnerability Scan * `GitLab API Fuzzing
Report Scan` - GitLab API Fuzzing Report
Scan * `GitLab Container Scan` - GitLab
Container Scan Scan * `GitLab DAST Report` -
GitLab DAST Report * `GitLab Dependency
Scanning Report` - GitLab Dependency
Scanning Report * `GitLab SAST Report` -
GitLab SAST Report * `GitLab Secret
Detection Report` - GitLab Secret Detection
Report * `Gitleaks Scan` - Gitleaks Scan *
`Google Cloud Artifact Vulnerability Scan` -
Google Cloud Artifact Vulnerability Scan *
`Gosec Scanner` - Gosec Scanner * `Gottingen
Hog Scan` - Gottingen Hog Scan *
`Govulncheck Scanner` - Govulncheck Scanner
* `HackerOne Cases` - HackerOne Cases *
`Hadolint Dockerfile check` - Hadolint
Dockerfile check * `Harbor Vulnerability
Scan` - Harbor Vulnerability Scan * `HCL
AppScan on Cloud SAST XML` - HCL AppScan on
Cloud SAST XML * `HCLAppScan XML` -
HCLAppScan XML * `Horusec Scan` - Horusec
Scan * `Humble Json Importer` - Humble Json
Importer * `HuskyCI Report` - HuskyCI Report
* `Hydra Scan` - Hydra Scan * `IBM AppScan
DAST` - IBM AppScan DAST * `Immuniweb Scan`
- Immuniweb Scan * `IntSights Report` -
IntSights Report * `Invicti Scan` - Invicti
Scan * `IriusRisk Threats Scan` - IriusRisk
Threats Scan * `JFrog Xray API Summary
Artifact Scan` - JFrog Xray API Summary
Artifact Scan * `JFrog Xray On Demand Binary
Scan` - JFrog Xray On Demand Binary Scan *
`JFrog Xray Scan` - JFrog Xray Scan * `JFrog
Xray Unified Scan` - JFrog Xray Unified Scan
* `KICS Scan` - KICS Scan * `Kiuwan SCA
Scan` - Kiuwan SCA Scan * `Kiuwan Scan` -
Kiuwan Scan * `KrakenD Audit Scan` - KrakenD
Audit Scan * `kube-bench Scan` - kube-bench
Scan * `Kubeaudit Scan` - Kubeaudit Scan *
`KubeHunter Scan` - KubeHunter Scan *
`Kubescape JSON Importer` - Kubescape JSON
Importer * `Legitify Scan` - Legitify Scan *
`Mayhem SARIF Report` - Mayhem SARIF Report
* `Mend Scan` - Mend Scan * `Meterian Scan`
- Meterian Scan * `Microfocus Webinspect
Scan` - Microfocus Webinspect Scan * `MobSF
Scan` - MobSF Scan * `Mobsfscan Scan` -
MobSF Scan * `MobSF Scorecard Scan` - MobSF
Scorecard Scan * `Mozilla Observatory Scan`
- Mozilla Observatory Scan * `MSDefender
Parser` - MSDefender Parser * `n0s1 Scanner`
- n0s1 Scanner * `Nancy Scan` - Nancy Scan *
`Netsparker Scan` - Netsparker Scan *
`NeuVector (compliance)` - NeuVector
(compliance) * `NeuVector (REST)` -
NeuVector (REST) * `Nexpose Scan` - Nexpose
Scan * `Nikto Scan` - Nikto Scan * `Nmap
Scan` - Nmap Scan * `Node Security Platform
Scan` - Node Security Platform Scan * `Nosey
Parker Scan` - Nosey Parker Scan * `NPM
Audit Scan` - NPM Audit Scan * `NPM Audit
v7+ Scan` - NPM Audit v7+ Scan * `Nuclei
Scan` - Nuclei Scan * `OpenReports` -
OpenReports * `Openscap Vulnerability Scan`
- Openscap Vulnerability Scan * `OpenVAS
Parser` - OpenVAS Parser * `OpenVAS Parser
v2` - OpenVAS Parser v2 * `Orca Security
Alerts` - Orca Security Alerts * `ORT
evaluated model Importer` - ORT evaluated
model Importer * `OssIndex Devaudit SCA Scan
Importer` - OssIndex Devaudit SCA Scan
Importer * `OSV Scan` - OSV Scan *
`Outpost24 Scan` - Outpost24 Scan * `PHP
Security Audit v2` - PHP Security Audit v2 *
`PHP Symfony Security Check` - PHP Symfony
Security Check * `PingCastle` - PingCastle *
`pip-audit Scan` - pip-audit Scan * `PMD
Scan` - PMD Scan * `Popeye Scan` - Popeye
Scan * `Progpilot Scan` - Progpilot Scan *
`Prowler Scan` - Prowler Scan * `PTART
Report` - PTART Report * `PWN SAST` - PWN
SAST * `Qualys Hacker Guardian Scan` -
Qualys Hacker Guardian Scan * `Qualys
Infrastructure Scan (WebGUI XML)` - Qualys
Infrastructure Scan (WebGUI XML) * `Qualys
Scan` - Qualys Scan * `Qualys Webapp Scan` -
Qualys Webapp Scan * `Rapplex Scan` -
Rapplex Scan * `Red Hat Satellite` - Red Hat
Satellite * `Retire.js Scan` - Retire.js
Scan * `ReversingLabs Spectra Assure` -
ReversingLabs Spectra Assure * `Risk Recon
API Importer` - Risk Recon API Importer *
`Rubocop Scan` - Rubocop Scan * `Rusty Hog
Scan` - Rusty Hog Scan * `SARIF` - SARIF *
`Scantist Scan` - Scantist Scan * `Scout
Suite Scan` - Scout Suite Scan * `Semgrep
JSON Report` - Semgrep JSON Report *
`Semgrep Pro JSON Report` - Semgrep Pro JSON
Report * `SKF Scan` - SKF Scan * `Snyk Code
Scan` - Snyk Code Scan * `Snyk Issue API
Scan` - Snyk Issue API Scan * `Snyk Scan` -
Snyk Scan * `Solar Appscreener Scan` - Solar
Appscreener Scan Detailed_Results.csv *
`SonarQube API Import` - SonarQube API
Import * `SonarQube Scan` - SonarQube Scan *
`SonarQube Scan detailed` - SonarQube Scan
detailed * `Sonatype Application Scan` -
Sonatype Application Scan * `SpotBugs Scan`
- SpotBugs Scan * `SSH Audit Importer` - SSH
Audit Importer * `SSL Labs Scan` - SSL Labs
Scan * `Sslscan` - Sslscan * `Sslyze Scan` -
Sslyze Scan * `SSLyze Scan (JSON)` - SSLyze
Scan (JSON) * `StackHawk HawkScan` -
StackHawk HawkScan * `Sysdig CLI Report` -
Sysdig CLI Report Scan * `Sysdig
Vulnerability Report` - Sysdig Vulnerability
Report Scan * `Talisman Scan` - Talisman
Scan * `Tenable Scan` - Tenable Scan *
`Terrascan Scan` - Terrascan Scan * `Testssl
Scan` - Testssl Scan * `TFSec Scan` - TFSec
Scan * `Threagile risks report` - Threagile
risks report * `ThreatComposer Scan` -
ThreatComposer Scan * `Trivy Operator Scan`
- Trivy Operator Scan * `Trivy Scan` - Trivy
Scan * `Trufflehog Scan` - Trufflehog Scan *
`Trufflehog3 Scan` - Trufflehog3 Scan *
`Trustwave Fusion API Scan` - Trustwave
Fusion API Scan * `Trustwave Scan (CSV)` -
Trustwave Scan (CSV) * `Twistlock Image
Scan` - Twistlock Image Scan * `VCG Scan` -
VCG Scan * `Veracode Scan` - Veracode Scan *
`Veracode SourceClear Scan` - Veracode
SourceClear Scan * `Vulners` - Vulners *
`Wapiti Scan` - Wapiti Scan * `Wazuh` -
Wazuh * `WFuzz JSON report` - WFuzz JSON
report * `Whispers Scan` - Whispers Scan *
`WhiteHat Sentinel` - WhiteHat Sentinel *
`Wiz Scan` - Wiz Scan * `Wizcli Dir Scan` -
Wizcli Dir Scan * `Wizcli IaC Scan` - Wizcli
IaC Scan * `Wizcli Img Scan` - Wizcli Img
Scan * `Wpscan` - Wpscan * `Xanitizer Scan`
- Xanitizer Scan * `Xeol Parser` - Xeol
Parser * `Yarn Audit Scan` - Yarn Audit Scan
* `ZAP Scan` - ZAP Scan * `Zora Parser` -
Zora Parser
--test INTEGER
--close-old-findings Old findings no longer present in the new
report get closed as mitigated when
importing. If service has been set, only the
findings for this service will be closed; if
no service is set, only findings without a
service will be closed. This only affects
findings within the same test.
--close-old-findings-product-scope
This has no effect on reimport
--version TEXT Version that will be set on existing Test
object. Leave empty to leave existing value
in place.
--tags TEXT Modify existing tags that help describe this
scan. (Existing test tags will be
overwritten)
--help Show this message and exit.
dojo api request-response-pairs
methods from RequestResponsePairsApi.
Usage:
dojo api request-response-pairs [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
- create: create
- delete-preview-list: delete_preview_list
- destroy: destroy
- list: list
- partial-update: partial_update
- retrieve: retrieve
- update: update
dojo api request-response-pairs create
create
Usage:
dojo api request-response-pairs create [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--burp-request-base64 TEXT
--burp-response-base64 TEXT
--finding INTEGER
--help Show this message and exit.
dojo api request-response-pairs delete-preview-list
delete_preview_list
Usage:
dojo api request-response-pairs delete-preview-list [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this burp
raw request response. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api request-response-pairs destroy
destroy
Usage:
dojo api request-response-pairs destroy [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this burp raw request
response. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api request-response-pairs list
list
Usage:
dojo api request-response-pairs list [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--finding INTEGER
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api request-response-pairs partial-update
partial_update
Usage:
dojo api request-response-pairs partial-update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this burp
raw request response. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--patched-burp-raw-request-response-multi-request TEXT
--help Show this message and exit.
dojo api request-response-pairs retrieve
retrieve
Usage:
dojo api request-response-pairs retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this burp raw request
response. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api request-response-pairs update
update
Usage:
dojo api request-response-pairs update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this burp
raw request response. [required]
--burp-raw-request-response-multi-request TEXT
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--help Show this message and exit.
dojo api risk-acceptance
methods from RiskAcceptanceApi.
Usage:
dojo api risk-acceptance [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
- create: create
- delete-preview-list: delete_preview_list
- destroy: destroy
- download-proof-retrieve: download_proof_retrieve
- list: list
- notes-create: notes_create
- notes-retrieve: notes_retrieve
- partial-update: partial_update
- retrieve: retrieve
- update: update
dojo api risk-acceptance create
create
Usage:
dojo api risk-acceptance create [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--name TEXT Descriptive name which in the future may
also be used to group risk acceptances
together across engagements and products
--recommendation TEXT Recommendation from the security team. *
`A` - Accept (The risk is acknowledged, yet
remains) * `V` - Avoid (Do not engage with
whatever creates the risk) * `M` - Mitigate
(The risk still exists, yet compensating
controls make it less of a threat) * `F` -
Fix (The risk is eradicated) * `T` -
Transfer (The risk is transferred to a 3rd
party)
--recommendation-details TEXT Explanation of security recommendation
--decision TEXT Risk treatment decision by risk owner * `A`
- Accept (The risk is acknowledged, yet
remains) * `V` - Avoid (Do not engage with
whatever creates the risk) * `M` - Mitigate
(The risk still exists, yet compensating
controls make it less of a threat) * `F` -
Fix (The risk is eradicated) * `T` -
Transfer (The risk is transferred to a 3rd
party)
--decision-details TEXT If a compensating control exists to mitigate
the finding or reduce risk, then list the
compensating control(s).
--accepted-by TEXT The person that accepts the risk, can be
outside of DefectDojo.
--expiration-date DATETIME When the risk acceptance expires, the
findings will be reactivated (unless
disabled below).
--expiration-date-warned DATETIME
(readonly) Date at which notice about the
risk acceptance expiration was sent.
--expiration-date-handled DATETIME
(readonly) When the risk acceptance
expiration was handled (manually or by the
daily job).
--reactivate-expired Reactivate findings when risk acceptance
expires?
--restart-sla-expired When enabled, the SLA for findings is
restarted when the risk acceptance expires.
--owner INTEGER User in DefectDojo owning this acceptance.
Only the owner and staff users can edit the
risk acceptance.
--accepted-findings INTEGER
--help Show this message and exit.
dojo api risk-acceptance delete-preview-list
delete_preview_list
Usage:
dojo api risk-acceptance delete-preview-list [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
risk_ acceptance. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api risk-acceptance destroy
destroy
Usage:
dojo api risk-acceptance destroy [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this risk_ acceptance.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api risk-acceptance download-proof-retrieve
download_proof_retrieve
Usage:
dojo api risk-acceptance download-proof-retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this risk_ acceptance.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api risk-acceptance list
list
Usage:
dojo api risk-acceptance list [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--accepted-by TEXT
--accepted-findings INTEGER
--decision TEXT Risk treatment decision by risk owner * `A`
- Accept (The risk is acknowledged, yet
remains) * `V` - Avoid (Do not engage with
whatever creates the risk) * `M` - Mitigate
(The risk still exists, yet compensating
controls make it less of a threat) * `F` -
Fix (The risk is eradicated) * `T` -
Transfer (The risk is transferred to a 3rd
party)
--decision-details TEXT
--expiration-date DATETIME
--expiration-date-handled DATETIME
--expiration-date-warned DATETIME
--limit INTEGER Number of results to return per page.
--name TEXT
--notes INTEGER
-o TEXT Ordering * `name` - Name * `-name` - Name
(descending)
--offset INTEGER The initial index from which to return the
results.
--owner INTEGER
--reactivate-expired
--recommendation TEXT Recommendation from the security team. *
`A` - Accept (The risk is acknowledged, yet
remains) * `V` - Avoid (Do not engage with
whatever creates the risk) * `M` - Mitigate
(The risk still exists, yet compensating
controls make it less of a threat) * `F` -
Fix (The risk is eradicated) * `T` -
Transfer (The risk is transferred to a 3rd
party)
--recommendation-details TEXT
--restart-sla-expired
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api risk-acceptance notes-create
notes_create
Usage:
dojo api risk-acceptance notes-create [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
risk_ acceptance. [required]
--add-new-note-option-request TEXT
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--help Show this message and exit.
dojo api risk-acceptance notes-retrieve
notes_retrieve
Usage:
dojo api risk-acceptance notes-retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this risk_ acceptance.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api risk-acceptance partial-update
partial_update
Usage:
dojo api risk-acceptance partial-update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
risk_ acceptance. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--patched-risk-acceptance-request TEXT
--help Show this message and exit.
dojo api risk-acceptance retrieve
retrieve
Usage:
dojo api risk-acceptance retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this risk_ acceptance.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api risk-acceptance update
update
Usage:
dojo api risk-acceptance update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
risk_ acceptance. [required]
--risk-acceptance-request TEXT [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--help Show this message and exit.
dojo api roles
methods from RolesApi.
Usage:
dojo api roles [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
dojo api roles list
list
Usage:
dojo api roles list [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--id INTEGER
--limit INTEGER Number of results to return per page.
--name TEXT
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api roles retrieve
retrieve
Usage:
dojo api roles retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this role. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api sla-configurations
methods from SlaConfigurationsApi.
Usage:
dojo api sla-configurations [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
- create: create
- delete-preview-list: delete_preview_list
- destroy: destroy
- list: list
- partial-update: partial_update
- retrieve: retrieve
- update: update
dojo api sla-configurations create
create
Usage:
dojo api sla-configurations create [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--name TEXT A unique name for the set of SLAs.
--description TEXT
--critical INTEGER The number of days to remediate a critical
finding.
--enforce-critical When enabled, critical findings will be
assigned an SLA expiration date based on the
critical finding SLA days within this SLA
configuration.
--high INTEGER The number of days to remediate a high
finding.
--enforce-high When enabled, high findings will be assigned
an SLA expiration date based on the high
finding SLA days within this SLA
configuration.
--medium INTEGER The number of days to remediate a medium
finding.
--enforce-medium When enabled, medium findings will be
assigned an SLA expiration date based on the
medium finding SLA days within this SLA
configuration.
--low INTEGER The number of days to remediate a low
finding.
--enforce-low When enabled, low findings will be assigned
an SLA expiration date based on the low
finding SLA days within this SLA
configuration.
--restart-sla-on-reactivation When enabled, findings that were previously
mitigated but are reactivated durign reimport
will have their SLA period restarted.
--help Show this message and exit.
dojo api sla-configurations delete-preview-list
delete_preview_list
Usage:
dojo api sla-configurations delete-preview-list [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this sl
a_ configuration. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api sla-configurations destroy
destroy
Usage:
dojo api sla-configurations destroy [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this sl a_ configuration.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api sla-configurations list
list
Usage:
dojo api sla-configurations list [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api sla-configurations partial-update
partial_update
Usage:
dojo api sla-configurations partial-update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this sl
a_ configuration. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--patched-sla-configuration-request TEXT
--help Show this message and exit.
dojo api sla-configurations retrieve
retrieve
Usage:
dojo api sla-configurations retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this sl a_ configuration.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api sla-configurations update
update
Usage:
dojo api sla-configurations update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this sl
a_ configuration. [required]
--sla-configuration-request TEXT
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--help Show this message and exit.
dojo api sonarqube-issues
methods from SonarqubeIssuesApi.
Usage:
dojo api sonarqube-issues [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
- create: create
- delete-preview-list: delete_preview_list
- destroy: destroy
- list: list
- partial-update: partial_update
- retrieve: retrieve
- update: update
dojo api sonarqube-issues create
create
Usage:
dojo api sonarqube-issues create [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--key TEXT SonarQube issue key
--status TEXT SonarQube issue status
--type TEXT SonarQube issue type
--help Show this message and exit.
dojo api sonarqube-issues delete-preview-list
delete_preview_list
Usage:
dojo api sonarqube-issues delete-preview-list [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
sonarqube_ issue. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api sonarqube-issues destroy
destroy
Usage:
dojo api sonarqube-issues destroy [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this sonarqube_ issue.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api sonarqube-issues list
list
Usage:
dojo api sonarqube-issues list [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--id INTEGER
--key TEXT
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
--status TEXT
--type TEXT
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api sonarqube-issues partial-update
partial_update
Usage:
dojo api sonarqube-issues partial-update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
sonarqube_ issue. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--patched-sonarqube-issue-request TEXT
--help Show this message and exit.
dojo api sonarqube-issues retrieve
retrieve
Usage:
dojo api sonarqube-issues retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this sonarqube_ issue.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api sonarqube-issues update
update
Usage:
dojo api sonarqube-issues update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
sonarqube_ issue. [required]
--sonarqube-issue-request TEXT [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--help Show this message and exit.
dojo api sonarqube-transitions
methods from SonarqubeTransitionsApi.
Usage:
dojo api sonarqube-transitions [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
- create: create
- delete-preview-list: delete_preview_list
- destroy: destroy
- list: list
- partial-update: partial_update
- retrieve: retrieve
- update: update
dojo api sonarqube-transitions create
create
Usage:
dojo api sonarqube-transitions create [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--finding-status TEXT
--sonarqube-status TEXT
--transitions TEXT
--sonarqube-issue INTEGER
--help Show this message and exit.
dojo api sonarqube-transitions delete-preview-list
delete_preview_list
Usage:
dojo api sonarqube-transitions delete-preview-list [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
sonarqube_ issue_ transition. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api sonarqube-transitions destroy
destroy
Usage:
dojo api sonarqube-transitions destroy [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this sonarqube_ issue_
transition. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api sonarqube-transitions list
list
Usage:
dojo api sonarqube-transitions list [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--finding-status TEXT
--id INTEGER
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
--sonarqube-issue INTEGER
--sonarqube-status TEXT
--transitions TEXT
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api sonarqube-transitions partial-update
partial_update
Usage:
dojo api sonarqube-transitions partial-update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
sonarqube_ issue_ transition. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--patched-sonarqube-issue-transition-request TEXT
--help Show this message and exit.
dojo api sonarqube-transitions retrieve
retrieve
Usage:
dojo api sonarqube-transitions retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this sonarqube_ issue_
transition. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api sonarqube-transitions update
update
Usage:
dojo api sonarqube-transitions update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
sonarqube_ issue_ transition. [required]
--sonarqube-issue-transition-request TEXT
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--help Show this message and exit.
dojo api stub-findings
methods from StubFindingsApi.
Usage:
dojo api stub-findings [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
- create: (Deprecated) create
- delete-preview-list: delete_preview_list
- destroy: (Deprecated) destroy
- list: (Deprecated) list
- partial-update: (Deprecated) partial_update
- retrieve: (Deprecated) retrieve
- update: (Deprecated) update
dojo api stub-findings create
(Deprecated) create
Usage:
dojo api stub-findings create [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--test INTEGER
--title TEXT
--var-date DATE
--severity TEXT
--description TEXT
--help Show this message and exit.
dojo api stub-findings delete-preview-list
delete_preview_list
Usage:
dojo api stub-findings delete-preview-list [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
stub_ finding. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api stub-findings destroy
(Deprecated) destroy
Usage:
dojo api stub-findings destroy [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this stub_ finding.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api stub-findings list
(Deprecated) list
Usage:
dojo api stub-findings list [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--var-date DATE
--description TEXT
--id INTEGER
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
--severity TEXT
--title TEXT
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api stub-findings partial-update
(Deprecated) partial_update
Usage:
dojo api stub-findings partial-update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
stub_ finding. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--patched-stub-finding-request TEXT
--help Show this message and exit.
dojo api stub-findings retrieve
(Deprecated) retrieve
Usage:
dojo api stub-findings retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this stub_ finding.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api stub-findings update
(Deprecated) update
Usage:
dojo api stub-findings update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this stub_
finding. [required]
--stub-finding-request TEXT [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--help Show this message and exit.
dojo api system-settings
methods from SystemSettingsApi.
Usage:
dojo api system-settings [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
- list: list
- partial-update: partial_update
- update: update
dojo api system-settings list
list
Usage:
dojo api system-settings list [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api system-settings partial-update
partial_update
Usage:
dojo api system-settings partial-update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
system_ settings. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--patched-system-settings-request TEXT
--help Show this message and exit.
dojo api system-settings update
update
Usage:
dojo api system-settings update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
system_ settings. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--system-settings-request TEXT
--help Show this message and exit.
dojo api technologies
methods from TechnologiesApi.
Usage:
dojo api technologies [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
- create: create
- delete-preview-list: delete_preview_list
- destroy: destroy
- list: list
- partial-update: partial_update
- retrieve: retrieve
- update: update
dojo api technologies create
create
Usage:
dojo api technologies create [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--tags TEXT
--name TEXT
--confidence INTEGER
--version TEXT
--icon TEXT
--website TEXT
--website-found TEXT
--product INTEGER
--user INTEGER
--help Show this message and exit.
dojo api technologies delete-preview-list
delete_preview_list
Usage:
dojo api technologies delete-preview-list [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this app_
analysis. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api technologies destroy
destroy
Usage:
dojo api technologies destroy [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this app_ analysis.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api technologies list
list
Usage:
dojo api technologies list [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--limit INTEGER Number of results to return per page.
--name TEXT
--not-tag TEXT Not Tag name contains
--not-tags TEXT Comma separated list of exact tags not
present on model
--offset INTEGER The initial index from which to return the
results.
--prefetch TEXT List of fields for which to prefetch model
instances and add those to the response
--product INTEGER
--tag TEXT Tag name contains
--tags TEXT Comma separated list of exact tags (uses OR
for multiple values)
--tags--and TEXT Comma separated list of exact tags to match
with an AND expression
--user INTEGER
--version TEXT
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api technologies partial-update
partial_update
Usage:
dojo api technologies partial-update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this app_
analysis. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--patched-app-analysis-request TEXT
--help Show this message and exit.
dojo api technologies retrieve
retrieve
Usage:
dojo api technologies retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this app_ analysis.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--prefetch TEXT List of fields for which to prefetch model instances and
add those to the response
--help Show this message and exit.
dojo api technologies update
update
Usage:
dojo api technologies update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this app_
analysis. [required]
--app-analysis-request TEXT [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--help Show this message and exit.
dojo api test-imports
methods from TestImportsApi.
Usage:
dojo api test-imports [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
- create: create
- delete-preview-list: delete_preview_list
- destroy: destroy
- list: list
- partial-update: partial_update
- retrieve: retrieve
- update: update
dojo api test-imports create
create
Usage:
dojo api test-imports create [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--import-settings TEXT
--type TEXT
--version TEXT
--build-id TEXT Build ID that was tested, a reimport may update this
field.
--commit-hash TEXT Commit hash tested, a reimport may update this
field.
--branch-tag TEXT Tag or branch that was tested, a reimport may update
this field.
--help Show this message and exit.
dojo api test-imports delete-preview-list
delete_preview_list
Usage:
dojo api test-imports delete-preview-list [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
test_ import. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api test-imports destroy
destroy
Usage:
dojo api test-imports destroy [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this test_ import.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api test-imports list
list
Usage:
dojo api test-imports list [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--branch-tag TEXT
--build-id TEXT
--commit-hash TEXT
--findings-affected INTEGER
--limit INTEGER Number of results to return per page.
-o TEXT Ordering * `id` - Id * `-id` - Id
(descending) * `created` - Created *
`-created` - Created (descending) *
`modified` - Modified * `-modified` -
Modified (descending) * `version` - Version
* `-version` - Version (descending) *
`branch_tag` - Branch tag * `-branch_tag` -
Branch tag (descending) * `build_id` - Build
id * `-build_id` - Build id (descending) *
`commit_hash` - Commit hash * `-commit_hash`
- Commit hash (descending)
--offset INTEGER The initial index from which to return the
results.
--test INTEGER
--test-import-finding-action--action TEXT
* `N` - created * `C` - closed * `R` -
reactivated * `U` - untouched
--test-import-finding-action--created DATETIME
--test-import-finding-action--finding INTEGER
--version TEXT
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api test-imports partial-update
partial_update
Usage:
dojo api test-imports partial-update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
test_ import. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--patched-test-import-request TEXT
--help Show this message and exit.
dojo api test-imports retrieve
retrieve
Usage:
dojo api test-imports retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this test_ import.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api test-imports update
update
Usage:
dojo api test-imports update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this test_
import. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--test-import-request TEXT
--help Show this message and exit.
dojo api test-types
methods from TestTypesApi.
Usage:
dojo api test-types [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
- create: create
- list: list
- partial-update: partial_update
- retrieve: retrieve
- update: update
dojo api test-types create
create
Usage:
dojo api test-types create [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--name TEXT
--static-tool
--dynamic-tool
--active
--help Show this message and exit.
dojo api test-types list
list
Usage:
dojo api test-types list [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--limit INTEGER Number of results to return per page.
--name TEXT
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api test-types partial-update
partial_update
Usage:
dojo api test-types partial-update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
test_ type. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--patched-test-type-request TEXT
--help Show this message and exit.
dojo api test-types retrieve
retrieve
Usage:
dojo api test-types retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this test_ type.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api test-types update
update
Usage:
dojo api test-types update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this test_
type. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--test-type-request TEXT
--help Show this message and exit.
dojo api tests
methods from TestsApi.
Usage:
dojo api tests [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
- accept-risks-create: accept_risks_create
- create: create
- delete-preview-list: delete_preview_list
- destroy: destroy
- files-create: files_create
- files-download-retrieve: files_download_retrieve
- files-retrieve: files_retrieve
- generate-report-create: generate_report_create
- list: list
- notes-create: notes_create
- notes-retrieve: notes_retrieve
- partial-update: partial_update
- retrieve: retrieve
- update: update
dojo api tests accept-risks-create
accept_risks_create
Usage:
dojo api tests accept-risks-create [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this test.
[required]
--accepted-risk-request TEXT [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--help Show this message and exit.
dojo api tests create
create
Usage:
dojo api tests create [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--engagement INTEGER
--notes INTEGER
--tags TEXT
--scan-type TEXT
--title TEXT
--description TEXT
--target-start DATETIME
--target-end DATETIME
--percent-complete INTEGER
--version TEXT
--build-id TEXT Build ID that was tested, a reimport may
update this field.
--commit-hash TEXT Commit hash tested, a reimport may update
this field.
--branch-tag TEXT Tag or branch that was tested, a reimport
may update this field.
--lead INTEGER
--test-type INTEGER
--environment INTEGER
--api-scan-configuration INTEGER
--help Show this message and exit.
dojo api tests delete-preview-list
delete_preview_list
Usage:
dojo api tests delete-preview-list [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
test. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api tests destroy
destroy
Usage:
dojo api tests destroy [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this test. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api tests files-create
files_create
Usage:
dojo api tests files-create [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this test. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--title TEXT
--file PATH
--help Show this message and exit.
dojo api tests files-download-retrieve
files_download_retrieve
Usage:
dojo api tests files-download-retrieve [OPTIONS]
Options:
--file-id TEXT [required]
--id INTEGER A unique integer value identifying this test. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api tests files-retrieve
files_retrieve
Usage:
dojo api tests files-retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this test. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api tests generate-report-create
generate_report_create
Usage:
dojo api tests generate-report-create [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
test. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--report-generate-option-request TEXT
--help Show this message and exit.
dojo api tests list
list
Usage:
dojo api tests list [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--api-scan-configuration INTEGER
--branch-tag TEXT
--build-id TEXT
--commit-hash TEXT
--engagement INTEGER
--engagement--product--tags TEXT
Comma separated list of exact tags present
on Product (uses OR for multiple values)
--engagement--product--tags--and TEXT
Comma separated list of exact tags to match
with an AND expression present on Product
--engagement--tags TEXT Comma separated list of exact tags present
on engagement (uses OR for multiple values)
--engagement--tags--and TEXT Comma separated list of exact tags to match
with an AND expression present on engagement
--has-tags Has tags
--id INTEGER
--limit INTEGER Number of results to return per page.
--not-engagement--product--tags TEXT
Comma separated list of exact tags not
present on Product
--not-engagement--tags TEXT Comma separated list of exact tags not
present on engagement
--not-tag TEXT Not Tag name contains
--not-tags TEXT Comma separated list of exact tags not
present on model
--notes INTEGER
-o TEXT Ordering * `title` - Title * `-title` -
Title (descending) * `version` - Version *
`-version` - Version (descending) *
`target_start` - Target start *
`-target_start` - Target start (descending)
* `target_end` - Target end * `-target_end`
- Target end (descending) * `test_type` -
Test type * `-test_type` - Test type
(descending) * `lead` - Lead * `-lead` -
Lead (descending) * `branch_tag` - Branch
tag * `-branch_tag` - Branch tag
(descending) * `build_id` - Build id *
`-build_id` - Build id (descending) *
`commit_hash` - Commit hash * `-commit_hash`
- Commit hash (descending) *
`api_scan_configuration` - Api scan
configuration * `-api_scan_configuration` -
Api scan configuration (descending) *
`engagement` - Engagement * `-engagement` -
Engagement (descending) * `created` -
Created * `-created` - Created (descending)
* `updated` - Updated * `-updated` - Updated
(descending)
--offset INTEGER The initial index from which to return the
results.
--percent-complete INTEGER
--scan-type TEXT
--tag TEXT Tag name contains
--tags TEXT Comma separated list of exact tags (uses OR
for multiple values)
--tags--and TEXT Comma separated list of exact tags to match
with an AND expression
--target-end DATETIME
--target-start DATETIME
--test-type INTEGER
--title TEXT
--version TEXT
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api tests notes-create
notes_create
Usage:
dojo api tests notes-create [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
test. [required]
--add-new-note-option-request TEXT
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--help Show this message and exit.
dojo api tests notes-retrieve
notes_retrieve
Usage:
dojo api tests notes-retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this test. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api tests partial-update
partial_update
Usage:
dojo api tests partial-update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this test.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--patched-test-request TEXT
--help Show this message and exit.
dojo api tests retrieve
retrieve
Usage:
dojo api tests retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this test. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api tests update
update
Usage:
dojo api tests update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this test.
[required]
--test-request TEXT [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api tool-configurations
methods from ToolConfigurationsApi.
Usage:
dojo api tool-configurations [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
- create: create
- delete-preview-list: delete_preview_list
- destroy: destroy
- list: list
- partial-update: partial_update
- retrieve: retrieve
- update: update
dojo api tool-configurations create
create
Usage:
dojo api tool-configurations create [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--name TEXT
--description TEXT
--url TEXT
--authentication-type TEXT * `API` - API Key * `Password` -
Username/Password * `SSH` - SSH
--extras TEXT Additional definitions that will be consumed by
scanner
--username TEXT
--password TEXT
--auth-title TEXT
--ssh TEXT
--api-key TEXT
--tool-type INTEGER
--help Show this message and exit.
dojo api tool-configurations delete-preview-list
delete_preview_list
Usage:
dojo api tool-configurations delete-preview-list [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
tool_ configuration. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api tool-configurations destroy
destroy
Usage:
dojo api tool-configurations destroy [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this tool_ configuration.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api tool-configurations list
list
Usage:
dojo api tool-configurations list [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--authentication-type TEXT * `API` - API Key * `Password` -
Username/Password * `SSH` - SSH
--id INTEGER
--limit INTEGER Number of results to return per page.
--name TEXT
--offset INTEGER The initial index from which to return the
results.
--prefetch TEXT List of fields for which to prefetch model
instances and add those to the response
--tool-type INTEGER
--url TEXT
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api tool-configurations partial-update
partial_update
Usage:
dojo api tool-configurations partial-update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
tool_ configuration. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--patched-tool-configuration-request TEXT
--help Show this message and exit.
dojo api tool-configurations retrieve
retrieve
Usage:
dojo api tool-configurations retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this tool_
configuration. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--prefetch TEXT List of fields for which to prefetch model instances and
add those to the response
--help Show this message and exit.
dojo api tool-configurations update
update
Usage:
dojo api tool-configurations update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
tool_ configuration. [required]
--tool-configuration-request TEXT
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--help Show this message and exit.
dojo api tool-product-settings
methods from ToolProductSettingsApi.
Usage:
dojo api tool-product-settings [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
- create: create
- delete-preview-list: delete_preview_list
- destroy: destroy
- list: list
- partial-update: partial_update
- retrieve: retrieve
- update: update
dojo api tool-product-settings create
create
Usage:
dojo api tool-product-settings create [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--setting-url TEXT
--product INTEGER
--name TEXT
--description TEXT
--url TEXT
--tool-project-id TEXT
--tool-configuration INTEGER
--help Show this message and exit.
dojo api tool-product-settings delete-preview-list
delete_preview_list
Usage:
dojo api tool-product-settings delete-preview-list [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
tool_ product_ settings. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api tool-product-settings destroy
destroy
Usage:
dojo api tool-product-settings destroy [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this tool_ product_
settings. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api tool-product-settings list
list
Usage:
dojo api tool-product-settings list [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--id INTEGER
--limit INTEGER Number of results to return per page.
--name TEXT
--offset INTEGER The initial index from which to return the
results.
--prefetch TEXT List of fields for which to prefetch model
instances and add those to the response
--product INTEGER
--tool-configuration INTEGER
--tool-project-id TEXT
--url TEXT
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api tool-product-settings partial-update
partial_update
Usage:
dojo api tool-product-settings partial-update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
tool_ product_ settings. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--patched-tool-product-settings-request TEXT
--help Show this message and exit.
dojo api tool-product-settings retrieve
retrieve
Usage:
dojo api tool-product-settings retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this tool_ product_
settings. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--prefetch TEXT List of fields for which to prefetch model instances and
add those to the response
--help Show this message and exit.
dojo api tool-product-settings update
update
Usage:
dojo api tool-product-settings update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
tool_ product_ settings. [required]
--tool-product-settings-request TEXT
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--help Show this message and exit.
dojo api tool-types
methods from ToolTypesApi.
Usage:
dojo api tool-types [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
- create: create
- delete-preview-list: delete_preview_list
- destroy: destroy
- list: list
- partial-update: partial_update
- retrieve: retrieve
- update: update
dojo api tool-types create
create
Usage:
dojo api tool-types create [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--name TEXT
--description TEXT
--help Show this message and exit.
dojo api tool-types delete-preview-list
delete_preview_list
Usage:
dojo api tool-types delete-preview-list [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
tool_ type. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api tool-types destroy
destroy
Usage:
dojo api tool-types destroy [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this tool_ type.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api tool-types list
list
Usage:
dojo api tool-types list [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--description TEXT
--id INTEGER
--limit INTEGER Number of results to return per page.
--name TEXT
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api tool-types partial-update
partial_update
Usage:
dojo api tool-types partial-update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
tool_ type. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--patched-tool-type-request TEXT
--help Show this message and exit.
dojo api tool-types retrieve
retrieve
Usage:
dojo api tool-types retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this tool_ type.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api tool-types update
update
Usage:
dojo api tool-types update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this tool_
type. [required]
--tool-type-request TEXT [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api user-contact-infos
methods from UserContactInfosApi.
Usage:
dojo api user-contact-infos [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
- create: create
- delete-preview-list: delete_preview_list
- destroy: destroy
- list: list
- partial-update: partial_update
- retrieve: retrieve
- update: update
dojo api user-contact-infos create
create
Usage:
dojo api user-contact-infos create [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--title TEXT
--phone-number TEXT Phone number must be entered in the format:
'+999999999'. Up to 15 digits allowed.
--cell-number TEXT Phone number must be entered in the format:
'+999999999'. Up to 15 digits allowed.
--twitter-username TEXT
--github-username TEXT
--slack-username TEXT Email address associated with your slack
account
--slack-user-id TEXT
--block-execution Instead of async deduping a finding the
findings will be deduped synchronously and
will 'block' the user until completion.
--force-password-reset Forces this user to reset their password on
next login.
--token-last-reset DATETIME Timestamp of the most recent API token reset
for this user.
--password-last-reset DATETIME Timestamp of the most recent password reset
for this user.
--user INTEGER
--help Show this message and exit.
dojo api user-contact-infos delete-preview-list
delete_preview_list
Usage:
dojo api user-contact-infos delete-preview-list [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this user
contact info. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api user-contact-infos destroy
destroy
Usage:
dojo api user-contact-infos destroy [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this user contact info.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api user-contact-infos list
list
Usage:
dojo api user-contact-infos list [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--block-execution
--cell-number TEXT
--force-password-reset
--github-username TEXT
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
--password-last-reset DATETIME
--phone-number TEXT
--prefetch TEXT List of fields for which to prefetch model
instances and add those to the response
--slack-user-id TEXT
--slack-username TEXT
--title TEXT
--token-last-reset DATETIME
--twitter-username TEXT
--user INTEGER
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api user-contact-infos partial-update
partial_update
Usage:
dojo api user-contact-infos partial-update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this user
contact info. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--patched-user-contact-info-request TEXT
--help Show this message and exit.
dojo api user-contact-infos retrieve
retrieve
Usage:
dojo api user-contact-infos retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this user contact info.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--prefetch TEXT List of fields for which to prefetch model instances and
add those to the response
--help Show this message and exit.
dojo api user-contact-infos update
update
Usage:
dojo api user-contact-infos update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this user
contact info. [required]
--user-contact-info-request TEXT
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--help Show this message and exit.
dojo api user-profile
retrieve
Usage:
dojo api user-profile [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api users
methods from UsersApi.
Usage:
dojo api users [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
- create: create
- delete-preview-list: delete_preview_list
- destroy: destroy
- list: list
- partial-update: partial_update
- reset-api-token-create: reset_api_token_create
- retrieve: retrieve
- update: update
dojo api users create
create
Usage:
dojo api users create [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--username TEXT Required. 150 characters or fewer. Letters,
digits and @/./+/-/_ only.
--first-name TEXT
--last-name TEXT
--email TEXT
--is-active Designates whether this user should be
treated as active. Unselect this instead of
deleting accounts.
--is-superuser Designates that this user has all
permissions without explicitly assigning
them.
--password TEXT
--configuration-permissions INTEGER
--help Show this message and exit.
dojo api users delete-preview-list
delete_preview_list
Usage:
dojo api users delete-preview-list [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this
user. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--limit INTEGER Number of results to return per page.
--offset INTEGER The initial index from which to return the
results.
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api users destroy
destroy
Usage:
dojo api users destroy [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this user. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api users list
list
Usage:
dojo api users list [OPTIONS]
Options:
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--date-joined-after DATE
--date-joined-before DATE
--email TEXT
--first-name TEXT
--id INTEGER
--is-active
--is-superuser
--last-login-after DATE
--last-login-before DATE
--last-name TEXT
--limit INTEGER Number of results to return per page.
-o TEXT Ordering * `username` - Username *
`-username` - Username (descending) *
`last_name` - Last name * `-last_name` -
Last name (descending) * `first_name` -
First name * `-first_name` - First name
(descending) * `email` - Email * `-email` -
Email (descending) * `is_active` - Is active
* `-is_active` - Is active (descending) *
`is_superuser` - Is superuser *
`-is_superuser` - Is superuser (descending)
* `date_joined` - Date joined *
`-date_joined` - Date joined (descending) *
`last_login` - Last login * `-last_login` -
Last login (descending)
--offset INTEGER The initial index from which to return the
results.
--username TEXT
-m, --max-records INTEGER RANGE
Maximum number of records to emit. [x>=1]
--help Show this message and exit.
dojo api users partial-update
partial_update
Usage:
dojo api users partial-update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this user.
[required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response
item
--patched-user-request TEXT
--help Show this message and exit.
dojo api users reset-api-token-create
reset_api_token_create
Usage:
dojo api users reset-api-token-create [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this user.
[required]
--user-request TEXT [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api users retrieve
retrieve
Usage:
dojo api users retrieve [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this user. [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo api users update
update
Usage:
dojo api users update [OPTIONS]
Options:
--id INTEGER A unique integer value identifying this user.
[required]
--user-request TEXT [required]
--json Dump responses as JSON
--jq TEXT Apply a JMESPath expression to each response item
--help Show this message and exit.
dojo config
Show or edit the current CLI configuration
Usage:
dojo config [OPTIONS]
Options:
-e, --edit Open the config file in $VISUAL or $EDITOR
--help Show this message and exit.
dojo status
Quick connectivity check
Usage:
dojo status [OPTIONS]
Options:
--help Show this message and exit.
config.toml
The CLI reads its configuration from config.toml. By default it looks in the user config directory for
defectdojo-generated-api/config.toml, and if the file does not exist yet it will create one from the bundled example.
The important thing to know is that config.toml is tightly coupled to the CLI flags: config keys act as defaults for
options exposed by the root command and subcommands/groups. In practice, if a command supports a flag, the same option
name can usually be provided in config.toml, and a command-line flag still wins if both are set.
The main exceptions are --config and --env:
--configonly tells the CLI which TOML file to load, so it is not itself a value carried insideconfig.toml--envselects which[env.<name>]section to merge, so the config file usesdefault_envto provide its default value
Common examples:
host: default value for--hosttoken: default value for--tokenuser: default value for--userpassword: default value for--passworddisable_tls: default value for--disable-tlsdefault_env: default environment used when--envis not passed
This is not meant to be a rigid exhaustive list. The config file is primarily a place to pre-fill the same options you would otherwise pass on the command line.
Authentication rules:
- If
tokenis set, it is used anduser/passwordare ignored. - If
tokenis not set, the CLI usesuserandpassword. - Command-line flags override values from the config file.
Environment rules:
- Root-level values are the base configuration.
default_envpicks a named entry under[env.<name>].dojo --env prod ...merges[env.prod]over the root config.- This lets you keep shared defaults at the top level and only override what changes per environment.
Example:
default_env = "demo"
[env.demo]
host = "https://demo.defectdojo.org/"
user = "admin"
password = "..."
[env.local]
host = "http://localhost:8080"
token = "your-api-token"
disable_tls = true
With this file:
dojo statususes thedemoenvironment because ofdefault_envdojo --env local statususeshttp://localhost:8080, thelocaltoken, and disables TLS verificationdojo -e local --host https://dojo.example.com statususes thelocalconfig but overrideshostfrom the command line