# Nas\_shares

## (By NAS) Lists all NAS shares.

> \*\*API Key Scope\*\*: nas\_shares / index  \
> Optional API Key Explicit Scope: nas\_shares / get\_password

```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":{"nas_shares_index":{"description":"List of NAS shares.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/nas_share_collection"}}}}},"schemas":{"nas_share_collection":{"type":"object","properties":{"count":{"type":"integer","readOnly":true},"nas_shares":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/nas_share"}}}},"nas_share":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"format":"int64"},"nas_id":{"type":"integer","readOnly":true,"format":"int64"},"pool_id":{"type":"integer","readOnly":true},"name":{"type":"string"},"path":{"type":"string"},"options":{"type":"string"},"username":{"type":"string"},"password":{"type":"string"},"file_count":{"type":"integer","readOnly":true,"format":"int64"},"file_size_sum":{"type":"integer","readOnly":true,"format":"int64"}}}},"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_path":{"name":"path","in":"query","description":"Filter on path","schema":{"type":"string"}},"filter_options":{"name":"options","in":"query","description":"Filter on options","schema":{"type":"string"}},"filter_username":{"name":"username","in":"query","description":"Filter on username","schema":{"type":"string"}},"filter_pool_id":{"name":"pool_id","in":"query","description":"Filter on a pool id","schema":{"type":"string"}}}},"paths":{"/nas/{nas_id}/nas_shares":{"get":{"summary":"(By NAS) Lists all NAS shares.","operationId":"index_nas_shares_by_nas","tags":["nas_shares"],"description":"**API Key Scope**: nas_shares / index  \nOptional API Key Explicit Scope: nas_shares / get_password","responses":{"200":{"$ref":"#/components/responses/nas_shares_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_path"},{"$ref":"#/components/parameters/filter_options"},{"$ref":"#/components/parameters/filter_username"},{"$ref":"#/components/parameters/filter_pool_id"}]}}}}
```

## (By NAS) Creates a new NAS share.

