# File Systems Controller Resource

The API allows you to view, list and create file systems.

### GET /file-systems

Returns list of file systems filtered by specified query parameters.

Request Parameters
name | type | description
--- | --- | ---
backup | query |
project-uuid | query |

Response Body
media type | data type | description
--- | --- | ---
application/json | array of FileSystemListRecord (JSON) | list of file systems filtered by specified query parameters

#### Example

##### Request

    GET /file-systems
    Content-Type: */*
    Accept: application/json

    ...

##### Response

    HTTP/1.1 200 OK
    Content-Type: application/json

    [ {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67"
    } ]

### GET /file-systems/detailed

Returns detailed list of file systems filtered by specified query parameters.

Request Parameters
name | type | description
--- | --- | ---
backup | query |
project-uuid | query |

Response Body
media type | data type | description
--- | --- | ---
application/json | array of FileSystemDetails (JSON) | detailed list of file systems filtered by specified query parameters

#### Example

##### Request

    GET /file-systems/detailed
    Content-Type: */*
    Accept: application/json

    ...

##### Response

    HTTP/1.1 200 OK
    Content-Type: application/json

    [ {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67"
    } ]

### GET /file-systems/{guid}

Get a single file system.

Request Parameters
name | type | description
--- | --- | ---
guid | path | specify local unique identifier for file system (use by vProtect)

Response Body
media type | data type | description
--- | --- | ---
application/json | FileSystemDetails (JSON) | details of newly created file system

#### Example

##### Request

    GET /file-systems/{guid}
    Content-Type: */*
    Accept: application/json

    ...

##### Response

    HTTP/1.1 200 OK
    Content-Type: application/json

    {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67"
    }