Nas_shares | Nodeum Docs

(By NAS) Lists all NAS shares.

get

API Key Scope: nas_shares / index Optional API Key Explicit Scope: nas_shares / get_password

Authorizations

Path parameters

nas_idstringRequired

Numeric ID or name of NAS.

Query parameters

limitintegerOptional

The number of items to display for pagination.

offsetintegerOptional

The number of items to skip for pagination.

sort_bystring[]Optional

Sort results by attribute.

Can sort on multiple attributes, separated by |. Order direction can be suffixing the attribute by either :asc (default) or :desc.

idstringOptional

Filter on id

namestringOptional

Filter on name

pathstringOptional

Filter on path

optionsstringOptional

Filter on options

usernamestringOptional

Filter on username

pool_idstringOptional

Filter on a pool id

Responses

200

List of NAS shares.

application/json

get

/nas/{nas_id}/nas_shares

GET /api/v2/nas/{nas_id}/nas_shares HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

200

List of NAS shares.

{
  "count": 1,
  "nas_shares": [
    {
      "id": 10,
      "nas_id": 2,
      "pool_id": 6,
      "name": "archives_general",
      "path": "archives/general",
      "options": "rsize=1048576,wsize=1048576",
      "username": "admin",
      "password": "[censored]",
      "file_count": 1,
      "file_size_sum": 1
    }
  ]
}

(By NAS) Creates a new NAS share.

post

API Key Scope: nas_shares / create

Authorizations

Path parameters

nas_idstringRequired

Numeric ID or name of NAS.

Body

idinteger · int64Read-onlyOptionalExample: 10

nas_idinteger · int64Read-onlyOptionalExample: 2

pool_idintegerRead-onlyOptionalExample: 6

namestringOptionalExample: archives_general

pathstringOptionalExample: archives/general

optionsstringOptionalExample: rsize=1048576,wsize=1048576

usernamestringOptionalExample: admin

passwordstringOptionalExample: [censored]

file_countinteger · int64Read-onlyOptional

file_size_suminteger · int64Read-onlyOptional

Responses

201

A specific NAS share.

application/json

422

The received resource was not correctly formatted.

application/json

post

/nas/{nas_id}/nas_shares

POST /api/v2/nas/{nas_id}/nas_shares HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 136

{
  "name": "archives_general",
  "path": "archives/general",
  "options": "rsize=1048576,wsize=1048576",
  "username": "admin",
  "password": "[censored]"
}

{
  "id": 10,
  "nas_id": 2,
  "pool_id": 6,
  "name": "archives_general",
  "path": "archives/general",
  "options": "rsize=1048576,wsize=1048576",
  "username": "admin",
  "password": "[censored]",
  "file_count": 1,
  "file_size_sum": 1
}

Check result of a NAS Share test job.

get

API Key Scope: nas_shares / test

Authorizations

Path parameters

nas_idstringRequired

Numeric ID or name of NAS.

Query parameters

job_idstringRequired

ID of active job

Responses

200

An active job that may be queued, working, completed or failed.

application/json

202

An active job that may be queued, working, completed or failed.

application/json

get

/nas/{nas_id}/nas_shares/-/test

GET /api/v2/nas/{nas_id}/nas_shares/-/test?job_id=text HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

{
  "job_id": "6f4d759d-48e9-43c8-ab24-640f5ea63922",
  "status": "queued"
}

Test an unsaved NAS Share.

put

API Key Scope: nas_shares / test

Authorizations

Path parameters

nas_idstringRequired

Numeric ID or name of NAS.

Body

idinteger · int64Read-onlyOptionalExample: 10

nas_idinteger · int64Read-onlyOptionalExample: 2

pool_idintegerRead-onlyOptionalExample: 6

namestringOptionalExample: archives_general

pathstringOptionalExample: archives/general

optionsstringOptionalExample: rsize=1048576,wsize=1048576

usernamestringOptionalExample: admin

passwordstringOptionalExample: [censored]

file_countinteger · int64Read-onlyOptional

file_size_suminteger · int64Read-onlyOptional

Responses

202

An active job that may be queued, working, completed or failed.

application/json

put

/nas/{nas_id}/nas_shares/-/test

PUT /api/v2/nas/{nas_id}/nas_shares/-/test HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 136

{
  "name": "archives_general",
  "path": "archives/general",
  "options": "rsize=1048576,wsize=1048576",
  "username": "admin",
  "password": "[censored]"
}

202

An active job that may be queued, working, completed or failed.

{
  "job_id": "6f4d759d-48e9-43c8-ab24-640f5ea63922",
  "status": "queued"
}

(By NAS) Displays a specific NAS share.

get

API Key Scope: nas_shares / show Optional API Key Explicit Scope: nas_shares / get_password

Authorizations

Path parameters

nas_idstringRequired

Numeric ID or name of NAS.

nas_share_idstringRequired

Numeric ID or name of NAS share.

Responses

200

A specific NAS share.

application/json

404

The requested resource was not found. The detailed error will be of type not_found.

application/json

get

/nas/{nas_id}/nas_shares/{nas_share_id}

