> 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/pools.md).

# Pools

## Lists the primary pools for the catalog explorer.

> \*\*API Key Scope\*\*: primary\_pools / index\
> \
> Every primary pool, by name, with the share or bucket it is stored on and whether it is mounted on this node. No credentials. 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":{"primary_pools_index":{"description":"The primary pools.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/primary_pool_collection"}}}},"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":{"primary_pool_collection":{"type":"object","properties":{"pools":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/primary_pool"}}}},"primary_pool":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"format":"int64"},"name":{"type":"string","readOnly":true},"content":{"type":"string","readOnly":true,"enum":["nas","cloud"]},"storage":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/primary_pool_storage"}]},"protocol":{"type":"string","readOnly":true,"nullable":true,"description":"The NAS protocol (smb_v1, smb_v2_1, smb_v3, nfs_v3, nfs_v4) or the cloud provider (generic_s3, amazon_aws_s3…) of the pool's storage."},"scan":{"$ref":"#/components/schemas/primary_pool_scan_settings"},"mounted":{"type":"boolean","readOnly":true,"nullable":true,"description":"Whether the pool is mounted on this node; null when it has no storage or the mount table could not be read."}}},"primary_pool_storage":{"type":"object","description":"NAS pools: server, share, path and network path. Cloud pools: connector and bucket.","properties":{"network_path":{"type":"string","readOnly":true,"nullable":true,"description":"The pool's root as reached from another machine, //server/share or server:/export."},"server":{"type":"string","readOnly":true,"nullable":true},"share":{"type":"string","readOnly":true},"path":{"type":"string","readOnly":true,"nullable":true},"connector":{"type":"string","readOnly":true,"nullable":true},"bucket":{"type":"string","readOnly":true}}},"primary_pool_scan_settings":{"type":"object","description":"Whether the inventory scan is on.","properties":{"enabled":{"type":"boolean","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":{"/primary_pools":{"get":{"summary":"Lists the primary pools for the catalog explorer.","description":"**API Key Scope**: primary_pools / index\n\nEvery primary pool, by name, with the share or bucket it is stored on and whether it is mounted on this node. No credentials. Never cached.","operationId":"index_primary_pools","tags":["pools"],"responses":{"200":{"$ref":"#/components/responses/primary_pools_index"},"500":{"$ref":"#/components/responses/internal_error"}}}}}}
```

## Displays what the catalog explorer shows about a primary pool.

> \*\*API Key Scope\*\*: primary\_pools / details\
> \
> Where the pool is stored, whether it is mounted, its inventory scan, how many entries the catalog holds and the tasks that read or write it. Names only, never credentials; the mount account is for administrators only. Not cached by clients; the server reuses the counts for up to 5 minutes (1 after a timeout) and the tasks for 2 minutes.

```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":{"primary_pool_details":{"description":"What the catalog explorer shows about the primary pool.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/primary_pool_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":{"primary_pool_details":{"type":"object","properties":{"id":{"type":"integer","format":"int64","readOnly":true},"name":{"type":"string","readOnly":true},"content":{"type":"string","readOnly":true,"enum":["nas","cloud"]},"storage":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/primary_pool_details_storage"}]},"mount":{"$ref":"#/components/schemas/primary_pool_details_mount"},"scan":{"$ref":"#/components/schemas/primary_pool_details_scan"},"contents":{"$ref":"#/components/schemas/primary_pool_details_contents"},"tasks":{"$ref":"#/components/schemas/container_details_tasks"}}},"primary_pool_details_storage":{"type":"object","description":"Where a primary or secondary pool is stored. NAS pools: server, protocol, share, network path, mount account (administrators only). Cloud pools: provider, connector, bucket, region.","properties":{"server":{"type":"string","readOnly":true,"nullable":true},"protocol":{"type":"string","readOnly":true,"nullable":true},"share":{"type":"string","readOnly":true},"network_path":{"type":"string","readOnly":true,"nullable":true,"description":"The pool's root as reached from another machine, //server/share or server:/export."},"mount_account":{"type":"string","readOnly":true,"nullable":true,"description":"The account the share is mounted with; administrators only, never the password."},"provider":{"type":"string","readOnly":true,"nullable":true},"connector":{"type":"string","readOnly":true,"nullable":true},"bucket":{"type":"string","readOnly":true},"region":{"type":"string","readOnly":true,"nullable":true}}},"primary_pool_details_mount":{"type":"object","description":"Whether the pool is mounted: primary pools, and NAS secondary pools.","properties":{"mounted":{"type":"boolean","readOnly":true,"nullable":true,"description":"Null when the pool has no storage or the mount table could not be read."}}},"primary_pool_details_scan":{"allOf":[{"$ref":"#/components/schemas/pool_scan_settings"},{"type":"object","properties":{"on_share_items":{"type":"integer","readOnly":true,"nullable":true,"description":"Files and folders the last inventory scan saw on the storage; null when the scan is off or the count ran out of time."}}}]},"pool_scan_settings":{"type":"object","description":"How often a primary pool's inventory scan runs.","properties":{"enabled":{"type":"boolean","readOnly":true},"every":{"type":"integer","readOnly":true,"nullable":true},"unit":{"type":"string","readOnly":true,"nullable":true}}},"primary_pool_details_contents":{"type":"object","properties":{"in_catalog":{"type":"integer","readOnly":true,"nullable":true,"description":"The pool's files and folders in the catalog, counted up to 100,000; null when the count ran out of time (partial)."},"more_than":{"type":"boolean","readOnly":true},"partial":{"type":"boolean","readOnly":true}}},"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":{"/primary_pools/{primary_pool_id}/details":{"get":{"summary":"Displays what the catalog explorer shows about a primary pool.","description":"**API Key Scope**: primary_pools / details\n\nWhere the pool is stored, whether it is mounted, its inventory scan, how many entries the catalog holds and the tasks that read or write it. Names only, never credentials; the mount account is for administrators only. Not cached by clients; the server reuses the counts for up to 5 minutes (1 after a timeout) and the tasks for 2 minutes.","operationId":"show_primary_pool_details","tags":["pools"],"responses":{"200":{"$ref":"#/components/responses/primary_pool_details"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_error"}}}}}}
```

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

> \*\*API Key Scope\*\*: primary\_pools / archive\_summary\
> \
> From the catalog index, so the counts are approximate. 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":{"/primary_pools/{primary_pool_id}/archive_summary":{"get":{"summary":"Displays where the files of a primary pool are archived, per pool.","description":"**API Key Scope**: primary_pools / archive_summary\n\nFrom the catalog index, so the counts are approximate. Not cached by clients; the server reuses an answer for up to 60 s (an unavailable index for 15 s).","operationId":"show_primary_pool_archive_summary","tags":["pools"],"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 explorer shows about a catalogued file or folder of a primary pool.

> \*\*API Key Scope\*\*: primary\_pool\_files / details\
> \
> Looked up by numeric id among the pool's catalog entries. Same answer as for a container entry, without a cache state (\`state\` is null) and without folder contents (\`contents\` is null): a primary pool's folders are listed live. 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":{"/primary_pools/{primary_pool_id}/files/{file_id}/details":{"get":{"summary":"Displays what the catalog explorer shows about a catalogued file or folder of a primary pool.","description":"**API Key Scope**: primary_pool_files / details\n\nLooked up by numeric id among the pool's catalog entries. Same answer as for a container entry, without a cache state (`state` is null) and without folder contents (`contents` is null): a primary pool's folders are listed live. Not cached by clients; the server reuses owner and group names for up to 10 minutes (an unknown id for 2).","operationId":"show_primary_pool_file_details","tags":["pools"],"responses":{"200":{"$ref":"#/components/responses/container_files_details"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_error"}}}}}}
```

## Lists the secondary pools for the catalog explorer.

> \*\*API Key Scope\*\*: secondary\_pools / index\
> \
> Every offline-archive pool, by name, with what it is stored on: tapes and their libraries, a NAS share, or a cloud bucket. No credentials. 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":{"secondary_pools_index":{"description":"The secondary (offline-archive) pools.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/secondary_pool_collection"}}}},"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":{"secondary_pool_collection":{"type":"object","properties":{"pools":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/secondary_pool"}},"libraries":{"type":"array","readOnly":true,"description":"The libraries holding the tape pools' tapes, with their drives.","items":{"$ref":"#/components/schemas/secondary_pool_library"}}}},"secondary_pool":{"type":"object","properties":{"id":{"type":"integer","format":"int64","readOnly":true},"name":{"type":"string","readOnly":true},"content":{"type":"string","readOnly":true,"enum":["tape","nas","cloud"]},"comment":{"type":"string","readOnly":true,"nullable":true},"storage":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/secondary_pool_storage"}]},"library":{"type":"string","readOnly":true,"nullable":true,"description":"Tape pools - the library the task wizard names for the pool: its own, else its first tape's. Not sent for other pools."}}},"secondary_pool_storage":{"type":"object","description":"Tape pools: tapes and libraries. NAS pools: server, share and path. Cloud pools: connector and bucket. Null when the pool has none.","properties":{"tapes":{"type":"integer","readOnly":true},"libraries":{"type":"array","readOnly":true,"items":{"type":"string"}},"out":{"type":"integer","readOnly":true,"description":"Tapes out of the library."},"io_station":{"type":"integer","readOnly":true,"description":"Tapes in an import/export slot."},"flagged":{"type":"integer","readOnly":true,"description":"Tapes flagged for check."},"no_capacity_reading":{"type":"integer","readOnly":true},"capacity":{"type":"integer","format":"int64","readOnly":true,"description":"Capacity of the tapes with a capacity reading."},"used":{"type":"integer","format":"int64","readOnly":true},"server":{"type":"string","readOnly":true,"nullable":true},"share":{"type":"string","readOnly":true},"path":{"type":"string","readOnly":true,"nullable":true},"protocol":{"type":"string","readOnly":true,"nullable":true,"description":"NAS pools - the NAS protocol (smb_v3, nfs_v3…)."},"connector":{"type":"string","readOnly":true,"nullable":true},"bucket":{"type":"string","readOnly":true}}},"secondary_pool_library":{"type":"object","properties":{"id":{"type":"integer","format":"int64","readOnly":true},"name":{"type":"string","readOnly":true},"ready":{"type":"boolean","readOnly":true},"drives":{"type":"integer","readOnly":true},"busy":{"type":"integer","readOnly":true,"description":"Drives holding a tape."}}},"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":{"/secondary_pools":{"get":{"summary":"Lists the secondary pools for the catalog explorer.","description":"**API Key Scope**: secondary_pools / index\n\nEvery offline-archive pool, by name, with what it is stored on: tapes and their libraries, a NAS share, or a cloud bucket. No credentials. Never cached.","operationId":"index_secondary_pools","tags":["pools"],"responses":{"200":{"$ref":"#/components/responses/secondary_pools_index"},"500":{"$ref":"#/components/responses/internal_error"}}}}}}
```

## Displays what the catalog explorer shows about a secondary pool.

> \*\*API Key Scope\*\*: secondary\_pools / details\
> \
> What the offline-archive pool is stored on (its tapes, or its share or bucket), how many archived files it holds and from how many origins, and the tasks that read or write it with the next scheduled run. Names only, never credentials; the mount account is for administrators only. Not cached by clients; the server reuses the counts for up to 5 minutes (a count that ran out of time too) and the tasks for 2 minutes.

```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":{"secondary_pool_details":{"description":"What the catalog explorer shows about the secondary pool.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/secondary_pool_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":{"secondary_pool_details":{"type":"object","properties":{"id":{"type":"integer","format":"int64","readOnly":true},"name":{"type":"string","readOnly":true},"content":{"type":"string","readOnly":true,"enum":["tape","nas","cloud"]},"comment":{"type":"string","readOnly":true,"nullable":true},"storage":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/primary_pool_details_storage"}]},"mount":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/primary_pool_details_mount"}]},"tapes":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/secondary_pool_details_tapes"}]},"contents":{"$ref":"#/components/schemas/secondary_pool_details_contents"},"tasks":{"$ref":"#/components/schemas/secondary_pool_details_tasks"},"settings":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/secondary_pool_details_settings"}]}}},"primary_pool_details_storage":{"type":"object","description":"Where a primary or secondary pool is stored. NAS pools: server, protocol, share, network path, mount account (administrators only). Cloud pools: provider, connector, bucket, region.","properties":{"server":{"type":"string","readOnly":true,"nullable":true},"protocol":{"type":"string","readOnly":true,"nullable":true},"share":{"type":"string","readOnly":true},"network_path":{"type":"string","readOnly":true,"nullable":true,"description":"The pool's root as reached from another machine, //server/share or server:/export."},"mount_account":{"type":"string","readOnly":true,"nullable":true,"description":"The account the share is mounted with; administrators only, never the password."},"provider":{"type":"string","readOnly":true,"nullable":true},"connector":{"type":"string","readOnly":true,"nullable":true},"bucket":{"type":"string","readOnly":true},"region":{"type":"string","readOnly":true,"nullable":true}}},"primary_pool_details_mount":{"type":"object","description":"Whether the pool is mounted: primary pools, and NAS secondary pools.","properties":{"mounted":{"type":"boolean","readOnly":true,"nullable":true,"description":"Null when the pool has no storage or the mount table could not be read."}}},"secondary_pool_details_tapes":{"type":"object","properties":{"write_minimum":{"type":"integer","format":"int64","readOnly":true,"description":"Bytes the engine keeps free on every tape (ltfs_vol_space_min); it writes to a tape only while it has more."},"total":{"type":"integer","readOnly":true},"in_library":{"type":"integer","readOnly":true,"description":"In a slot or a drive."},"writable":{"type":"integer","readOnly":true,"description":"Tapes the engine can write to - in the library, not locked, not write-protected, not flagged for check, with at least the write minimum free."},"writable_free":{"type":"integer","format":"int64","readOnly":true,"description":"Free bytes on the writable tapes."},"capacity":{"type":"integer","format":"int64","readOnly":true,"description":"Capacity of the tapes with a capacity reading."},"used":{"type":"integer","format":"int64","readOnly":true},"no_capacity_reading":{"type":"integer","readOnly":true},"out":{"type":"array","readOnly":true,"description":"Out of the library.","items":{"type":"string"}},"io_station":{"type":"array","readOnly":true,"description":"In an import/export slot.","items":{"type":"string"}},"in_drive":{"type":"array","readOnly":true,"description":"Loaded in a drive.","items":{"type":"string"}},"flagged":{"type":"array","readOnly":true,"description":"Flagged for check.","items":{"type":"string"}},"full":{"type":"integer","readOnly":true,"description":"Tapes with less than the write minimum free; tapes without a capacity reading are not counted."},"write_protected":{"type":"object","readOnly":true,"properties":{"total":{"type":"integer"},"software":{"type":"integer"},"cartridge":{"type":"integer"},"both":{"type":"integer"}}},"list":{"type":"array","readOnly":true,"description":"The first 20 tapes, by barcode.","items":{"$ref":"#/components/schemas/secondary_pool_details_tape"}},"more":{"type":"integer","readOnly":true,"description":"Tapes not in the list."},"libraries":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/secondary_pool_details_library"}}}},"secondary_pool_details_tape":{"type":"object","properties":{"barcode":{"type":"string","readOnly":true},"place":{"type":"string","readOnly":true,"enum":["in_library","drive","io_station","out","unknown"]},"location":{"type":"string","readOnly":true},"free":{"type":"integer","format":"int64","readOnly":true,"nullable":true,"description":"Null without a capacity reading."},"write_protect":{"type":"integer","readOnly":true,"description":"Bits - 1 software, 2 cartridge."},"flagged":{"type":"boolean","readOnly":true}}},"secondary_pool_details_library":{"allOf":[{"$ref":"#/components/schemas/secondary_pool_library"},{"type":"object","properties":{"loaded":{"type":"array","readOnly":true,"description":"This pool's tapes in the library's drives.","items":{"type":"string"}}}}]},"secondary_pool_library":{"type":"object","properties":{"id":{"type":"integer","format":"int64","readOnly":true},"name":{"type":"string","readOnly":true},"ready":{"type":"boolean","readOnly":true},"drives":{"type":"integer","readOnly":true},"busy":{"type":"integer","readOnly":true,"description":"Drives holding a tape."}}},"secondary_pool_details_contents":{"type":"object","properties":{"files":{"type":"integer","format":"int64","readOnly":true,"nullable":true,"description":"Archived files (one copy per file on a pool), \".\" rows left out. Null when the count ran out of time."},"origins":{"type":"object","readOnly":true,"nullable":true,"properties":{"containers":{"type":"integer"},"primary_pools":{"type":"integer"}}},"partial":{"type":"boolean","readOnly":true}}},"secondary_pool_details_tasks":{"allOf":[{"$ref":"#/components/schemas/container_details_tasks"},{"type":"object","properties":{"next_run":{"type":"object","readOnly":true,"nullable":true,"description":"Null when none of the tasks is scheduled, or when the scheduler does not answer.","properties":{"id":{"type":"integer"},"name":{"type":"string"},"at":{"type":"string","format":"date-time"}}}}}]},"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}}},"secondary_pool_details_settings":{"type":"object","properties":{"write_protect_when_full":{"type":"boolean","readOnly":true,"nullable":true,"description":"Tape pools; null when not set."},"external_verification":{"type":"boolean","readOnly":true,"description":"NAS pools - whether external verification (Alto API) is set up; its settings are never sent."}}},"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":{"/secondary_pools/{secondary_pool_id}/details":{"get":{"summary":"Displays what the catalog explorer shows about a secondary pool.","description":"**API Key Scope**: secondary_pools / details\n\nWhat the offline-archive pool is stored on (its tapes, or its share or bucket), how many archived files it holds and from how many origins, and the tasks that read or write it with the next scheduled run. Names only, never credentials; the mount account is for administrators only. Not cached by clients; the server reuses the counts for up to 5 minutes (a count that ran out of time too) and the tasks for 2 minutes.","operationId":"show_secondary_pool_details","tags":["pools"],"responses":{"200":{"$ref":"#/components/responses/secondary_pool_details"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_error"}}}}}}
```

## Displays what the catalog explorer shows about an origin, folder or file inside a secondary pool.

> \*\*API Key Scope\*\*: secondary\_pool\_files / details\
> \
> By the catalog id the entry's row in the pool's listing carries. Where it comes from (a container or a primary pool), where the pool holds it (its tapes, share or bucket) and, for a file, its copy on this pool, the original file and its other copies. 404 when the pool holds nothing of it. 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":{"secondary_entry_details":{"description":"What the catalog explorer shows about the origin, folder or file.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/secondary_entry_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":{"secondary_entry_details":{"type":"object","properties":{"id":{"type":"integer","format":"int64","readOnly":true},"name":{"type":"string","readOnly":true},"type":{"type":"string","readOnly":true,"enum":["folder","file"]},"origin":{"$ref":"#/components/schemas/secondary_entry_origin"},"is_origin":{"type":"boolean","readOnly":true,"description":"The entry is the origin itself, the first level of the pool."},"stored_on":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/secondary_entry_stored_on"}]},"file":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/secondary_entry_file"}]}}},"secondary_entry_origin":{"type":"object","properties":{"kind":{"type":"string","readOnly":true,"enum":["container","primary"]},"id":{"type":"integer","format":"int64","readOnly":true,"description":"Catalog id of the origin's root folder."},"name":{"type":"string","readOnly":true},"technology":{"type":"string","readOnly":true,"nullable":true,"description":"A primary pool's content (nas, cloud); null for a container."},"scan":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/pool_scan_settings"}]},"also_named":{"type":"boolean","readOnly":true,"description":"A container and a primary pool share this name."}}},"pool_scan_settings":{"type":"object","description":"How often a primary pool's inventory scan runs.","properties":{"enabled":{"type":"boolean","readOnly":true},"every":{"type":"integer","readOnly":true,"nullable":true},"unit":{"type":"string","readOnly":true,"nullable":true}}},"secondary_entry_stored_on":{"type":"object","description":"Tape pools: the tapes whose trees hold the folder. NAS pools: the share, its server and the folder's path on it. Cloud pools: the bucket.","properties":{"tapes":{"type":"array","readOnly":true,"description":"The first three barcodes.","items":{"type":"string"}},"more_count":{"type":"integer","readOnly":true},"share":{"type":"string","readOnly":true},"server":{"type":"string","readOnly":true,"nullable":true},"network_path":{"type":"string","readOnly":true,"nullable":true},"bucket":{"type":"string","readOnly":true}}},"secondary_entry_file":{"type":"object","properties":{"this_copy":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/container_file_copy"}]},"size":{"type":"integer","format":"int64","readOnly":true,"nullable":true},"state":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/container_file_state"}]},"attributes":{"$ref":"#/components/schemas/container_file_attributes"},"metadata":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/container_file_metadata"}]},"other_copies":{"$ref":"#/components/schemas/container_file_copies"}}},"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_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_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}}},"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":{"/secondary_pools/{secondary_pool_id}/files/{file_id}/details":{"get":{"summary":"Displays what the catalog explorer shows about an origin, folder or file inside a secondary pool.","description":"**API Key Scope**: secondary_pool_files / details\n\nBy the catalog id the entry's row in the pool's listing carries. Where it comes from (a container or a primary pool), where the pool holds it (its tapes, share or bucket) and, for a file, its copy on this pool, the original file and its other copies. 404 when the pool holds nothing of it. Not cached by clients; the server reuses owner and group names for up to 10 minutes (an unknown id for 2).","operationId":"show_secondary_pool_file_details","tags":["pools"],"parameters":[{"name":"file_id","in":"path","description":"Catalog id of the origin, folder or file.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"$ref":"#/components/responses/secondary_entry_details"},"404":{"$ref":"#/components/responses/not_found"},"500":{"$ref":"#/components/responses/internal_error"}}}}}}
```

