API docs by Redocly

DropZ API (0.1.0)

Download OpenAPI specification:Download

Serve Favicon

Responses

Response samples

Content type
application/json
null

cameras

List Cameras

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Camera

Request Body schema: application/json
required
id
required
string (Id)
name
required
string (Name)
alias
string (Alias)
address
required
string (Address)
paired
boolean (Paired)
Default: false
rssi
integer (Rssi)
Default: 0
synced
boolean (Synced)
Default: false
last_seen
integer (Last Seen)
Default: 0
processing
boolean (Processing)
Default: false

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "alias": "string",
  • "address": "string",
  • "paired": false,
  • "rssi": 0,
  • "synced": false,
  • "last_seen": 0,
  • "processing": false
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "alias": "string",
  • "address": "string",
  • "paired": false,
  • "rssi": 0,
  • "synced": false,
  • "last_seen": 0,
  • "processing": false
}

Update Camera

path Parameters
id
required
integer (Id)
Request Body schema: application/json
required
id
required
string (Id)
name
required
string (Name)
alias
string (Alias)
address
required
string (Address)
paired
boolean (Paired)
Default: false
rssi
integer (Rssi)
Default: 0
synced
boolean (Synced)
Default: false
last_seen
integer (Last Seen)
Default: 0
processing
boolean (Processing)
Default: false

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "alias": "string",
  • "address": "string",
  • "paired": false,
  • "rssi": 0,
  • "synced": false,
  • "last_seen": 0,
  • "processing": false
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "alias": "string",
  • "address": "string",
  • "paired": false,
  • "rssi": 0,
  • "synced": false,
  • "last_seen": 0,
  • "processing": false
}

Delete Camera

path Parameters
id
required
integer (Id)

Responses

Response samples

Content type
application/json
null

Sync Camera

path Parameters
id
required
integer (Id)

Responses

Response samples

Content type
application/json
null

Pair Camera

path Parameters
id
required
integer (Id)

Responses

Response samples

Content type
application/json
null

pair

List Cameras

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Clear Queue

Responses

Response samples

Content type
application/json
null

Get Status

Responses

Response samples

Content type
application/json
true

Set Status

query Parameters
value
required
boolean (Value)

Responses

Response samples

Content type
application/json
"string"

sync

List Cameras

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Clear Queue

Responses

Response samples

Content type
application/json
null

Get Status

Responses

Response samples

Content type
application/json
true

Set Status

query Parameters
value
required
boolean (Value)

Responses

Response samples

Content type
application/json
"string"

groups

List Groups

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Group

Request Body schema: application/json
required
id
required
string (Id)
name
required
string (Name)
Array of objects (Members)
Default: []

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "members": [ ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "members": [ ]
}

Update Group

path Parameters
group_id
required
integer (Group Id)
Request Body schema: application/json
required
id
required
string (Id)
name
required
string (Name)
Array of objects (Members)
Default: []

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "members": [ ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "members": [ ]
}

Delete Group

path Parameters
group_id
required
integer (Group Id)

Responses

Response samples

Content type
application/json
null

settings

List Settings

Responses

Response samples

Content type
application/json
{
  • "pair": false,
  • "sync": true,
  • "days_threshold": 1,
  • "destination_folder": "/home/epheo/Videos/GoPro",
  • "out_time": 600,
  • "debug": false
}

Create Setting

Responses

Response samples

Content type
application/json
null

Get Setting Value

path Parameters
setting_name
required
string (Setting Name)

Responses

Response samples

Content type
application/json
"string"

Update Setting Value

path Parameters
setting_name
required
string (Setting Name)
query Parameters
required
Value (boolean) or Value (integer) or Value (string) (Value)

Responses

Response samples

Content type
application/json
{
  • "pair": false,
  • "sync": true,
  • "days_threshold": 1,
  • "destination_folder": "/home/epheo/Videos/GoPro",
  • "out_time": 600,
  • "debug": false
}

Reset Setting

path Parameters
setting_name
required
string (Setting Name)

Responses

Response samples

Content type
application/json
{
  • "pair": false,
  • "sync": true,
  • "days_threshold": 1,
  • "destination_folder": "/home/epheo/Videos/GoPro",
  • "out_time": 600,
  • "debug": false
}

monitoring

Get Coroutines

Responses

Response samples

Content type
application/json
[
  • { }
]