> \*\*API Key Scope\*\*: nas\_shares / 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":{"nas_shares_show":{"description":"A specific NAS share.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/nas_share"}}}},"unprocessable_entity":{"description":"The received resource was not correctly formatted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/model_error"}}}}},"schemas":{"nas_share":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"format":"int64"},"nas_id":{"type":"integer","readOnly":true,"format":"int64"},"pool_id":{"type":"integer","readOnly":true},"name":{"type":"string"},"path":{"type":"string"},"options":{"type":"string"},"username":{"type":"string"},"password":{"type":"string"},"file_count":{"type":"integer","readOnly":true,"format":"int64"},"file_size_sum":{"type":"integer","readOnly":true,"format":"int64"}}},"model_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":{"nas_share_body":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/nas_share"}}},"required":true}}},"paths":{"/nas/{nas_id}/nas_shares":{"post":{"summary":"(By NAS) Creates a new NAS share.","operationId":"create_nas_share_by_nas","description":"**API Key Scope**: nas_shares / create","tags":["nas_shares"],"responses":{"201":{"$ref":"#/components/responses/nas_shares_show"},"422":{"$ref":"#/components/responses/unprocessable_entity"}},"requestBody":{"$ref":"#/components/requestBodies/nas_share_body"}}}}}
```

## Check result of a NAS Share test job.

> \*\*API Key Scope\*\*: nas\_shares / test

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

## Test an unsaved NAS Share.

> \*\*API Key Scope\*\*: nas\_shares / test

```json
{"openapi":"3.0.1","info":{"title":"Nodeum API","version":"2.1.0"},"servers":[{"url":"{url}/api/v2","variables":{"url":{"default":"http://localhost","description":"URL of server"}}}],"security":[{"BasicAuth":[]},{"BearerAuth":[]},{"JWT":[]}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic","description":"Pass the username and password of a user in the authorization header.\nThis currently gives full access."},"BearerAuth":{"type":"apiKey","description":"Create an API Key associated to user.\nAccess can be restricted with the scope.\nEach API call described below has a scoped mentionned in its description.\n\nFor example :\n\n**API Key Scope**: files / index\n\nThis means that the API key should have a scope with controller as *files*\nand the action as *index*.","name":"Authorization","in":"header"},"JWT":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"responses":{"active_job_status":{"description":"An active job that may be queued, working, completed or failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/active_job_status"}}}}},"schemas":{"active_job_status":{"type":"object","properties":{"job_id":{"type":"string","readOnly":true},"status":{"type":"string","readOnly":true,"enum":["queued","working","completed","failed"]},"progress":{"type":"integer","readOnly":true},"total":{"type":"integer","readOnly":true}}},"nas_share":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"format":"int64"},"nas_id":{"type":"integer","readOnly":true,"format":"int64"},"pool_id":{"type":"integer","readOnly":true},"name":{"type":"string"},"path":{"type":"string"},"options":{"type":"string"},"username":{"type":"string"},"password":{"type":"string"},"file_count":{"type":"integer","readOnly":true,"format":"int64"},"file_size_sum":{"type":"integer","readOnly":true,"format":"int64"}}}},"requestBodies":{"nas_share_body":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/nas_share"}}},"required":true}}},"paths":{"/nas/{nas_id}/nas_shares/-/test":{"put":{"summary":"Test an unsaved NAS Share.","operationId":"test_nas_share","description":"**API Key Scope**: nas_shares / test","tags":["nas_shares"],"responses":{"202":{"$ref":"#/components/responses/active_job_status"}},"requestBody":{"$ref":"#/components/requestBodies/nas_share_body"}}}}}
```

## (By NAS) Displays a specific NAS share.

> \*\*API Key Scope\*\*: nas\_shares / show  \
> Optional API Key Explicit Scope: nas\_shares / get\_password

```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":{"nas_shares_show":{"description":"A specific NAS share.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/nas_share"}}}},"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/model_error"}}}}},"schemas":{"nas_share":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"format":"int64"},"nas_id":{"type":"integer","readOnly":true,"format":"int64"},"pool_id":{"type":"integer","readOnly":true},"name":{"type":"string"},"path":{"type":"string"},"options":{"type":"string"},"username":{"type":"string"},"password":{"type":"string"},"file_count":{"type":"integer","readOnly":true,"format":"int64"},"file_size_sum":{"type":"integer","readOnly":true,"format":"int64"}}},"model_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":{"/nas/{nas_id}/nas_shares/{nas_share_id}":{"get":{"summary":"(By NAS) Displays a specific NAS share.","operationId":"show_nas_share_by_nas","description":"**API Key Scope**: nas_shares / show  \nOptional API Key Explicit Scope: nas_shares / get_password","tags":["nas_shares"],"responses":{"200":{"$ref":"#/components/responses/nas_shares_show"},"404":{"$ref":"#/components/responses/not_found"}}}}}}
```

## (By NAS) Updates a specific NAS share.

> \*\*API Key Scope\*\*: nas\_shares / 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":{"nas_shares_show":{"description":"A specific NAS share.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/nas_share"}}}},"unprocessable_entity":{"description":"The received resource was not correctly formatted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/model_error"}}}}},"schemas":{"nas_share":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"format":"int64"},"nas_id":{"type":"integer","readOnly":true,"format":"int64"},"pool_id":{"type":"integer","readOnly":true},"name":{"type":"string"},"path":{"type":"string"},"options":{"type":"string"},"username":{"type":"string"},"password":{"type":"string"},"file_count":{"type":"integer","readOnly":true,"format":"int64"},"file_size_sum":{"type":"integer","readOnly":true,"format":"int64"}}},"model_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":{"nas_share_body":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/nas_share"}}},"required":true}}},"paths":{"/nas/{nas_id}/nas_shares/{nas_share_id}":{"put":{"summary":"(By NAS) Updates a specific NAS share.","operationId":"update_nas_share_by_nas","description":"**API Key Scope**: nas_shares / update","tags":["nas_shares"],"responses":{"200":{"$ref":"#/components/responses/nas_shares_show"},"422":{"$ref":"#/components/responses/unprocessable_entity"}},"requestBody":{"$ref":"#/components/requestBodies/nas_share_body"}}}}}
```

## (By NAS) Destroys a specific NAS share.

