Missing info in Docs about assemblyline HOT 3 CLOSED

Thanks all for the replies! With your pointers I can see where all the info is I need now. Overall the docs feel a little disjointed and the local docs seem to not have enough info/examples to use stand alone. I'll open a PR if I can find any way to improve things.

Thanks again!

from assemblyline.

Thank you for reporting the broken link. It should be linked to here instead. This page is important to read whether you are using the Python client or any other tool as it will allow for better optimization.

Regarding the fact that we are missing the requirement for the "bin" key, you can find it in the page that you linked first:

For the metadata, those are currently used for the metadata section in the submission.
If you are looking for more information regarding the possible parameters, you should be able to find an updated list here as linked in the Python example.

We are currently adding new features that will allow some control on the metadata depending on the "type" parameter. Some documentation about it is in the works, which hopefully will answer a few other questions.

We do not often have people interacting with the system by writing their own tool instead of using the official python client. There is always more improvements to be done to documentation, so if you want to open a PR regarding what was unclear to you while reading the docs, we would be happy to look into it.

I will add a link to the Submission Params in the rest page, and fix the broken link in the Python page.
Hopefully that clarifies the first few things you looked at.

from assemblyline.

The API docs embedded in the application are even worse and are missing the fact that the binary file needs the key "bin" for submission to work.

The API docs for the /submit/ API do actually mention this in the notes when submitting a binary file:

Note 2:
    If you are submitting a file directly, you should use multipart/form-data encoding as this
    was done to reduce the memory footprint and speedup file transfers.
     ** Read documentation of mime multipart standard if your library does not support it**

The multipart/form-data for sending binary has two parts:
    - The first part contains a JSON dump of the optional params and uses the name 'json'
    - The last part conatins the file binary, uses the name 'bin' and includes a filename

from assemblyline.