GET /api/v2/nas/{nas_id}/nas_shares/{nas_share_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

{
  "id": 10,
  "nas_id": 2,
  "pool_id": 6,
  "name": "archives_general",
  "path": "archives/general",
  "options": "rsize=1048576,wsize=1048576",
  "username": "admin",
  "password": "[censored]",
  "file_count": 1,
  "file_size_sum": 1
}

(By NAS) Updates a specific NAS share.

put

API Key Scope: nas_shares / update

Authorizations

Path parameters

nas_idstringRequired

Numeric ID or name of NAS.

nas_share_idstringRequired

Numeric ID or name of NAS share.

Body

idinteger · int64Read-onlyOptionalExample: 10

nas_idinteger · int64Read-onlyOptionalExample: 2

pool_idintegerRead-onlyOptionalExample: 6

namestringOptionalExample: archives_general

pathstringOptionalExample: archives/general

optionsstringOptionalExample: rsize=1048576,wsize=1048576

usernamestringOptionalExample: admin

passwordstringOptionalExample: [censored]

file_countinteger · int64Read-onlyOptional

file_size_suminteger · int64Read-onlyOptional

Responses

200

A specific NAS share.

application/json

422

The received resource was not correctly formatted.

application/json

put

/nas/{nas_id}/nas_shares/{nas_share_id}

PUT /api/v2/nas/{nas_id}/nas_shares/{nas_share_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 136

{
  "name": "archives_general",
  "path": "archives/general",
  "options": "rsize=1048576,wsize=1048576",
  "username": "admin",
  "password": "[censored]"
}

{
  "id": 10,
  "nas_id": 2,
  "pool_id": 6,
  "name": "archives_general",
  "path": "archives/general",
  "options": "rsize=1048576,wsize=1048576",
  "username": "admin",
  "password": "[censored]",
  "file_count": 1,
  "file_size_sum": 1
}

(By NAS) Destroys a specific NAS share.

delete

API Key Scope: nas_shares / destroy

Authorizations

Path parameters

nas_idstringRequired

Numeric ID or name of NAS.

nas_share_idstringRequired

Numeric ID or name of NAS share.

Responses

204

NAS share destroyed.

No content

delete

/nas/{nas_id}/nas_shares/{nas_share_id}

DELETE /api/v2/nas/{nas_id}/nas_shares/{nas_share_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

204

NAS share destroyed.

No content

Lists all NAS shares.

get

API Key Scope: nas_shares / index Optional API Key Explicit Scope: nas_shares / get_password

Authorizations

Query parameters

limitintegerOptional

The number of items to display for pagination.

offsetintegerOptional

The number of items to skip for pagination.

sort_bystring[]Optional

Sort results by attribute.

Can sort on multiple attributes, separated by |. Order direction can be suffixing the attribute by either :asc (default) or :desc.

idstringOptional

Filter on id

namestringOptional

Filter on name

pathstringOptional

Filter on path

optionsstringOptional

Filter on options

usernamestringOptional

Filter on username

nas_idstringOptional

Filter on NAS id

pool_idstringOptional

Filter on a pool id

Responses

200

List of NAS shares.

application/json

get

/nas_shares

GET /api/v2/nas_shares HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

200

List of NAS shares.

{
  "count": 1,
  "nas_shares": [
    {
      "id": 10,
      "nas_id": 2,
      "pool_id": 6,
      "name": "archives_general",
      "path": "archives/general",
      "options": "rsize=1048576,wsize=1048576",
      "username": "admin",
      "password": "[censored]",
      "file_count": 1,
      "file_size_sum": 1
    }
  ]
}

Displays a specific NAS share.

get

API Key Scope: nas_shares / show Optional API Key Explicit Scope: nas_shares / get_password

Authorizations

Path parameters

nas_share_idstringRequired

Numeric ID or name of NAS share.

Responses

200

A specific NAS share.

application/json

404

The requested resource was not found. The detailed error will be of type not_found.

application/json

get

/nas_shares/{nas_share_id}

GET /api/v2/nas_shares/{nas_share_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

{
  "id": 10,
  "nas_id": 2,
  "pool_id": 6,
  "name": "archives_general",
  "path": "archives/general",
  "options": "rsize=1048576,wsize=1048576",
  "username": "admin",
  "password": "[censored]",
  "file_count": 1,
  "file_size_sum": 1
}

Updates a specific NAS share.

put

API Key Scope: nas_shares / update

Authorizations

Path parameters

nas_share_idstringRequired

Numeric ID or name of NAS share.

Body

idinteger · int64Read-onlyOptionalExample: 10

nas_idinteger · int64Read-onlyOptionalExample: 2

pool_idintegerRead-onlyOptionalExample: 6

namestringOptionalExample: archives_general

pathstringOptionalExample: archives/general

optionsstringOptionalExample: rsize=1048576,wsize=1048576

usernamestringOptionalExample: admin

passwordstringOptionalExample: [censored]

file_countinteger · int64Read-onlyOptional

file_size_suminteger · int64Read-onlyOptional

Responses

200

A specific NAS share.

application/json

422

The received resource was not correctly formatted.

application/json

put

/nas_shares/{nas_share_id}

PUT /api/v2/nas_shares/{nas_share_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 136

{
  "name": "archives_general",
  "path": "archives/general",
  "options": "rsize=1048576,wsize=1048576",
  "username": "admin",
  "password": "[censored]"
}

{
  "id": 10,
  "nas_id": 2,
  "pool_id": 6,
  "name": "archives_general",
  "path": "archives/general",
  "options": "rsize=1048576,wsize=1048576",
  "username": "admin",
  "password": "[censored]",
  "file_count": 1,
  "file_size_sum": 1
}

Destroys a specific NAS share.

delete

API Key Scope: nas_shares / destroy

Authorizations

Path parameters

nas_share_idstringRequired

Numeric ID or name of NAS share.

Responses

204

NAS share destroyed.

No content

delete

/nas_shares/{nas_share_id}

DELETE /api/v2/nas_shares/{nas_share_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

204

NAS share destroyed.

No content

(By pool) Lists all NAS shares from pool.

get

API Key Scope: nas_shares / index Optional API Key Explicit Scope: nas_shares / get_password

Authorizations

Path parameters

pool_idstringRequired

Numeric ID, or name of pool.

Query parameters

limitintegerOptional

The number of items to display for pagination.

offsetintegerOptional

The number of items to skip for pagination.

sort_bystring[]Optional

Sort results by attribute.

Can sort on multiple attributes, separated by |. Order direction can be suffixing the attribute by either :asc (default) or :desc.

idstringOptional

Filter on id

namestringOptional

Filter on name

pathstringOptional

Filter on path

optionsstringOptional

Filter on options

usernamestringOptional

Filter on username

nas_idstringOptional

Filter on NAS id

Responses

200

List of NAS shares.

application/json

get

/pools/{pool_id}/nas_shares

GET /api/v2/pools/{pool_id}/nas_shares HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

200

List of NAS shares.

{
  "count": 1,
  "nas_shares": [
    {
      "id": 10,
      "nas_id": 2,
      "pool_id": 6,
      "name": "archives_general",
      "path": "archives/general",
      "options": "rsize=1048576,wsize=1048576",
      "username": "admin",
      "password": "[censored]",
      "file_count": 1,
      "file_size_sum": 1
    }
  ]
}

(By pool) Displays a specific NAS share.

get

API Key Scope: nas_shares / show Optional API Key Explicit Scope: nas_shares / get_password

Authorizations

Path parameters

pool_idstringRequired

Numeric ID, or name of pool.

nas_share_idstringRequired

Numeric ID or name of NAS share.

Responses

200

A specific NAS share.

application/json

404

The requested resource was not found. The detailed error will be of type not_found.

application/json

get

/pools/{pool_id}/nas_shares/{nas_share_id}

GET /api/v2/pools/{pool_id}/nas_shares/{nas_share_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

{
  "id": 10,
  "nas_id": 2,
  "pool_id": 6,
  "name": "archives_general",
  "path": "archives/general",
  "options": "rsize=1048576,wsize=1048576",
  "username": "admin",
  "password": "[censored]",
  "file_count": 1,
  "file_size_sum": 1
}

(By pool) Updates a specific NAS share.

put

API Key Scope: nas_shares / update

Authorizations

Path parameters

pool_idstringRequired

Numeric ID, or name of pool.

nas_share_idstringRequired

Numeric ID or name of NAS share.

Body

idinteger · int64Read-onlyOptionalExample: 10

nas_idinteger · int64Read-onlyOptionalExample: 2

pool_idintegerRead-onlyOptionalExample: 6

namestringOptionalExample: archives_general

pathstringOptionalExample: archives/general

optionsstringOptionalExample: rsize=1048576,wsize=1048576

usernamestringOptionalExample: admin

passwordstringOptionalExample: [censored]

file_countinteger · int64Read-onlyOptional

file_size_suminteger · int64Read-onlyOptional

Responses

200

A specific NAS share.

application/json

422

The received resource was not correctly formatted.

application/json

put

/pools/{pool_id}/nas_shares/{nas_share_id}

PUT /api/v2/pools/{pool_id}/nas_shares/{nas_share_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 136

{
  "name": "archives_general",
  "path": "archives/general",
  "options": "rsize=1048576,wsize=1048576",
  "username": "admin",
  "password": "[censored]"
}

{
  "id": 10,
  "nas_id": 2,
  "pool_id": 6,
  "name": "archives_general",
  "path": "archives/general",
  "options": "rsize=1048576,wsize=1048576",
  "username": "admin",
  "password": "[censored]",
  "file_count": 1,
  "file_size_sum": 1
}

(By pool) Destroys a specific NAS share.

delete

API Key Scope: nas_shares / destroy

Authorizations

Path parameters

pool_idstringRequired

Numeric ID, or name of pool.

nas_share_idstringRequired

Numeric ID or name of NAS share.

Responses

204

NAS share destroyed.

No content

delete

/pools/{pool_id}/nas_shares/{nas_share_id}

DELETE /api/v2/pools/{pool_id}/nas_shares/{nas_share_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

204

NAS share destroyed.

No content