5.4.2. Endpoint list

Note

In the table below the legend is:

• Ope: Operator role

• Adm: Administrator role

• WAuth: Without Authentication

• AUser: Authenticated User

Theme	Name	Verb	Role	Description
Analysers	/analysers/	GET	Ope, Adm	List and filter the analysers
Analysers	/analysers/{name}/	GET	Adm	Retrieve an analyser
Analysers	/analysers/{name}/proxy/	POST	Adm	Proxy a request to an analyser
Analysers	/analysers/{name}/status/	GET	Adm	Return an analyser status
Analysis-artefacts	/analysis-artefacts/	GET	Ope	List and filter the analysis artefacts
Analysis-artefacts	/analysis-artefacts/{id}/	GET	Ope	Retrieve an analysis artefact info.
Analysis-artefacts	/analysis-artefacts/{id}/	DELETE	Ope	Remove an analysis artefact
Analysis-artefacts	/analysis-artefacts/{id}/download/	GET	Ope	Download an analysis artefact
Analysis-tasks	/analysis-tasks/	GET	Adm	List and filter the analysis tasks
Analysis-tasks	/analysis-tasks/{id}/	GET	Adm	Retrieve an analyse task
Analysis	/analysis/	GET	Ope	List and filter the analyses
Analysis	/analysis/submit/	POST	Ope	Submit a file for a new analysis
Analysis	/analysis/{id}/	GET	Ope	Retrieve an analysis
Analysis	/analysis/{id}/behavior-data/	GET	Ope	Retrieve the behavior data stored for this analysis
Analysis	/analysis/{id}/download-artefacts/	GET	Ope	Download the analysis artefact(s) as a zip file.
Analysis	/analysis/{id}/download-pdf/	GET	Ope	Download the analysis pdf report
Analysis	/analysis/{id}/download-sample/	GET	Ope	Download the sample uploaded for the analysis as an encrypted zip file
Analysis	/analysis/{id}/retry/	POST	Ope	Retry the analysis with the given template
Analysis	/analysis/{id}/threat-chart/	GET	Ope	Generate the threat radar chart for the analysis
async-tasks	/async-tasks/	GET	Adm	List and filter the async tasks
async-tasks	/async-tasks/{id}/	GET	Adm	Retrieve an async task
async-tasks	/async-tasks/{id}/	DELETE	Adm	Remove an async task. Use with caution if the task is not finished
auth	/auth/login/	POST	WAuth	Get the user time limited session token through its username & password
auth	/auth/logout/	POST	WAuth	Logout current user
auth	/auth/tokens/	GET	Adm	List and filter the api tokens
auth	/auth/tokens/	POST	Adm	Create an api token
auth	/auth/tokens/purge-tokens/	POST	Adm	Remove the expired tokens
auth	/auth/tokens/{id}/	DELETE	Adm	Remove an api token
configuration	/configuration/license	GET	Adm	Get the product licence.
configuration	/configuration/license	PUT	Ope, Adm	Update the product licence.
configuration	/configuration/proxy/	GET	Adm	Get the proxy configuration.
configuration	/configuration/proxy/	PUT	Adm	Update the proxy configuration
data	/data/purge-samples/	POST	Adm	Remove the clean samples, analysis data, and related analysis artefacts
domain-analysis	/domain-analysis/	POST	Ope	Request a new domain analysis to gdgadetect analyser
gum	/gum/config/	GET	Adm	Change the Gum auto-update configuration
gum	/gum/hotfix/	POST	Adm	Upload and apply a hotfix
gum	/gum/hotfix/status/	GET	Adm	Retrieve the hotfix status
gum	/gum/update/	POST	Adm	Upload and apply an update
gum	/gum/update/status/	GET	Adm	Retrieve the update status
gum	/gum/upgrade/	GET	Adm	List the uploaded upgrade files that have not been applied yet
gum	/gum/upgrade/	POST	Adm	Upload and apply an upgrade
gum	/gum/upgrade/apply/	POST	Adm	Apply an already uploaded upgrade
gum	/gum/upgrade/status/	GET	Adm	Retrieve the upgrade status
gum	/gum/upgrade/upload/	POST	Adm	Upload an upgrade to apply it later
logs	/logs/download/	GET	Adm	Download the last log export
logs	/logs/export/	GET	Adm	Request to export the app logs
logs	/logs/status/	GET	Adm	Get the last log export status
ssl-settings	/ssl-settings/certificates/	GET	Adm	Remove the custom SSL certificate if it does exist
ssl-settings	/ssl-settings/certificates/	POST	Adm	Update the custom SSL certificate if provided and enable it or not
ssl-settings	/ssl-settings/certificates/	DELETE	Adm	Remove the custom SSL certificate if it does exist
status	/status/	GET	WAuth	Status endpoint to check if api is up
status	/status/user/	GET	WAuth	User status endpoint to check if the user is authenticated
templates	/templates/	GET	Ope, Adm	List and filter the templates
templates	/templates/	POST	Adm	Create a template
templates	/templates/{id}/	GET	Ope, Adm	Retrieve a template
templates	/templates/{id}/	PUT	Adm	Update a template
templates	/templates/{id}/	DELETE	Adm	Remove a template.
users-history	/users-history/authentication/	GET	Adm	List and filter the user authentication history
users-history	/users-history/authentication/{id}/	GET	Adm	Retrieve a user authentication history
users-history	/users-history/creation-deletion/	GET	Adm	List and filter the user creation / deletion history
users-history	/users-history/creation-deletion/{id}/	GET	Adm	Retrieve a user creation / deletion history
users-history	/users-history/permission/	GET	Adm	List and filter the user permission history
users-history	/users-history/permission/{id}/	GET	Adm	Retrieve a user permission history
users	/users/	GET	Adm	List and filter the users
users	/users/	POST	Adm	Create a user
users	/users/me/	GET	AUser	Retrieve the current user
users	/users/me/	PUT	AUser	Update the current user
users	/users/me/password-suggestions/	GET	AUser	Get password suggestions randomly generated
users	/users/me/password/	PUT	AUser	Set the user password
users	/users/me/reset-password/	POST	AUser	Reset the current user password and return the new one
users	/users/{id}/	GET	Adm	Retrieve a user
users	/users/{id}/	PUT	Adm	Update a user
users	/users/{id}/	DELETE	Adm	Remove a user
users	/users/{id}/reset-password/	POST	Adm	Reset a user password and return the new one

---