> For the complete documentation index, see [llms.txt](https://docs.nodeum.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.nodeum.io/data-archiving/api-developers/api-reference-nodeum-data-archiving/containers.md).

# Containers

## Lists all containers.

> \*\*API Key Scope\*\*: containers / index

```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":{"containers_index":{"description":"List of containers.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/container_collection"}}}}},"schemas":{"container_collection":{"type":"object","properties":{"count":{"type":"integer","readOnly":true},"containers":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/container"}}}},"container":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"format":"int64"},"name":{"type":"string"},"comment":{"type":"string"},"push_pool_id":{"type":"integer","format":"int64"},"cleaning_pool_id":{"type":"integer","format":"int64"},"quota_total_size":{"type":"integer","format":"int64"},"quota_on_cache":{"type":"integer","format":"int64"},"stat_total_files":{"type":"integer","readOnly":true,"format":"int64"},"only_on_cache_file_count":{"type":"integer","readOnly":true,"format":"int64"},"stat_total_size":{"type":"integer","readOnly":true,"format":"int64"},"stat_size_on_cache":{"type":"integer","readOnly":true,"format":"int64"},"only_on_cache_file_size_sum":{"type":"integer","readOnly":true,"format":"int64"},"guest_right":{"type":"string","enum":["none","read","read_write"]},"last_update":{"type":"string","readOnly":true,"format":"date-time"},"protocol_smb":{"type":"boolean"},"protocol_nfs":{"type":"boolean"},"protocol_s3":{"type":"boolean"}}}},"parameters":{"limit":{"name":"limit","in":"query","description":"The number of items to display for pagination.","schema":{"type":"integer"}},"offset":{"name":"offset","in":"query","description":"The number of items to skip for pagination.","schema":{"type":"integer"}},"sort_by":{"name":"sort_by","in":"query","description":"Sort results by attribute.\n\nCan sort on multiple attributes, separated by `|`.\nOrder direction can be suffixing the attribute by either `:asc` (default) or `:desc`.","style":"pipeDelimited","schema":{"type":"array","items":{"type":"string"}}},"filter_id":{"name":"id","in":"query","description":"Filter on id","schema":{"type":"string"}},"filter_name":{"name":"name","in":"query","description":"Filter on name","schema":{"type":"string"}},"filter_comment":{"name":"comment","in":"query","description":"Filter on comment","schema":{"type":"string"}},"filter_quota_total_size":{"name":"quota_total_size","in":"query","description":"Filter on quota total size","schema":{"type":"string"}},"filter_quota_on_cache":{"name":"quota_on_cache","in":"query","description":"Filter on quota on cache","schema":{"type":"string"}},"filter_stat_total_files":{"name":"stat_total_files","in":"query","description":"Filter on stat total files","schema":{"type":"string"}},"filter_stat_total_size":{"name":"stat_total_size","in":"query","description":"Filter on stat total size","schema":{"type":"string"}},"filter_stat_size_on_cache":{"name":"stat_size_on_cache","in":"query","description":"Filter on stat size on cache","schema":{"type":"string"}},"filter_guest_right":{"name":"guest_right","in":"query","description":"Filter on guest right","schema":{"type":"string"}},"filter_last_update":{"name":"last_update","in":"query","description":"Filter on last update","schema":{"type":"string"}}}},"paths":{"/containers":{"get":{"summary":"Lists all containers.","tags":["containers"],"operationId":"index_containers","description":"**API Key Scope**: containers / index","responses":{"200":{"$ref":"#/components/responses/containers_index"}},"parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/sort_by"},{"$ref":"#/components/parameters/filter_id"},{"$ref":"#/components/parameters/filter_name"},{"$ref":"#/components/parameters/filter_comment"},{"$ref":"#/components/parameters/filter_quota_total_size"},{"$ref":"#/components/parameters/filter_quota_on_cache"},{"$ref":"#/components/parameters/filter_stat_total_files"},{"$ref":"#/components/parameters/filter_stat_total_size"},{"$ref":"#/components/parameters/filter_stat_size_on_cache"},{"$ref":"#/components/parameters/filter_guest_right"},{"$ref":"#/components/parameters/filter_last_update"}]}}}}
```

## Creates a new container.

> \*\*API Key Scope\*\*: containers / create

```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":{"containers_show":{"description":"A specific container.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/container"}}}},"unprocessable_entity":{"description":"The received resource was not correctly formatted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"schemas":{"container":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"format":"int64"},"name":{"type":"string"},"comment":{"type":"string"},"push_pool_id":{"type":"integer","format":"int64"},"cleaning_pool_id":{"type":"integer","format":"int64"},"quota_total_size":{"type":"integer","format":"int64"},"quota_on_cache":{"type":"integer","format":"int64"},"stat_total_files":{"type":"integer","readOnly":true,"format":"int64"},"only_on_cache_file_count":{"type":"integer","readOnly":true,"format":"int64"},"stat_total_size":{"type":"integer","readOnly":true,"format":"int64"},"stat_size_on_cache":{"type":"integer","readOnly":true,"format":"int64"},"only_on_cache_file_size_sum":{"type":"integer","readOnly":true,"format":"int64"},"guest_right":{"type":"string","enum":["none","read","read_write"]},"last_update":{"type":"string","readOnly":true,"format":"date-time"},"protocol_smb":{"type":"boolean"},"protocol_nfs":{"type":"boolean"},"protocol_s3":{"type":"boolean"}}},"error":{"type":"object","properties":{"details":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/attribute_error"}},"description":"Parsable objects describing the errors. The key is the invalid attribute name."},"messages":{"type":"array","description":"English description of the errors.","items":{"type":"string"}}}},"attribute_error":{"required":["error"],"type":"object","properties":{"error":{"type":"string"}},"discriminator":{"propertyName":"error"}}},"requestBodies":{"container_body":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/container"}}},"required":true}}},"paths":{"/containers":{"post":{"summary":"Creates a new container.","operationId":"create_container","description":"**API Key Scope**: containers / create","tags":["containers"],"responses":{"201":{"$ref":"#/components/responses/containers_show"},"422":{"$ref":"#/components/responses/unprocessable_entity"}},"requestBody":{"$ref":"#/components/requestBodies/container_body"}}}}}
```

## Check result of the containers reconfiguration.

> \*\*API Key Scope\*\*: containers / configure

```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":{"job_id":{"name":"job_id","in":"query","description":"ID of active job","required":true,"schema":{"type":"string"}}}},"paths":{"/containers/-/configure":{"get":{"summary":"Check result of the containers reconfiguration.","operationId":"configure_containers_result","tags":["containers"],"description":"**API Key Scope**: containers / configure","responses":{"200":{"$ref":"#/components/responses/active_job_status"},"202":{"$ref":"#/components/responses/active_job_status"}},"parameters":[{"$ref":"#/components/parameters/job_id"}]}}}}
```

## Reconfigure all containers for SMB connections.

> \*\*API Key Scope\*\*: containers / configure

```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}}}}},"paths":{"/containers/-/configure":{"put":{"summary":"Reconfigure all containers for SMB connections.","operationId":"configure_containers","description":"**API Key Scope**: containers / configure","tags":["containers"],"responses":{"202":{"$ref":"#/components/responses/active_job_status"}}}}}}
```

## Displays a specific container.

> \*\*API Key Scope\*\*: containers / show

```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":{"containers_show":{"description":"A specific container.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/container"}}}}},"schemas":{"container":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"format":"int64"},"name":{"type":"string"},"comment":{"type":"string"},"push_pool_id":{"type":"integer","format":"int64"},"cleaning_pool_id":{"type":"integer","format":"int64"},"quota_total_size":{"type":"integer","format":"int64"},"quota_on_cache":{"type":"integer","format":"int64"},"stat_total_files":{"type":"integer","readOnly":true,"format":"int64"},"only_on_cache_file_count":{"type":"integer","readOnly":true,"format":"int64"},"stat_total_size":{"type":"integer","readOnly":true,"format":"int64"},"stat_size_on_cache":{"type":"integer","readOnly":true,"format":"int64"},"only_on_cache_file_size_sum":{"type":"integer","readOnly":true,"format":"int64"},"guest_right":{"type":"string","enum":["none","read","read_write"]},"last_update":{"type":"string","readOnly":true,"format":"date-time"},"protocol_smb":{"type":"boolean"},"protocol_nfs":{"type":"boolean"},"protocol_s3":{"type":"boolean"}}}}},"paths":{"/containers/{container_id}":{"get":{"summary":"Displays a specific container.","operationId":"show_container","description":"**API Key Scope**: containers / show","tags":["containers"],"responses":{"200":{"$ref":"#/components/responses/containers_show"}}}}}}
```

## Updates a specific container.

> \*\*API Key Scope\*\*: containers / update

```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":{"containers_show":{"description":"A specific container.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/container"}}}},"unprocessable_entity":{"description":"The received resource was not correctly formatted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"schemas":{"container":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"format":"int64"},"name":{"type":"string"},"comment":{"type":"string"},"push_pool_id":{"type":"integer","format":"int64"},"cleaning_pool_id":{"type":"integer","format":"int64"},"quota_total_size":{"type":"integer","format":"int64"},"quota_on_cache":{"type":"integer","format":"int64"},"stat_total_files":{"type":"integer","readOnly":true,"format":"int64"},"only_on_cache_file_count":{"type":"integer","readOnly":true,"format":"int64"},"stat_total_size":{"type":"integer","readOnly":true,"format":"int64"},"stat_size_on_cache":{"type":"integer","readOnly":true,"format":"int64"},"only_on_cache_file_size_sum":{"type":"integer","readOnly":true,"format":"int64"},"guest_right":{"type":"string","enum":["none","read","read_write"]},"last_update":{"type":"string","readOnly":true,"format":"date-time"},"protocol_smb":{"type":"boolean"},"protocol_nfs":{"type":"boolean"},"protocol_s3":{"type":"boolean"}}},"error":{"type":"object","properties":{"details":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/attribute_error"}},"description":"Parsable objects describing the errors. The key is the invalid attribute name."},"messages":{"type":"array","description":"English description of the errors.","items":{"type":"string"}}}},"attribute_error":{"required":["error"],"type":"object","properties":{"error":{"type":"string"}},"discriminator":{"propertyName":"error"}}},"requestBodies":{"container_body":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/container"}}},"required":true}}},"paths":{"/containers/{container_id}":{"put":{"summary":"Updates a specific container.","operationId":"update_container","description":"**API Key Scope**: containers / update","tags":["containers"],"responses":{"200":{"$ref":"#/components/responses/containers_show"},"422":{"$ref":"#/components/responses/unprocessable_entity"}},"requestBody":{"$ref":"#/components/requestBodies/container_body"}}}}}
```

## Destroys a specific container.

> \*\*API Key Scope\*\*: containers / destroy

```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"}}},"paths":{"/containers/{container_id}":{"delete":{"summary":"Destroys a specific container.","operationId":"destroy_container","description":"**API Key Scope**: containers / destroy","tags":["containers"],"responses":{"204":{"description":"Container destroyed."}}}}}}
```

## Displays what the catalog shows about a container.

> \*\*API Key Scope\*\*: containers / details\
> \
> Contents, limits, access, automation and the tasks reading or writing the container, in one response. Standard users get no list of users and groups. Never cached.

```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":{"containers_details":{"description":"What the catalog shows about a container.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/container_details"}}}},"not_found":{"description":"The requested resource was not found. The detailed error will be of type `not_found`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"internal_error":{"description":"The server could not read the catalog. The error details are `$system` / `internal_error`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"schemas":{"container_details":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"format":"int64"},"name":{"type":"string","readOnly":true},"contents":{"$ref":"#/components/schemas/container_details_contents"},"limits":{"$ref":"#/components/schemas/container_details_limits"},"access":{"$ref":"#/components/schemas/container_details_access"},"automation":{"$ref":"#/components/schemas/container_details_automation"},"tasks":{"$ref":"#/components/schemas/container_details_tasks"}}},"container_details_contents":{"type":"object","description":"Counted in the background every few minutes. Online files only, folders excluded.","properties":{"files":{"type":"integer","readOnly":true,"format":"int64"},"size":{"type":"integer","readOnly":true,"format":"int64"}}},"container_details_limits":{"type":"object","properties":{"max_size":{"type":"integer","readOnly":true,"nullable":true,"description":"Quota in bytes; null when there is no quota.","format":"int64"},"used_percent":{"type":"number","readOnly":true,"nullable":true,"description":"Counted size against the quota. Not capped at 100, null when there is no quota.","format":"double"},"cache_limit_percent":{"type":"integer","readOnly":true,"nullable":true,"description":"Share of the whole cache this container may use; null when unlimited."}}},"container_details_access":{"type":"object","properties":{"smb":{"type":"string","readOnly":true,"description":"`not_enabled` when the system does not allow SMB shares.","enum":["on","off","not_enabled"]},"guest":{"type":"string","readOnly":true,"enum":["none","read","read_write"]},"nfs":{"type":"string","readOnly":true,"description":"NFS exports every container; there is no per-container setting.","enum":["all_containers","not_enabled"]},"users_and_groups":{"type":"array","readOnly":true,"nullable":true,"description":"Admins only; null for standard users.","items":{"$ref":"#/components/schemas/container_details_principal"}}}},"container_details_principal":{"type":"object","properties":{"name":{"type":"string","readOnly":true},"type":{"type":"string","readOnly":true,"enum":["user","group"]},"right":{"type":"string","readOnly":true,"enum":["none","read","read_write"]}}},"container_details_automation":{"type":"object","description":"Each pool is null when that automation is disabled.","properties":{"push_pool":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/container_pool_ref"}]},"cleaning_pool":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/container_pool_ref"}]}}},"container_pool_ref":{"type":"object","description":"A pool referred to by id, which may no longer exist (container automation, archive summaries).","properties":{"id":{"type":"integer","readOnly":true,"format":"int64"},"name":{"type":"string","readOnly":true,"nullable":true},"type":{"type":"string","readOnly":true,"nullable":true,"enum":["active_archive","offline_archive","data_exchange","scratch","data_enrichment","primary"]},"content":{"type":"string","readOnly":true,"nullable":true,"enum":["tape","cloud","nas"]},"missing":{"type":"boolean","readOnly":true,"description":"The pool no longer exists; name, type and content are null."}}},"container_details_tasks":{"type":"object","description":"The tasks reading from or writing to a place: a container, or a primary or secondary pool.","properties":{"reading":{"type":"integer","readOnly":true,"nullable":true,"description":"Tasks reading from this place (the container, pool or tape, or what is in it). Null when the lookup ran out of time."},"writing":{"type":"integer","readOnly":true,"nullable":true,"description":"Tasks writing to this place (the container, pool or tape, or what is in it). Null when the lookup ran out of time."},"last_run":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/container_details_last_run"}]}}},"container_details_last_run":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"format":"int64"},"name":{"type":"string","readOnly":true},"job_started":{"type":"string","readOnly":true,"format":"date-time"},"status":{"type":"string","readOnly":true}}},"error":{"type":"object","properties":{"details":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/attribute_error"}},"description":"Parsable objects describing the errors. The key is the invalid attribute name."},"messages":{"type":"array","description":"English description of the errors.","items":{"type":"string"}}}},"attribute_error":{"required":["error"],"type":"object","properties":{"error":{"type":"string"}},"discriminator":{"propertyName":"error"}}}},"paths":{"/containers/{container_id}/details":{"get":{"summary":"Displays what the catalog shows about a container.","description":"**API Key Scope**: containers / details\n\nContents, limits, access, automation and the tasks reading or writing the container, in one response. Standard users get no list of users and groups. Never cached.","operationId":"show_container_details","tags":["containers"],"responses":{"200":{"$ref":"#/components/responses/containers_details"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_error"}}}}}}
```

## Displays where the files of a container are archived, per pool.

> \*\*API Key Scope\*\*: containers / archive\_summary\
> \
> Read from the catalog index: counts are approximate and can lag behind the archive. Not cached by clients; the server reuses an answer for up to 60 s (an unavailable index for 15 s).

```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":{"containers_archive_summary":{"description":"Where the files of a container or primary pool are archived, per pool.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/container_archive_summary"}}}},"not_found":{"description":"The requested resource was not found. The detailed error will be of type `not_found`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"internal_error":{"description":"The server could not read the catalog. The error details are `$system` / `internal_error`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"catalog_unavailable":{"description":"The catalog index could not answer (stopped, too slow, or it answered without counts). The error is `catalog_unavailable`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generic_error"}}}}},"schemas":{"container_archive_summary":{"type":"object","properties":{"no_copy":{"$ref":"#/components/schemas/container_archive_summary_no_copy"},"pools":{"type":"array","readOnly":true,"description":"At most 50 pools; see pools_total.","items":{"$ref":"#/components/schemas/container_archive_summary_pool"}},"pools_total":{"type":"integer","readOnly":true}}},"container_archive_summary_no_copy":{"type":"object","description":"Files with no archive copy.","properties":{"files":{"type":"integer","readOnly":true,"format":"int64"},"size":{"type":"integer","readOnly":true,"format":"int64"}}},"container_archive_summary_pool":{"allOf":[{"$ref":"#/components/schemas/container_pool_ref"},{"type":"object","properties":{"files":{"type":"integer","readOnly":true,"description":"Files with at least one copy on this pool (approximate).","format":"int64"}}}]},"container_pool_ref":{"type":"object","description":"A pool referred to by id, which may no longer exist (container automation, archive summaries).","properties":{"id":{"type":"integer","readOnly":true,"format":"int64"},"name":{"type":"string","readOnly":true,"nullable":true},"type":{"type":"string","readOnly":true,"nullable":true,"enum":["active_archive","offline_archive","data_exchange","scratch","data_enrichment","primary"]},"content":{"type":"string","readOnly":true,"nullable":true,"enum":["tape","cloud","nas"]},"missing":{"type":"boolean","readOnly":true,"description":"The pool no longer exists; name, type and content are null."}}},"error":{"type":"object","properties":{"details":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/attribute_error"}},"description":"Parsable objects describing the errors. The key is the invalid attribute name."},"messages":{"type":"array","description":"English description of the errors.","items":{"type":"string"}}}},"attribute_error":{"required":["error"],"type":"object","properties":{"error":{"type":"string"}},"discriminator":{"propertyName":"error"}},"generic_error":{"type":"object","properties":{"error":{"type":"string"}}}}},"paths":{"/containers/{container_id}/archive_summary":{"get":{"summary":"Displays where the files of a container are archived, per pool.","description":"**API Key Scope**: containers / archive_summary\n\nRead from the catalog index: counts are approximate and can lag behind the archive. Not cached by clients; the server reuses an answer for up to 60 s (an unavailable index for 15 s).","operationId":"show_container_archive_summary","tags":["containers"],"responses":{"200":{"$ref":"#/components/responses/containers_archive_summary"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_error"},"503":{"$ref":"#/components/responses/catalog_unavailable"}}}}}}
```

## Displays what the catalog shows about a file or folder of a container.

> \*\*API Key Scope\*\*: container\_files / details\
> \
> State, attributes, access list, metadata and archive copies of a file, or what a folder directly holds. Not cached by clients; the server reuses owner and group names for up to 10 minutes (an unknown id for 2).

```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":{"container_files_details":{"description":"What the catalog shows about a file or folder of a container or primary pool.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/container_file_details"}}}},"not_found":{"description":"The requested resource was not found. The detailed error will be of type `not_found`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"internal_error":{"description":"The server could not read the catalog. The error details are `$system` / `internal_error`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"schemas":{"container_file_details":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"format":"int64"},"name":{"type":"string","readOnly":true},"type":{"type":"string","readOnly":true,"enum":["file","folder"]},"path":{"type":"string","readOnly":true,"nullable":true,"description":"As the catalog index stores it; null when the catalog cannot build it (a folder chain deeper than 50 levels, or a name with characters its path function cannot hold)."},"size":{"type":"integer","readOnly":true,"nullable":true,"description":"Files only.","format":"int64"},"state":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/container_file_state"}]},"attributes":{"$ref":"#/components/schemas/container_file_attributes"},"acl":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/container_file_acl"}]},"metadata":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/container_file_metadata"}]},"copies":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/container_file_copies"}]},"contents":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/container_file_contents"}]}}},"container_file_state":{"type":"object","description":"Files only. Also used by the primary and secondary pool entry details and the tape details.","properties":{"kind":{"type":"string","readOnly":true,"nullable":true,"description":"`moved_offline`: moved to an offline archive, no longer on the share. `deleted`: deleted from the share, kept in the catalog for its copies.","enum":["in_cache","out_of_cache","moved_offline","deleted"]},"since":{"type":"string","readOnly":true,"nullable":true,"description":"When the file came into (in_cache) or went out of (out_of_cache) the cache.","format":"date-time"}}},"container_file_attributes":{"type":"object","description":"Also used by the primary and secondary pool entry details and the tape details.","properties":{"modified":{"type":"string","readOnly":true,"nullable":true,"format":"date-time"},"changed":{"type":"string","readOnly":true,"nullable":true,"format":"date-time"},"accessed":{"type":"string","readOnly":true,"nullable":true,"format":"date-time"},"uid":{"type":"integer","readOnly":true,"nullable":true,"format":"int64"},"gid":{"type":"integer","readOnly":true,"nullable":true,"format":"int64"},"owner_name":{"type":"string","readOnly":true,"nullable":true,"description":"Account name of the uid from the appliance's directory; null when it has none or the directory did not answer in time."},"group_name":{"type":"string","readOnly":true,"nullable":true,"description":"Group name of the gid from the appliance's directory; null when it has none or the directory did not answer in time."},"permissions":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/container_file_permissions"}]}}},"container_file_permissions":{"type":"object","properties":{"octal":{"type":"string","readOnly":true},"symbolic":{"type":"string","readOnly":true}}},"container_file_acl":{"type":"object","description":"POSIX access list stored with the entry.","properties":{"access":{"type":"array","readOnly":true,"nullable":true,"items":{"$ref":"#/components/schemas/container_file_acl_entry"}}}},"container_file_acl_entry":{"type":"object","properties":{"tag":{"type":"string","readOnly":true,"enum":["user_obj","user","group_obj","group","mask","other"]},"id":{"type":"integer","readOnly":true,"nullable":true,"format":"int64"},"name":{"type":"string","readOnly":true,"nullable":true,"description":"Name of a named user or group from the appliance's directory; null for the other tags, or when the id has no name."},"perm":{"type":"string","readOnly":true}}},"container_file_metadata":{"type":"object","description":"Also used by the primary and secondary pool entry details and the tape details.","properties":{"items":{"type":"array","readOnly":true,"description":"At most 200; see total.","items":{"$ref":"#/components/schemas/container_file_metadata_item"}},"total":{"type":"integer","readOnly":true}}},"container_file_metadata_item":{"type":"object","properties":{"key":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":true,"nullable":true},"value":{"type":"string","readOnly":true,"description":"At most 1000 characters, followed by \"…\" when cut; \"(binary, N bytes)\" (or \"(binary, more than 1000 bytes)\") when not text."}}},"container_file_copies":{"type":"object","description":"Also used by the primary and secondary pool entry details and the tape details.","properties":{"items":{"type":"array","readOnly":true,"description":"At most 100; see total.","items":{"$ref":"#/components/schemas/container_file_copy"}},"total":{"type":"integer","readOnly":true}}},"container_file_copy":{"type":"object","description":"Also used by the primary and secondary pool entry details and the tape details.","properties":{"pool":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/container_file_copy_pool"}]},"stored_on":{"$ref":"#/components/schemas/container_file_stored_on"},"written_at":{"type":"string","readOnly":true,"nullable":true,"format":"date-time"},"pending_removal":{"type":"boolean","readOnly":true,"description":"The file was deleted from the share; maintenance will remove this copy."},"task":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/container_file_copy_task"}]},"checksum":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/container_file_checksum"}]}}},"container_file_copy_pool":{"type":"object","description":"Also used by the primary and secondary pool entry details and the tape details.","properties":{"id":{"type":"integer","readOnly":true,"format":"int64"},"name":{"type":"string","readOnly":true},"type":{"type":"string","readOnly":true,"nullable":true,"enum":["active_archive","offline_archive","data_exchange","scratch","data_enrichment","primary"]},"content":{"type":"string","readOnly":true,"nullable":true,"enum":["tape","cloud","nas"]}}},"container_file_stored_on":{"type":"object","properties":{"kind":{"type":"string","readOnly":true,"nullable":true,"enum":["tape","nas","cloud"]},"missing":{"type":"boolean","readOnly":true,"description":"The volume, share or bucket the copy points to no longer exists."},"tape":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/container_file_tape"}]},"nas_share":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/container_file_nas_share"}]},"cloud_bucket":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/container_file_cloud_bucket"}]}}},"container_file_tape":{"type":"object","description":"Also used by the primary and secondary pool entry details and the tape details.","properties":{"barcode":{"type":"string","readOnly":true},"ejected":{"type":"boolean","readOnly":true,"description":"The tape is out of the library (not in an import/export slot)."}}},"container_file_nas_share":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"format":"int64"},"name":{"type":"string","readOnly":true},"nas":{"type":"string","readOnly":true,"nullable":true}}},"container_file_cloud_bucket":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"format":"int64"},"name":{"type":"string","readOnly":true},"connector":{"type":"string","readOnly":true,"nullable":true}}},"container_file_copy_task":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"nullable":true,"description":"Null when the task no longer exists.","format":"int64"},"name":{"type":"string","readOnly":true,"nullable":true},"deleted":{"type":"boolean","readOnly":true},"run_id":{"type":"string","readOnly":true,"nullable":true,"description":"The run of the task that wrote the copy, for the task run page; null when the run is no longer recorded. A string like the ids of the task runs API."}}},"container_file_checksum":{"type":"object","properties":{"type":{"type":"string","readOnly":true,"enum":["crc","md5","xxhash64"]},"value":{"type":"string","readOnly":true}}},"container_file_contents":{"type":"object","description":"Folders only. Direct children as listed on the share.","properties":{"folders":{"type":"integer","readOnly":true,"nullable":true},"files":{"type":"integer","readOnly":true,"nullable":true,"description":"Files on the share (not deleted, not moved to an offline archive)."},"more_than":{"type":"boolean","readOnly":true,"description":"A count stopped at 10000."},"partial":{"type":"boolean","readOnly":true,"description":"Counting ran out of time; the counts are null."}}},"error":{"type":"object","properties":{"details":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/attribute_error"}},"description":"Parsable objects describing the errors. The key is the invalid attribute name."},"messages":{"type":"array","description":"English description of the errors.","items":{"type":"string"}}}},"attribute_error":{"required":["error"],"type":"object","properties":{"error":{"type":"string"}},"discriminator":{"propertyName":"error"}}}},"paths":{"/containers/{container_id}/files/{file_id}/details":{"get":{"summary":"Displays what the catalog shows about a file or folder of a container.","description":"**API Key Scope**: container_files / details\n\nState, attributes, access list, metadata and archive copies of a file, or what a folder directly holds. Not cached by clients; the server reuses owner and group names for up to 10 minutes (an unknown id for 2).","operationId":"show_container_file_details","tags":["containers"],"responses":{"200":{"$ref":"#/components/responses/container_files_details"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_error"}}}}}}
```

## Displays where the archive copies of a few files of a container are.

> \*\*API Key Scope\*\*: container\_files / copies\
> \
> For the Location column of a file list: per file of the container, the kinds of storage and the pools that hold a copy. A file without a copy is answered with an empty list. Ids that are not files of this container are left out; without ids, the list is empty. Never cached.

```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":{"container_file_copies_index":{"description":"Where the copies of the requested files are.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/container_file_copies_batch"}}}},"not_found":{"description":"The requested resource was not found. The detailed error will be of type `not_found`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"unprocessable_entity":{"description":"The received resource was not correctly formatted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"internal_error":{"description":"The server could not read the catalog. The error details are `$system` / `internal_error`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"schemas":{"container_file_copies_batch":{"type":"object","properties":{"files":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/container_file_copies_batch_file"}}}},"container_file_copies_batch_file":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"format":"int64"},"copies":{"type":"array","readOnly":true,"description":"One entry per kind of storage and pool; empty when the file has no copy.","items":{"$ref":"#/components/schemas/container_file_copies_batch_copy"}}}},"container_file_copies_batch_copy":{"type":"object","properties":{"kind":{"type":"string","readOnly":true,"enum":["tape","nas","cloud"]},"pool":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/container_file_copy_pool"}]},"pending_removal":{"type":"boolean","readOnly":true,"description":"True when every copy in this place is scheduled for removal."}}},"container_file_copy_pool":{"type":"object","description":"Also used by the primary and secondary pool entry details and the tape details.","properties":{"id":{"type":"integer","readOnly":true,"format":"int64"},"name":{"type":"string","readOnly":true},"type":{"type":"string","readOnly":true,"nullable":true,"enum":["active_archive","offline_archive","data_exchange","scratch","data_enrichment","primary"]},"content":{"type":"string","readOnly":true,"nullable":true,"enum":["tape","cloud","nas"]}}},"error":{"type":"object","properties":{"details":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/attribute_error"}},"description":"Parsable objects describing the errors. The key is the invalid attribute name."},"messages":{"type":"array","description":"English description of the errors.","items":{"type":"string"}}}},"attribute_error":{"required":["error"],"type":"object","properties":{"error":{"type":"string"}},"discriminator":{"propertyName":"error"}}}},"paths":{"/containers/{container_id}/file_copies":{"get":{"summary":"Displays where the archive copies of a few files of a container are.","description":"**API Key Scope**: container_files / copies\n\nFor the Location column of a file list: per file of the container, the kinds of storage and the pools that hold a copy. A file without a copy is answered with an empty list. Ids that are not files of this container are left out; without ids, the list is empty. Never cached.","operationId":"index_container_file_copies","tags":["containers"],"parameters":[{"name":"ids","in":"query","description":"Comma-separated numeric ids of the files, at most 200.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/container_file_copies_index"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_error"}}}}}}
```

## Fetches files and folders of a container back into the cache.

> \*\*API Key Scope\*\*: container\_fetches / create\
> \
> Creates the Active Archive Copy tasks that bring back into the cache the files below the given ids that are out of the cache (those listed on the share: deleted files and files moved to an offline archive are not looked at): one task per active archive pool read from (NAS first, then cloud, then tape; only current copies, on a tape in the library, not in Glacier), each with the files of that pool as sources, by id. The tasks are created together or not at all, are Manual, Copy, container destination without destination and conflict resolution overwrite, whatever was sent. With \`run\` they are started at once; with \`task\_schedule\` they run once at its time. A task that ends done is deleted afterwards. Answered 422 \`nothing\_to\_fetch\` (with \`left\_out\`) when no file is to be fetched, 422 \`invalid\` for ids that are not files or folders of this container (those not in it as the error's \`value\`), 403 when \`task\_callbacks\` or \`task\_metadata\` are sent by a user who may not add them to a task, 503 \`too\_large\` when the selection takes too long to plan.

```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":{"container_fetch_body":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/container_fetch_request"}}},"required":true}},"schemas":{"container_fetch_request":{"type":"object","required":["ids","tasks"],"properties":{"ids":{"type":"array","description":"The files and folders of the container to fetch (the container's own id for all of it), at most 200.","maxItems":200,"items":{"type":"integer","format":"int64"}},"run":{"type":"boolean","description":"Start the tasks at once (\"Now\")."},"tasks":{"type":"object","description":"The task and its options as the task form builds them, per kind of pool that may be read from. Only name, comment and priority are taken from the task.","properties":{"secondary_tape":{"$ref":"#/components/schemas/container_fetch_task_form"},"secondary_nas":{"$ref":"#/components/schemas/container_fetch_task_form"},"secondary_cloud":{"$ref":"#/components/schemas/container_fetch_task_form"}}},"task_metadata":{"type":"array","items":{"$ref":"#/components/schemas/task_metadatum"}},"task_callbacks":{"type":"array","items":{"$ref":"#/components/schemas/task_callback"}},"task_schedule":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/task_schedule"}]}}},"container_fetch_task_form":{"type":"object","properties":{"task":{"$ref":"#/components/schemas/task"},"task_options":{"type":"array","items":{"$ref":"#/components/schemas/task_option"}}}},"task":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"format":"int64"},"name":{"type":"string"},"comment":{"type":"string"},"workflow_type":{"type":"string","enum":["active_archive","offline_archive","data_exchange","data_migration","maintenance","data_enrichment"]},"workflow_action":{"type":"string","enum":["copy","move","erase","scan","rehydratation","format","check_consistency","duplication","cache_cleaning","ejection","get_index","full_backup","incremental_backup","restore","speedtest"]},"source_type":{"type":"string","enum":["container","primary_nas","secondary_nas","primary_cloud","secondary_cloud","secondary_tape"]},"destination_type":{"type":"string","enum":["container","primary_nas","secondary_nas","primary_cloud","secondary_cloud","secondary_tape"]},"priority":{"type":"integer"},"conflict_resolution":{"type":"string","enum":["rename","overwrite","ignore"]},"action":{"type":"string","readOnly":true,"enum":["noop","run","pause","stop","resume"]},"activate":{"type":"integer"},"creation_date":{"type":"string","readOnly":true,"format":"date-time"},"modification_date":{"type":"string","readOnly":true,"format":"date-time"},"creation_username":{"type":"string","readOnly":true},"modification_username":{"type":"string","readOnly":true},"status":{"type":"string","readOnly":true,"enum":["not_activated","done","in_progress","error","paused","stopped_by_system","in_queue","finished_with_warnings","calculating","stopped_by_user"]},"progress":{"type":"integer"},"job_started":{"type":"string","readOnly":true,"format":"date-time"},"job_finished":{"type":"string","readOnly":true,"format":"date-time"},"processed_size":{"type":"integer","readOnly":true,"format":"int64"},"to_process_size":{"type":"integer","readOnly":true,"format":"int64"},"delete":{"type":"integer"},"local_server_path":{"type":"string"}}},"task_option":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"format":"int64"},"type":{"type":"string","enum":["file_checksum","reset_file_date","reset_folder_date","rename_to","execution_task_id","selected_drive","parallel_processing","task_id","full_report","processing_order","rehydration_usage_threshold","rehydration_deleted_files_threshold","learning_type","learning_threshold","tape_to_scratch","eject_tape_after","barcodes","overwrite","soft_erase","limit_nb_files_per_job","limit_nb_parallel_job","limit_nb_parallel_db_file","limit_max_size_per_job","ignore_common_path","remove_selected_folders","vault_to_s3_glacier","restoration_expiry_days","retrieval_option","speedtest_size","speedtest_iterations","set_tape_readonly","set_task_notification","tape_duplication_action","selected_drive_2","backup_report","task_template","norenaming","after_copy_verification","preserve_acl","restore_acl","create_reminder_txt","force_local_ownership","backup_replication","conflict_resolution"]},"value":{"type":"string"}}},"task_metadatum":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"format":"int64"},"key":{"type":"string"},"value":{"type":"string"}}},"task_callback":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"format":"int64"},"type":{"type":"string","enum":["filter"]},"script":{"type":"string"}}},"task_schedule":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"format":"int64"},"task_id":{"type":"integer","format":"int64"},"rrule":{"type":"string"},"done":{"type":"boolean"},"next":{"type":"string","readOnly":true},"missed_count":{"type":"integer","readOnly":true},"skipped_count":{"type":"integer","readOnly":true},"missed_last":{"type":"string","readOnly":true},"missed_first":{"type":"string","readOnly":true}}},"container_fetch":{"type":"object","properties":{"tasks":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/container_fetch_task"}},"left_out":{"$ref":"#/components/schemas/container_fetch_left_out"},"not_started":{"type":"array","readOnly":true,"description":"The tasks created but that could not be started (`run` only).","items":{"type":"integer","format":"int64"}}}},"container_fetch_task":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"format":"int64"},"name":{"type":"string","readOnly":true},"pool":{"$ref":"#/components/schemas/container_file_copy_pool"},"files":{"type":"integer","readOnly":true,"format":"int64"},"bytes":{"type":"integer","readOnly":true,"format":"int64"}}},"container_file_copy_pool":{"type":"object","description":"Also used by the primary and secondary pool entry details and the tape details.","properties":{"id":{"type":"integer","readOnly":true,"format":"int64"},"name":{"type":"string","readOnly":true},"type":{"type":"string","readOnly":true,"nullable":true,"enum":["active_archive","offline_archive","data_exchange","scratch","data_enrichment","primary"]},"content":{"type":"string","readOnly":true,"nullable":true,"enum":["tape","cloud","nas"]}}},"container_fetch_left_out":{"type":"object","description":"The files of the selection not fetched, by why.","properties":{"in_cache":{"$ref":"#/components/schemas/container_fetch_count"},"no_active_copy":{"$ref":"#/components/schemas/container_fetch_count"},"tape_out_of_library":{"$ref":"#/components/schemas/container_fetch_count"},"in_glacier":{"$ref":"#/components/schemas/container_fetch_count"}}},"container_fetch_count":{"type":"object","properties":{"files":{"type":"integer","readOnly":true,"format":"int64"},"bytes":{"type":"integer","readOnly":true,"format":"int64"}}},"generic_error":{"type":"object","properties":{"error":{"type":"string"}}},"error":{"type":"object","properties":{"details":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/attribute_error"}},"description":"Parsable objects describing the errors. The key is the invalid attribute name."},"messages":{"type":"array","description":"English description of the errors.","items":{"type":"string"}}}},"attribute_error":{"required":["error"],"type":"object","properties":{"error":{"type":"string"}},"discriminator":{"propertyName":"error"}}},"responses":{"container_fetch_created":{"description":"The tasks created, and the files left out.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/container_fetch"}}}},"unauthorized":{"description":"User is unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generic_error"}}}},"not_found":{"description":"The requested resource was not found. The detailed error will be of type `not_found`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"unprocessable_entity":{"description":"The received resource was not correctly formatted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"internal_error":{"description":"The server could not read the catalog. The error details are `$system` / `internal_error`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"container_fetch_too_large":{"description":"The selection takes too long to plan. The error details are `ids` / `too_large`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}}},"paths":{"/containers/{container_id}/fetch":{"post":{"summary":"Fetches files and folders of a container back into the cache.","description":"**API Key Scope**: container_fetches / create\n\nCreates the Active Archive Copy tasks that bring back into the cache the files below the given ids that are out of the cache (those listed on the share: deleted files and files moved to an offline archive are not looked at): one task per active archive pool read from (NAS first, then cloud, then tape; only current copies, on a tape in the library, not in Glacier), each with the files of that pool as sources, by id. The tasks are created together or not at all, are Manual, Copy, container destination without destination and conflict resolution overwrite, whatever was sent. With `run` they are started at once; with `task_schedule` they run once at its time. A task that ends done is deleted afterwards. Answered 422 `nothing_to_fetch` (with `left_out`) when no file is to be fetched, 422 `invalid` for ids that are not files or folders of this container (those not in it as the error's `value`), 403 when `task_callbacks` or `task_metadata` are sent by a user who may not add them to a task, 503 `too_large` when the selection takes too long to plan.","operationId":"create_container_fetch","tags":["containers"],"requestBody":{"$ref":"#/components/requestBodies/container_fetch_body"},"responses":{"201":{"$ref":"#/components/responses/container_fetch_created"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_error"},"503":{"$ref":"#/components/responses/container_fetch_too_large"}}}}}}
```

## Lists all privilege on the container.

> \*\*API Key Scope\*\*: container\_privileges / index

```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":{"container_privileges_index":{"description":"List of container privileges.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/container_privilege_collection"}}}}},"schemas":{"container_privilege_collection":{"type":"object","properties":{"count":{"type":"integer","readOnly":true},"container_privileges":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/container_privilege"}}}},"container_privilege":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"format":"int64"},"name":{"type":"string"},"privilege":{"type":"string","enum":["none","read","read_write"]},"type":{"type":"string","enum":["user","group"]}}}},"parameters":{"limit":{"name":"limit","in":"query","description":"The number of items to display for pagination.","schema":{"type":"integer"}},"offset":{"name":"offset","in":"query","description":"The number of items to skip for pagination.","schema":{"type":"integer"}},"sort_by":{"name":"sort_by","in":"query","description":"Sort results by attribute.\n\nCan sort on multiple attributes, separated by `|`.\nOrder direction can be suffixing the attribute by either `:asc` (default) or `:desc`.","style":"pipeDelimited","schema":{"type":"array","items":{"type":"string"}}},"filter_id":{"name":"id","in":"query","description":"Filter on id","schema":{"type":"string"}},"filter_name":{"name":"name","in":"query","description":"Filter on name","schema":{"type":"string"}},"filter_privilege":{"name":"privilege","in":"query","description":"Filter on privilege","schema":{"type":"string"}},"filter_type":{"name":"type","in":"query","description":"Filter on type","schema":{"type":"string"}}}},"paths":{"/containers/{container_id}/container_privileges":{"get":{"summary":"Lists all privilege on the container.","tags":["containers"],"operationId":"index_container_privileges","description":"**API Key Scope**: container_privileges / index","responses":{"200":{"$ref":"#/components/responses/container_privileges_index"}},"parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/sort_by"},{"$ref":"#/components/parameters/filter_id"},{"$ref":"#/components/parameters/filter_name"},{"$ref":"#/components/parameters/filter_privilege"},{"$ref":"#/components/parameters/filter_type"}]}}}}
```

## Creates a new privilege on the container.

> \*\*API Key Scope\*\*: container\_privileges / create

```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":{"container_privileges_show":{"description":"A specific container privilege.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/container_privilege"}}}},"unprocessable_entity":{"description":"The received resource was not correctly formatted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"schemas":{"container_privilege":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"format":"int64"},"name":{"type":"string"},"privilege":{"type":"string","enum":["none","read","read_write"]},"type":{"type":"string","enum":["user","group"]}}},"error":{"type":"object","properties":{"details":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/attribute_error"}},"description":"Parsable objects describing the errors. The key is the invalid attribute name."},"messages":{"type":"array","description":"English description of the errors.","items":{"type":"string"}}}},"attribute_error":{"required":["error"],"type":"object","properties":{"error":{"type":"string"}},"discriminator":{"propertyName":"error"}}},"requestBodies":{"container_privilege_body":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/container_privilege"}}},"required":true}}},"paths":{"/containers/{container_id}/container_privileges":{"post":{"summary":"Creates a new privilege on the container.","operationId":"create_container_privilege","description":"**API Key Scope**: container_privileges / create","tags":["containers"],"responses":{"201":{"$ref":"#/components/responses/container_privileges_show"},"422":{"$ref":"#/components/responses/unprocessable_entity"}},"requestBody":{"$ref":"#/components/requestBodies/container_privilege_body"}}}}}
```

## Displays a specific privilege.

> \*\*API Key Scope\*\*: container\_privileges / show

```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":{"container_privileges_show":{"description":"A specific container privilege.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/container_privilege"}}}}},"schemas":{"container_privilege":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"format":"int64"},"name":{"type":"string"},"privilege":{"type":"string","enum":["none","read","read_write"]},"type":{"type":"string","enum":["user","group"]}}}}},"paths":{"/containers/{container_id}/container_privileges/{container_privilege_id}":{"get":{"summary":"Displays a specific privilege.","operationId":"show_container_privilege","description":"**API Key Scope**: container_privileges / show","tags":["containers"],"responses":{"200":{"$ref":"#/components/responses/container_privileges_show"}}}}}}
```

## Updates a specific privilege.

> \*\*API Key Scope\*\*: container\_privileges / update

```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":{"container_privileges_show":{"description":"A specific container privilege.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/container_privilege"}}}},"unprocessable_entity":{"description":"The received resource was not correctly formatted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"schemas":{"container_privilege":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"format":"int64"},"name":{"type":"string"},"privilege":{"type":"string","enum":["none","read","read_write"]},"type":{"type":"string","enum":["user","group"]}}},"error":{"type":"object","properties":{"details":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/attribute_error"}},"description":"Parsable objects describing the errors. The key is the invalid attribute name."},"messages":{"type":"array","description":"English description of the errors.","items":{"type":"string"}}}},"attribute_error":{"required":["error"],"type":"object","properties":{"error":{"type":"string"}},"discriminator":{"propertyName":"error"}}},"requestBodies":{"container_privilege_body":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/container_privilege"}}},"required":true}}},"paths":{"/containers/{container_id}/container_privileges/{container_privilege_id}":{"put":{"summary":"Updates a specific privilege.","operationId":"update_container_privilege","description":"**API Key Scope**: container_privileges / update","tags":["containers"],"responses":{"200":{"$ref":"#/components/responses/container_privileges_show"},"422":{"$ref":"#/components/responses/unprocessable_entity"}},"requestBody":{"$ref":"#/components/requestBodies/container_privilege_body"}}}}}
```

## Destroys a specific privilege.

> \*\*API Key Scope\*\*: container\_privileges / destroy

```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"}}},"paths":{"/containers/{container_id}/container_privileges/{container_privilege_id}":{"delete":{"summary":"Destroys a specific privilege.","operationId":"destroy_container_privilege","description":"**API Key Scope**: container_privileges / destroy","tags":["containers"],"responses":{"204":{"description":"Container privilege destroyed."}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

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

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

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

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
