# Systems

## Check result of a download traces job.

> \*\*API Key Scope\*\*: systems / download\_traces

```json
{"openapi":"3.0.1","info":{"title":"Nodeum API","version":"2.1.0"},"servers":[{"url":"{url}/api/v2","variables":{"url":{"default":"http://localhost","description":"URL of server"}}}],"security":[{"BasicAuth":[]},{"BearerAuth":[]},{"JWT":[]}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic","description":"Pass the username and password of a user in the authorization header.\nThis currently gives full access."},"BearerAuth":{"type":"apiKey","description":"Create an API Key associated to user.\nAccess can be restricted with the scope.\nEach API call described below has a scoped mentionned in its description.\n\nFor example :\n\n**API Key Scope**: files / index\n\nThis means that the API key should have a scope with controller as *files*\nand the action as *index*.","name":"Authorization","in":"header"},"JWT":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"responses":{"download_traces":{"description":"A completed job for downloading traces.","content":{"application/json":{"schema":{"type":"string","format":"binary"}},"application/tar+gzip":{"schema":{"type":"string","format":"binary"}}}},"active_job_status":{"description":"An active job that may be queued, working, completed or failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/active_job_status"}}}}},"schemas":{"active_job_status":{"type":"object","properties":{"job_id":{"type":"string","readOnly":true},"status":{"type":"string","readOnly":true,"enum":["queued","working","completed","failed"]},"progress":{"type":"integer","readOnly":true},"total":{"type":"integer","readOnly":true}}}},"parameters":{"job_id":{"name":"job_id","in":"query","description":"ID of active job","required":true,"schema":{"type":"string"}}}},"paths":{"/systems/download_traces":{"get":{"summary":"Check result of a download traces job.","operationId":"result_download_traces","tags":["systems"],"description":"**API Key Scope**: systems / download_traces","responses":{"200":{"$ref":"#/components/responses/download_traces"},"202":{"$ref":"#/components/responses/active_job_status"}},"parameters":[{"$ref":"#/components/parameters/job_id"}]}}}}
```

## Trigger a download traces request.

> \*\*API Key Scope\*\*: systems / download\_traces

```json
{"openapi":"3.0.1","info":{"title":"Nodeum API","version":"2.1.0"},"servers":[{"url":"{url}/api/v2","variables":{"url":{"default":"http://localhost","description":"URL of server"}}}],"security":[{"BasicAuth":[]},{"BearerAuth":[]},{"JWT":[]}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic","description":"Pass the username and password of a user in the authorization header.\nThis currently gives full access."},"BearerAuth":{"type":"apiKey","description":"Create an API Key associated to user.\nAccess can be restricted with the scope.\nEach API call described below has a scoped mentionned in its description.\n\nFor example :\n\n**API Key Scope**: files / index\n\nThis means that the API key should have a scope with controller as *files*\nand the action as *index*.","name":"Authorization","in":"header"},"JWT":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"responses":{"active_job_status":{"description":"An active job that may be queued, working, completed or failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/active_job_status"}}}}},"schemas":{"active_job_status":{"type":"object","properties":{"job_id":{"type":"string","readOnly":true},"status":{"type":"string","readOnly":true,"enum":["queued","working","completed","failed"]},"progress":{"type":"integer","readOnly":true},"total":{"type":"integer","readOnly":true}}}},"parameters":{"download_traces_type":{"name":"type","in":"query","description":"Type of traces to download","required":true,"schema":{"type":"string","enum":["interface","core","data_mining","fuse","library_manager","manager","watchdog","system","all"]}}}},"paths":{"/systems/download_traces":{"put":{"summary":"Trigger a download traces request.","operationId":"trigger_download_traces","description":"**API Key Scope**: systems / download_traces","tags":["systems"],"responses":{"202":{"$ref":"#/components/responses/active_job_status"}},"parameters":[{"$ref":"#/components/parameters/download_traces_type"}]}}}}
```

## POST /systems/reset/generate\_vars

> Creates a YAML file with selected tables and downloads it

```json
{"openapi":"3.0.1","info":{"title":"Nodeum API","version":"2.1.0"},"servers":[{"url":"{url}/api/v2","variables":{"url":{"default":"http://localhost","description":"URL of server"}}}],"security":[{"BasicAuth":[]},{"BearerAuth":[]},{"JWT":[]}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic","description":"Pass the username and password of a user in the authorization header.\nThis currently gives full access."},"BearerAuth":{"type":"apiKey","description":"Create an API Key associated to user.\nAccess can be restricted with the scope.\nEach API call described below has a scoped mentionned in its description.\n\nFor example :\n\n**API Key Scope**: files / index\n\nThis means that the API key should have a scope with controller as *files*\nand the action as *index*.","name":"Authorization","in":"header"},"JWT":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"requestBodies":{"reset_form":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/reset"}}},"required":true}},"schemas":{"reset":{"type":"object","properties":{"sections":{"type":"array","description":"sections selected for reset","items":{"required":["value"],"type":"object","properties":{"value":{"type":"string","enum":["full","nas_config","nas_storage","nas_pools","tapes_libs","tapes_drives","tapes_pools","clouds_config","clouds_storage","clouds_pools","tasks","history","templates","containers","catalog","web_users","logs","audits","statistics","traces"]},"after":{"type":"string","description":"after date-time criteria for history reset","format":"date-time"},"before":{"type":"string","description":"before date-time criteria for history reset","format":"date-time"}}}}}}},"responses":{"reset":{"description":"The var file created","content":{"application/x-yaml":{"schema":{"type":"string","format":"binary"}}}}}},"paths":{"/systems/reset/generate_vars":{"post":{"summary":"Creates a YAML file with selected tables and downloads it","operationId":"download_reset_vars","tags":["systems"],"requestBody":{"$ref":"#/components/requestBodies/reset_form"},"responses":{"200":{"$ref":"#/components/responses/reset"}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.nodeum.io/data-archiving/api-developers/api-reference-nodeum-data-archiving/systems.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.