## Displays what the catalog explorer shows about the folder listed in a secondary pool, by its path.

> \*\*API Key Scope\*\*: secondary\_pool\_files / folder\_details\
> \
> The same answer as the details of an entry, for the folder at this path (an origin, then folders), found as the pool's listing finds it. 404 when the pool holds nothing of it; 422 with details path / invalid for a path that is not one. 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":{"secondary_entry_details":{"description":"What the catalog explorer shows about the origin, folder or file.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/secondary_entry_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"}}}},"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":{"secondary_entry_details":{"type":"object","properties":{"id":{"type":"integer","format":"int64","readOnly":true},"name":{"type":"string","readOnly":true},"type":{"type":"string","readOnly":true,"enum":["folder","file"]},"origin":{"$ref":"#/components/schemas/secondary_entry_origin"},"is_origin":{"type":"boolean","readOnly":true,"description":"The entry is the origin itself, the first level of the pool."},"stored_on":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/secondary_entry_stored_on"}]},"file":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/secondary_entry_file"}]}}},"secondary_entry_origin":{"type":"object","properties":{"kind":{"type":"string","readOnly":true,"enum":["container","primary"]},"id":{"type":"integer","format":"int64","readOnly":true,"description":"Catalog id of the origin's root folder."},"name":{"type":"string","readOnly":true},"technology":{"type":"string","readOnly":true,"nullable":true,"description":"A primary pool's content (nas, cloud); null for a container."},"scan":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/pool_scan_settings"}]},"also_named":{"type":"boolean","readOnly":true,"description":"A container and a primary pool share this name."}}},"pool_scan_settings":{"type":"object","description":"How often a primary pool's inventory scan runs.","properties":{"enabled":{"type":"boolean","readOnly":true},"every":{"type":"integer","readOnly":true,"nullable":true},"unit":{"type":"string","readOnly":true,"nullable":true}}},"secondary_entry_stored_on":{"type":"object","description":"Tape pools: the tapes whose trees hold the folder. NAS pools: the share, its server and the folder's path on it. Cloud pools: the bucket.","properties":{"tapes":{"type":"array","readOnly":true,"description":"The first three barcodes.","items":{"type":"string"}},"more_count":{"type":"integer","readOnly":true},"share":{"type":"string","readOnly":true},"server":{"type":"string","readOnly":true,"nullable":true},"network_path":{"type":"string","readOnly":true,"nullable":true},"bucket":{"type":"string","readOnly":true}}},"secondary_entry_file":{"type":"object","properties":{"this_copy":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/container_file_copy"}]},"size":{"type":"integer","format":"int64","readOnly":true,"nullable":true},"state":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/container_file_state"}]},"attributes":{"$ref":"#/components/schemas/container_file_attributes"},"metadata":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/container_file_metadata"}]},"other_copies":{"$ref":"#/components/schemas/container_file_copies"}}},"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_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_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}}},"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":{"/secondary_pools/{secondary_pool_id}/files/folder_details":{"get":{"summary":"Displays what the catalog explorer shows about the folder listed in a secondary pool, by its path.","description":"**API Key Scope**: secondary_pool_files / folder_details\n\nThe same answer as the details of an entry, for the folder at this path (an origin, then folders), found as the pool's listing finds it. 404 when the pool holds nothing of it; 422 with details path / invalid for a path that is not one. Never cached.","operationId":"show_secondary_pool_folder_details","tags":["pools"],"parameters":[{"name":"path","in":"query","description":"\"/container:<name>/a/b\" or \"/primary:<name>/a/b\".","required":true,"schema":{"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/secondary_entry_details"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_error"}}}}}}
```

## Lists all pools.

> \*\*API Key Scope\*\*: pools / 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":{"pools_index":{"description":"List of pools.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pool_collection"}}}}},"schemas":{"pool_collection":{"type":"object","properties":{"count":{"type":"integer","readOnly":true},"pools":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/pool"}}}},"pool":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string"},"comment":{"type":"string"},"type":{"type":"string","enum":["active_archive","offline_archive","data_exchange","scratch","data_enrichment","primary"]},"content":{"type":"string","enum":["tape","cloud","nas"]},"primary_id":{"type":"integer","readOnly":true,"format":"int64"},"storage_id":{"type":"integer","description":"For pool of tapes, used to link to a tape library id","format":"int64"},"tape_write_protect_when_full":{"type":"boolean","description":"For pool of tapes, set the tape in write-protect when it became full"},"storage_extra_data":{"$ref":"#/components/schemas/storage_extra_data","description":"Additional storage metadata"}}},"storage_extra_data":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"format":"int64"},"storage_id":{"type":"integer","format":"int64"},"storage_type":{"type":"integer","enum":[1,2,3,4,5,6,7,8,9]},"data":{"type":"string"}}}},"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_type":{"name":"type","in":"query","description":"Filter on type","schema":{"type":"string"}},"filter_content":{"name":"content","in":"query","description":"Filter on content","schema":{"type":"string"}},"filter_primary_id":{"name":"primary_id","in":"query","description":"Filter on primary id","schema":{"type":"string"}}}},"paths":{"/pools":{"get":{"summary":"Lists all pools.","tags":["pools"],"operationId":"index_pools","description":"**API Key Scope**: pools / index","responses":{"200":{"$ref":"#/components/responses/pools_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_type"},{"$ref":"#/components/parameters/filter_content"},{"$ref":"#/components/parameters/filter_primary_id"}]}}}}
```

## Creates a new pool.

> \*\*API Key Scope\*\*: pools / 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":{"pools_show":{"description":"A specific pool.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pool"}}}},"unprocessable_entity":{"description":"The received resource was not correctly formatted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"schemas":{"pool":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string"},"comment":{"type":"string"},"type":{"type":"string","enum":["active_archive","offline_archive","data_exchange","scratch","data_enrichment","primary"]},"content":{"type":"string","enum":["tape","cloud","nas"]},"primary_id":{"type":"integer","readOnly":true,"format":"int64"},"storage_id":{"type":"integer","description":"For pool of tapes, used to link to a tape library id","format":"int64"},"tape_write_protect_when_full":{"type":"boolean","description":"For pool of tapes, set the tape in write-protect when it became full"},"storage_extra_data":{"$ref":"#/components/schemas/storage_extra_data","description":"Additional storage metadata"}}},"storage_extra_data":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"format":"int64"},"storage_id":{"type":"integer","format":"int64"},"storage_type":{"type":"integer","enum":[1,2,3,4,5,6,7,8,9]},"data":{"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"}},"pool_up":{"allOf":[{"$ref":"#/components/schemas/pool"},{"type":"object","properties":{"tape_ids":{"type":"array","items":{"type":"integer"}},"nas_share_ids":{"type":"array","items":{"type":"integer"}},"cloud_bucket_ids":{"type":"array","items":{"type":"integer"}}}}]}},"requestBodies":{"pool_body":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pool_up"}}},"required":true}}},"paths":{"/pools":{"post":{"summary":"Creates a new pool.","operationId":"create_pool","description":"**API Key Scope**: pools / create","tags":["pools"],"responses":{"201":{"$ref":"#/components/responses/pools_show"},"422":{"$ref":"#/components/responses/unprocessable_entity"}},"requestBody":{"$ref":"#/components/requestBodies/pool_body"}}}}}
```

## Displays a specific pool.

> \*\*API Key Scope\*\*: pools / 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":{"pools_show":{"description":"A specific pool.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pool"}}}}},"schemas":{"pool":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string"},"comment":{"type":"string"},"type":{"type":"string","enum":["active_archive","offline_archive","data_exchange","scratch","data_enrichment","primary"]},"content":{"type":"string","enum":["tape","cloud","nas"]},"primary_id":{"type":"integer","readOnly":true,"format":"int64"},"storage_id":{"type":"integer","description":"For pool of tapes, used to link to a tape library id","format":"int64"},"tape_write_protect_when_full":{"type":"boolean","description":"For pool of tapes, set the tape in write-protect when it became full"},"storage_extra_data":{"$ref":"#/components/schemas/storage_extra_data","description":"Additional storage metadata"}}},"storage_extra_data":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"format":"int64"},"storage_id":{"type":"integer","format":"int64"},"storage_type":{"type":"integer","enum":[1,2,3,4,5,6,7,8,9]},"data":{"type":"string"}}}}},"paths":{"/pools/{pool_id}":{"get":{"summary":"Displays a specific pool.","operationId":"show_pool","description":"**API Key Scope**: pools / show","tags":["pools"],"responses":{"200":{"$ref":"#/components/responses/pools_show"}}}}}}
```

## Updates a specific pool.

> \*\*API Key Scope\*\*: pools / 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":{"pools_show":{"description":"A specific pool.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pool"}}}},"unprocessable_entity":{"description":"The received resource was not correctly formatted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"schemas":{"pool":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string"},"comment":{"type":"string"},"type":{"type":"string","enum":["active_archive","offline_archive","data_exchange","scratch","data_enrichment","primary"]},"content":{"type":"string","enum":["tape","cloud","nas"]},"primary_id":{"type":"integer","readOnly":true,"format":"int64"},"storage_id":{"type":"integer","description":"For pool of tapes, used to link to a tape library id","format":"int64"},"tape_write_protect_when_full":{"type":"boolean","description":"For pool of tapes, set the tape in write-protect when it became full"},"storage_extra_data":{"$ref":"#/components/schemas/storage_extra_data","description":"Additional storage metadata"}}},"storage_extra_data":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"format":"int64"},"storage_id":{"type":"integer","format":"int64"},"storage_type":{"type":"integer","enum":[1,2,3,4,5,6,7,8,9]},"data":{"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"}},"pool_up":{"allOf":[{"$ref":"#/components/schemas/pool"},{"type":"object","properties":{"tape_ids":{"type":"array","items":{"type":"integer"}},"nas_share_ids":{"type":"array","items":{"type":"integer"}},"cloud_bucket_ids":{"type":"array","items":{"type":"integer"}}}}]}},"requestBodies":{"pool_body":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pool_up"}}},"required":true}}},"paths":{"/pools/{pool_id}":{"put":{"summary":"Updates a specific pool.","operationId":"update_pool","description":"**API Key Scope**: pools / update","tags":["pools"],"responses":{"200":{"$ref":"#/components/responses/pools_show"},"422":{"$ref":"#/components/responses/unprocessable_entity"}},"requestBody":{"$ref":"#/components/requestBodies/pool_body"}}}}}
```

## Destroys a specific tape pool.

> \*\*API Key Scope\*\*: pools / 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":{"/pools/{pool_id}":{"delete":{"summary":"Destroys a specific tape pool.","operationId":"destroy_pool","description":"**API Key Scope**: pools / destroy","tags":["pools"],"responses":{"204":{"description":"Pool destroyed."}}}}}}
```

## Displays the primary pool scan status.

> \*\*API Key Scope\*\*: primary\_scans / 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":{"primary_scan_show":{"description":"The primary pool scan status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/primary_scan"}}}}},"schemas":{"primary_scan":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"format":"int64"},"pool_id":{"type":"integer"},"enabled":{"type":"boolean"},"operand":{"type":"number"},"unit":{"type":"string","enum":["minutes","hours","days","weeks","months","years"]}}}}},"paths":{"/pools/{pool_id}/primary_scan":{"get":{"summary":"Displays the primary pool scan status.","operationId":"show_primary_scan","description":"**API Key Scope**: primary_scans / show","tags":["pools"],"responses":{"200":{"$ref":"#/components/responses/primary_scan_show"}}}}}}
```

## Set a new primary pool scan option.

> \*\*API Key Scope\*\*: primary\_scans / 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":{"primary_scan_show":{"description":"The primary pool scan status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/primary_scan"}}}},"unprocessable_entity":{"description":"The received resource was not correctly formatted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"schemas":{"primary_scan":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"format":"int64"},"pool_id":{"type":"integer"},"enabled":{"type":"boolean"},"operand":{"type":"number"},"unit":{"type":"string","enum":["minutes","hours","days","weeks","months","years"]}}},"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":{"primary_scan_body":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/primary_scan"}}},"required":true}}},"paths":{"/pools/{pool_id}/primary_scan":{"post":{"summary":"Set a new primary pool scan option.","operationId":"create_primary_scan","description":"**API Key Scope**: primary_scans / create","tags":["pools"],"responses":{"201":{"$ref":"#/components/responses/primary_scan_show"},"422":{"$ref":"#/components/responses/unprocessable_entity"}},"requestBody":{"$ref":"#/components/requestBodies/primary_scan_body"}}}}}
```

## Updates the existing primary pool scan option.

> \*\*API Key Scope\*\*: primary\_scans / 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":{"primary_scan_show":{"description":"The primary pool scan status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/primary_scan"}}}},"unprocessable_entity":{"description":"The received resource was not correctly formatted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"schemas":{"primary_scan":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"format":"int64"},"pool_id":{"type":"integer"},"enabled":{"type":"boolean"},"operand":{"type":"number"},"unit":{"type":"string","enum":["minutes","hours","days","weeks","months","years"]}}},"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":{"primary_scan_body":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/primary_scan"}}},"required":true}}},"paths":{"/pools/{pool_id}/primary_scan":{"put":{"summary":"Updates the existing primary pool scan option.","operationId":"update_primary_scan","description":"**API Key Scope**: primary_scans / update","tags":["pools"],"responses":{"200":{"$ref":"#/components/responses/primary_scan_show"},"422":{"$ref":"#/components/responses/unprocessable_entity"}},"requestBody":{"$ref":"#/components/requestBodies/primary_scan_body"}}}}}
```

## Disable the primary pool scan.

> \*\*API Key Scope\*\*: primary\_scans / 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":{"/pools/{pool_id}/primary_scan":{"delete":{"summary":"Disable the primary pool scan.","operationId":"destroy_primary_scan","description":"**API Key Scope**: primary_scans / destroy","tags":["pools"],"responses":{"204":{"description":"Primary pool scan disabled."}}}}}}
```

## Synchronize a primary after a scan (for internal use only).

> \*\*API Key Scope\*\*: pools / sync\_primary

```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"}},"parameters":{"sync_primary_tx":{"name":"tx","in":"query","description":"New transaction number.","required":true,"schema":{"type":"integer"}}}},"paths":{"/pools/{pool_id}/sync":{"post":{"summary":"Synchronize a primary after a scan (for internal use only).","operationId":"sync_primary_pool","description":"**API Key Scope**: pools / sync_primary","tags":["pools"],"responses":{"204":{"description":"Synchronization triggered."}},"parameters":[{"$ref":"#/components/parameters/sync_primary_tx"}]}}}}
```

## Get mount status of Pool.

> \*\*API Key Scope\*\*: pools / mount\_status

```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":{"mount_status":{"description":"Mount status of storage.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/mount_status"}}}},"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"}}}}},"schemas":{"mount_status":{"type":"object","properties":{"mounted":{"type":"boolean","readOnly":true},"message":{"type":"string","readOnly":true},"status":{"$ref":"#/components/schemas/mount_info"}}},"mount_info":{"type":"object","properties":{"id":{"type":"integer"},"major_minor":{"type":"string"},"target":{"type":"string"},"source":{"type":"string"},"options":{"type":"string"},"type":{"type":"string","enum":["cifs","nfs","nfs4","fuse.s3fs","fuse.rclone","fuse.core_fuse","fuse"]},"pool_id":{"type":"integer"},"pool_name":{"type":"string"},"nas_id":{"type":"integer"},"nas_name":{"type":"string"},"nas_share_id":{"type":"integer"},"nas_share_name":{"type":"string"},"cloud_connector_id":{"type":"integer"},"cloud_connector_name":{"type":"string"},"cloud_bucket_id":{"type":"integer"},"cloud_bucket_name":{"type":"string"},"tape_id":{"type":"integer"},"tape_barcode":{"type":"string"},"tape_library_id":{"type":"integer"},"tape_library_name":{"type":"string"},"tape_library_serial":{"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"}}}},"paths":{"/pools/{pool_id}/mount":{"get":{"summary":"Get mount status of Pool.","operationId":"mount_status_pool","description":"**API Key Scope**: pools / mount_status","tags":["pools"],"responses":{"200":{"$ref":"#/components/responses/mount_status"},"404":{"$ref":"#/components/responses/not_found"}}}}}}
```

## Mount Pool.

> \*\*API Key Scope\*\*: pools / mount

```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":{"mount_status":{"description":"Mount status of storage.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/mount_status"}}}},"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"}}}}},"schemas":{"mount_status":{"type":"object","properties":{"mounted":{"type":"boolean","readOnly":true},"message":{"type":"string","readOnly":true},"status":{"$ref":"#/components/schemas/mount_info"}}},"mount_info":{"type":"object","properties":{"id":{"type":"integer"},"major_minor":{"type":"string"},"target":{"type":"string"},"source":{"type":"string"},"options":{"type":"string"},"type":{"type":"string","enum":["cifs","nfs","nfs4","fuse.s3fs","fuse.rclone","fuse.core_fuse","fuse"]},"pool_id":{"type":"integer"},"pool_name":{"type":"string"},"nas_id":{"type":"integer"},"nas_name":{"type":"string"},"nas_share_id":{"type":"integer"},"nas_share_name":{"type":"string"},"cloud_connector_id":{"type":"integer"},"cloud_connector_name":{"type":"string"},"cloud_bucket_id":{"type":"integer"},"cloud_bucket_name":{"type":"string"},"tape_id":{"type":"integer"},"tape_barcode":{"type":"string"},"tape_library_id":{"type":"integer"},"tape_library_name":{"type":"string"},"tape_library_serial":{"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"}}}},"paths":{"/pools/{pool_id}/mount":{"put":{"summary":"Mount Pool.","operationId":"mount_pool","description":"**API Key Scope**: pools / mount","tags":["pools"],"responses":{"200":{"$ref":"#/components/responses/mount_status"},"404":{"$ref":"#/components/responses/not_found"}}}}}}
```

## Unmount Pool.

> \*\*API Key Scope\*\*: pools / unmount

```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":{"mount_status":{"description":"Mount status of storage.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/mount_status"}}}},"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"}}}}},"schemas":{"mount_status":{"type":"object","properties":{"mounted":{"type":"boolean","readOnly":true},"message":{"type":"string","readOnly":true},"status":{"$ref":"#/components/schemas/mount_info"}}},"mount_info":{"type":"object","properties":{"id":{"type":"integer"},"major_minor":{"type":"string"},"target":{"type":"string"},"source":{"type":"string"},"options":{"type":"string"},"type":{"type":"string","enum":["cifs","nfs","nfs4","fuse.s3fs","fuse.rclone","fuse.core_fuse","fuse"]},"pool_id":{"type":"integer"},"pool_name":{"type":"string"},"nas_id":{"type":"integer"},"nas_name":{"type":"string"},"nas_share_id":{"type":"integer"},"nas_share_name":{"type":"string"},"cloud_connector_id":{"type":"integer"},"cloud_connector_name":{"type":"string"},"cloud_bucket_id":{"type":"integer"},"cloud_bucket_name":{"type":"string"},"tape_id":{"type":"integer"},"tape_barcode":{"type":"string"},"tape_library_id":{"type":"integer"},"tape_library_name":{"type":"string"},"tape_library_serial":{"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"}}}},"paths":{"/pools/{pool_id}/mount":{"delete":{"summary":"Unmount Pool.","operationId":"unmount_pool","description":"**API Key Scope**: pools / unmount","tags":["pools"],"responses":{"200":{"$ref":"#/components/responses/mount_status"},"404":{"$ref":"#/components/responses/not_found"}}}}}}
```


---

# 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/pools.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.
