API docs by Redocly

FastAPI (0.1.0)

Download OpenAPI specification:

Get Address

Responses

Response samples

Content type
application/json
[
  • "string"
]

List Export

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Export

Request Body schema: application/json
required
acl
required
Array of strings (Acl)
readonly
boolean (Readonly)
Default: false
volname
required
string (Volname)

Responses

Request samples

Content type
application/json
{
  • "acl": [
    ],
  • "readonly": false,
  • "volname": "string"
}

Response samples

Content type
application/json
{
  • "acl": [
    ],
  • "addresses": [
    ],
  • "lun": 0,
  • "passwd": "string",
  • "protocol": "string",
  • "targetname": "string",
  • "tid": 0,
  • "user": "string"
}

Delete Export

path Parameters
name
required
any (Name)
query Parameters
force
boolean (Force)
Default: false

Responses

Response samples

Content type
application/json
null

Read Export

path Parameters
name
required
any (Name)

Responses

Response samples

Content type
application/json
{
  • "acl": [
    ],
  • "connected": [
    ],
  • "protocol": "string",
  • "targetname": "string",
  • "tid": 0,
  • "users": [
    ],
  • "volumes": [
    ]
}

Health

Responses

Response samples

Content type
application/json
null

Stats Export

Responses

Response samples

Content type
application/json
{
  • "clients": 0,
  • "targets": 0,
  • "volumes": 0
}

Stats Volume

Responses

Response samples

Content type
application/json
{
  • "free": 0,
  • "total": 0,
  • "used": 0,
  • "volumes": 0
}

List Volume

Responses

Response samples

Content type
application/json
null

Create Volume

Request Body schema: application/json
required
name
required
string (Name)
size
required
integer (Size)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "size": 0
}

Response samples

Content type
application/json
null

Delete Volume

path Parameters
name
required
any (Name)

Responses

Response samples

Content type
application/json
{ }

Read Volume

path Parameters
name
required
any (Name)

Responses

Response samples

Content type
application/json
null

Update Volume

path Parameters
name
required
any (Name)
Request Body schema: application/json
required
Readonly (boolean) or Readonly (null) (Readonly)
Size (integer) or Size (null) (Size)

Responses

Request samples

Content type
application/json
{
  • "readonly": true,
  • "size": 0
}

Response samples

Content type
application/json
{
  • "created": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "size": 0,
  • "used": 0
}