> \*\*API Key Scope\*\*: nas\_shares / 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":{"/nas/{nas_id}/nas_shares/{nas_share_id}":{"delete":{"summary":"(By NAS) Destroys a specific NAS share.","operationId":"destroy_nas_share_by_nas","description":"**API Key Scope**: nas_shares / destroy","tags":["nas_shares"],"responses":{"204":{"description":"NAS share destroyed."}}}}}}
```

## Lists all NAS shares.

> \*\*API Key Scope\*\*: nas\_shares / index  \
> Optional API Key Explicit Scope: nas\_shares / get\_password

```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":{"nas_shares_index":{"description":"List of NAS shares.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/nas_share_collection"}}}}},"schemas":{"nas_share_collection":{"type":"object","properties":{"count":{"type":"integer","readOnly":true},"nas_shares":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/nas_share"}}}},"nas_share":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"format":"int64"},"nas_id":{"type":"integer","readOnly":true,"format":"int64"},"pool_id":{"type":"integer","readOnly":true},"name":{"type":"string"},"path":{"type":"string"},"options":{"type":"string"},"username":{"type":"string"},"password":{"type":"string"},"file_count":{"type":"integer","readOnly":true,"format":"int64"},"file_size_sum":{"type":"integer","readOnly":true,"format":"int64"}}}},"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_path":{"name":"path","in":"query","description":"Filter on path","schema":{"type":"string"}},"filter_options":{"name":"options","in":"query","description":"Filter on options","schema":{"type":"string"}},"filter_username":{"name":"username","in":"query","description":"Filter on username","schema":{"type":"string"}},"filter_nas_id":{"name":"nas_id","in":"query","description":"Filter on NAS id","schema":{"type":"string"}},"filter_pool_id":{"name":"pool_id","in":"query","description":"Filter on a pool id","schema":{"type":"string"}}}},"paths":{"/nas_shares":{"get":{"summary":"Lists all NAS shares.","tags":["nas_shares"],"operationId":"index_nas_shares","description":"**API Key Scope**: nas_shares / index  \nOptional API Key Explicit Scope: nas_shares / get_password","responses":{"200":{"$ref":"#/components/responses/nas_shares_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_path"},{"$ref":"#/components/parameters/filter_options"},{"$ref":"#/components/parameters/filter_username"},{"$ref":"#/components/parameters/filter_nas_id"},{"$ref":"#/components/parameters/filter_pool_id"}]}}}}
```

## Displays a specific NAS share.

> \*\*API Key Scope\*\*: nas\_shares / show  \
> Optional API Key Explicit Scope: nas\_shares / get\_password

```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":{"nas_shares_show":{"description":"A specific NAS share.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/nas_share"}}}},"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/model_error"}}}}},"schemas":{"nas_share":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"format":"int64"},"nas_id":{"type":"integer","readOnly":true,"format":"int64"},"pool_id":{"type":"integer","readOnly":true},"name":{"type":"string"},"path":{"type":"string"},"options":{"type":"string"},"username":{"type":"string"},"password":{"type":"string"},"file_count":{"type":"integer","readOnly":true,"format":"int64"},"file_size_sum":{"type":"integer","readOnly":true,"format":"int64"}}},"model_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":{"/nas_shares/{nas_share_id}":{"get":{"summary":"Displays a specific NAS share.","operationId":"show_nas_share","description":"**API Key Scope**: nas_shares / show  \nOptional API Key Explicit Scope: nas_shares / get_password","tags":["nas_shares"],"responses":{"200":{"$ref":"#/components/responses/nas_shares_show"},"404":{"$ref":"#/components/responses/not_found"}}}}}}
```

## Updates a specific NAS share.

> \*\*API Key Scope\*\*: nas\_shares / 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":{"nas_shares_show":{"description":"A specific NAS share.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/nas_share"}}}},"unprocessable_entity":{"description":"The received resource was not correctly formatted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/model_error"}}}}},"schemas":{"nas_share":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"format":"int64"},"nas_id":{"type":"integer","readOnly":true,"format":"int64"},"pool_id":{"type":"integer","readOnly":true},"name":{"type":"string"},"path":{"type":"string"},"options":{"type":"string"},"username":{"type":"string"},"password":{"type":"string"},"file_count":{"type":"integer","readOnly":true,"format":"int64"},"file_size_sum":{"type":"integer","readOnly":true,"format":"int64"}}},"model_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":{"nas_share_body":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/nas_share"}}},"required":true}}},"paths":{"/nas_shares/{nas_share_id}":{"put":{"summary":"Updates a specific NAS share.","operationId":"update_nas_share","description":"**API Key Scope**: nas_shares / update","tags":["nas_shares"],"responses":{"200":{"$ref":"#/components/responses/nas_shares_show"},"422":{"$ref":"#/components/responses/unprocessable_entity"}},"requestBody":{"$ref":"#/components/requestBodies/nas_share_body"}}}}}
```

## Destroys a specific NAS share.

> \*\*API Key Scope\*\*: nas\_shares / 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":{"/nas_shares/{nas_share_id}":{"delete":{"summary":"Destroys a specific NAS share.","operationId":"destroy_nas_share","description":"**API Key Scope**: nas_shares / destroy","tags":["nas_shares"],"responses":{"204":{"description":"NAS share destroyed."}}}}}}
```

## (By pool) Lists all NAS shares from pool.

> \*\*API Key Scope\*\*: nas\_shares / index  \
> Optional API Key Explicit Scope: nas\_shares / get\_password

```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":{"nas_shares_index":{"description":"List of NAS shares.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/nas_share_collection"}}}}},"schemas":{"nas_share_collection":{"type":"object","properties":{"count":{"type":"integer","readOnly":true},"nas_shares":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/nas_share"}}}},"nas_share":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"format":"int64"},"nas_id":{"type":"integer","readOnly":true,"format":"int64"},"pool_id":{"type":"integer","readOnly":true},"name":{"type":"string"},"path":{"type":"string"},"options":{"type":"string"},"username":{"type":"string"},"password":{"type":"string"},"file_count":{"type":"integer","readOnly":true,"format":"int64"},"file_size_sum":{"type":"integer","readOnly":true,"format":"int64"}}}},"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_path":{"name":"path","in":"query","description":"Filter on path","schema":{"type":"string"}},"filter_options":{"name":"options","in":"query","description":"Filter on options","schema":{"type":"string"}},"filter_username":{"name":"username","in":"query","description":"Filter on username","schema":{"type":"string"}},"filter_nas_id":{"name":"nas_id","in":"query","description":"Filter on NAS id","schema":{"type":"string"}}}},"paths":{"/pools/{pool_id}/nas_shares":{"get":{"summary":"(By pool) Lists all NAS shares from pool.","operationId":"index_nas_shares_by_pool","description":"**API Key Scope**: nas_shares / index  \nOptional API Key Explicit Scope: nas_shares / get_password","tags":["nas_shares"],"responses":{"200":{"$ref":"#/components/responses/nas_shares_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_path"},{"$ref":"#/components/parameters/filter_options"},{"$ref":"#/components/parameters/filter_username"},{"$ref":"#/components/parameters/filter_nas_id"}]}}}}
```

## (By pool) Displays a specific NAS share.

> \*\*API Key Scope\*\*: nas\_shares / show  \
> Optional API Key Explicit Scope: nas\_shares / get\_password

```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":{"nas_shares_show":{"description":"A specific NAS share.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/nas_share"}}}},"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/model_error"}}}}},"schemas":{"nas_share":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"format":"int64"},"nas_id":{"type":"integer","readOnly":true,"format":"int64"},"pool_id":{"type":"integer","readOnly":true},"name":{"type":"string"},"path":{"type":"string"},"options":{"type":"string"},"username":{"type":"string"},"password":{"type":"string"},"file_count":{"type":"integer","readOnly":true,"format":"int64"},"file_size_sum":{"type":"integer","readOnly":true,"format":"int64"}}},"model_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}/nas_shares/{nas_share_id}":{"get":{"summary":"(By pool) Displays a specific NAS share.","operationId":"show_nas_share_by_pool","description":"**API Key Scope**: nas_shares / show  \nOptional API Key Explicit Scope: nas_shares / get_password","tags":["nas_shares"],"responses":{"200":{"$ref":"#/components/responses/nas_shares_show"},"404":{"$ref":"#/components/responses/not_found"}}}}}}
```

## (By pool) Updates a specific NAS share.

> \*\*API Key Scope\*\*: nas\_shares / 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":{"nas_shares_show":{"description":"A specific NAS share.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/nas_share"}}}},"unprocessable_entity":{"description":"The received resource was not correctly formatted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/model_error"}}}}},"schemas":{"nas_share":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"format":"int64"},"nas_id":{"type":"integer","readOnly":true,"format":"int64"},"pool_id":{"type":"integer","readOnly":true},"name":{"type":"string"},"path":{"type":"string"},"options":{"type":"string"},"username":{"type":"string"},"password":{"type":"string"},"file_count":{"type":"integer","readOnly":true,"format":"int64"},"file_size_sum":{"type":"integer","readOnly":true,"format":"int64"}}},"model_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":{"nas_share_body":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/nas_share"}}},"required":true}}},"paths":{"/pools/{pool_id}/nas_shares/{nas_share_id}":{"put":{"summary":"(By pool) Updates a specific NAS share.","operationId":"update_nas_share_by_pool","description":"**API Key Scope**: nas_shares / update","tags":["nas_shares"],"responses":{"200":{"$ref":"#/components/responses/nas_shares_show"},"422":{"$ref":"#/components/responses/unprocessable_entity"}},"requestBody":{"$ref":"#/components/requestBodies/nas_share_body"}}}}}
```

## (By pool) Destroys a specific NAS share.

> \*\*API Key Scope\*\*: nas\_shares / 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}/nas_shares/{nas_share_id}":{"delete":{"summary":"(By pool) Destroys a specific NAS share.","operationId":"destroy_nas_share_by_pool","description":"**API Key Scope**: nas_shares / destroy","tags":["nas_shares"],"responses":{"204":{"description":"NAS share destroyed."}}}}}}
```