API 1 - Swagger Petstore

• post/account/reset
• get/account/{id}
• get/saving_policy/{id}
• put/saving_policy/{id}
• del/saving_policy/{id}
• get/saving_policy
• post/saving_policy
• get/hardware/{id}
• put/hardware/{id}
• del/hardware/{id}
• get/resolution
• post/resolution
• put/hardware/register
• del/saving_policy/{id}/hardware/{hardware_id}
• get/notification/{id}
• put/notification/{id}
• del/notification/{id}
• post/notification/{id}/add/{hardware_id}
• post/hardware/all
• post/saving_policy/{id}/add/{hardware_id}
• get/recording/{id}
• put/recording/{id}
• del/recording/{id}
• post/account/code
• get/notification
• post/notification
• get/criteria/{id}
• put/criteria/{id}
• del/criteria/{id}
• get/resolution/{name}
• put/resolution/{name}
• del/resolution/{name}
• post/file/all
• post/account/password
• get/recording
• post/recording
• put/account/livestream/device
• post/account/email/device
• get/path
• post/recording/start
• get/hardware
• post/hardware
• get/criteria
• post/criteria
• post/account/profile
• post/hardware/newname
• post/account/verify/token
• get/notification/{id}/hardware
• post/account/signin
• post/recording/is_recording
• post/recording/stop
• get/
• post/
• put/account/add/device
• post/hardware/delete
• post/file/delete
• del/notification/{id}/hardware/{hardware_id}
• get/account
• post/account
• post/hardware/code
• post/account/get/device
• post/hardware/share
• post/account/delete
• get/saving_policy/{id}/hardware
• post/email
• post/account/signup
• post/account/verify/device

API docs by Redocly

mpc2 (1.01)

Download OpenAPI specification:Download

/account/reset

Request Body schema: application/json

username required

string

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/account/reset

Request samples

• Payload

Content type

application/json

{

• "username": "string"

}

Response samples

• 200

Content type

application/json

{ }

/account/{id}

path Parameters

id required

string

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/account/{id}

Response samples

• 200

Content type

application/json

{

• "account_id": 0,
• "username": "string",
• "password": "string",
• "email": "string",
• "status": "string",
• "token": "string"

}

/saving_policy/{id}

path Parameters

id required

string

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/saving_policy/{id}

Response samples

• 200

Content type

application/json

{

• "saving_policy_id": 0,
• "max_time": 0,
• "resolution_name": "string"

}

/saving_policy/{id}

path Parameters

id required

string

query Parameters

max_time	string
resolution_name	string

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/saving_policy/{id}

Response samples

• 200

Content type

application/json

{ }

/saving_policy/{id}

path Parameters

id required

string

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/saving_policy/{id}

Response samples

• 200

Content type

application/json

{ }

/saving_policy

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/saving_policy

Response samples

• 200

Content type

application/json

[

• {

  • "saving_policy_id": 0,
  • "max_time": 0,
  • "resolution_name": "string"

  }

]

/saving_policy

query Parameters

max_time required	string
resolution_name required	string

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/saving_policy

Response samples

• 200

Content type

application/json

{

• "ID": 0

}

/hardware/{id}

path Parameters

id required

string

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/hardware/{id}

Response samples

• 200

Content type

application/json

{

• "hardware_id": 0,
• "account_id": 0,
• "device_id": "string",
• "max_resolution": "string",
• "channel_name": "string",
• "playback_url": "string",
• "ingest_endpoint": "string",
• "stream_key": "string",
• "device_name": "string",
• "arn": "string",
• "s3_recording_prefix": "string"

}

/hardware/{id}

path Parameters

id required

string

query Parameters

name	string
max_resolution	string

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/hardware/{id}

Response samples

• 200

Content type

application/json

{ }

/hardware/{id}

path Parameters

id required

string

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/hardware/{id}

Response samples

• 200

Content type

application/json

{ }

/resolution

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/resolution

Response samples

• 200

Content type

application/json

[

• {

  • "resolution_name": "string",
  • "width": 0,
  • "height": 0

  }

]

/resolution

query Parameters

height required	string
width required	string
resolution_name required	string

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/resolution

Response samples

• 200

Content type

application/json

{ }

/hardware/register

Authorizations:

api_key

Request Body schema: application/json

device_id required	string
max_resolution required	string
channel_name required	string
playback_url required	string
ingest_endpoint required	string
stream_key required	string
device_name required	string
arn required	string
s3_recording_prefix	string

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/hardware/register

Request samples

• Payload

Content type

application/json

{

• "device_id": "string",
• "max_resolution": "string",
• "channel_name": "string",
• "playback_url": "string",
• "ingest_endpoint": "string",
• "stream_key": "string",
• "device_name": "string",
• "arn": "string",
• "s3_recording_prefix": "string"

}

Response samples

• 200

Content type

application/json

{

• "hardware_id": 0,
• "account_id": 0,
• "device_id": "string",
• "max_resolution": "string",
• "channel_name": "string",
• "playback_url": "string",
• "ingest_endpoint": "string",
• "stream_key": "string",
• "device_name": "string",
• "arn": "string",
• "s3_recording_prefix": "string"

}

/saving_policy/{id}/hardware/{hardware_id}

path Parameters

hardware_id required	string
id required	string

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/saving_policy/{id}/hardware/{hardware_id}

Response samples

• 200

Content type

application/json

{ }

/notification/{id}

path Parameters

id required

string

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/notification/{id}

Response samples

• 200

Content type

application/json

{

• "notification_id": 0,
• "notification_type": 0,
• "criteria_id": 0

}

/notification/{id}

path Parameters

id required

string

query Parameters

notification_type	string
criteria_id	string

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/notification/{id}

Response samples

• 200

Content type

application/json

{ }

/notification/{id}

path Parameters

id required

string

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/notification/{id}

Response samples

• 200

Content type

application/json

{ }

/notification/{id}/add/{hardware_id}

path Parameters

hardware_id required	string
id required	string

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/notification/{id}/add/{hardware_id}

Response samples

• 200

Content type

application/json

{ }

/hardware/all

Request Body schema: application/json

token

string

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/hardware/all

Request samples

• Payload

Content type

application/json

{

• "token": "string"

}

Response samples

• 200

Content type

application/json

{ }

/saving_policy/{id}/add/{hardware_id}

path Parameters

hardware_id required	string
id required	string

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/saving_policy/{id}/add/{hardware_id}

Response samples

• 200

Content type

application/json

{ }

/recording/{id}

path Parameters

id required

string

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/recording/{id}

Response samples

• 200

Content type

application/json

{

• "recording_id": 0,
• "hardware_id": 0,
• "account_id": 0,
• "file_name": "string",
• "timestamp": "2019-08-24T14:15:22Z",
• "date": "2019-08-24"

}

/recording/{id}

path Parameters

id required

string

query Parameters

hardware_id	string
timestamp	string
date	string
file_name	string
account_id	string

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/recording/{id}

Response samples

• 200

Content type

application/json

{ }

/recording/{id}

path Parameters

id required

string

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/recording/{id}

Response samples

• 200

Content type

application/json

{ }

/account/code

Request Body schema: application/json

username required	string
code required	string

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/account/code

Request samples

• Payload

Content type

application/json

{

• "username": "string",
• "code": "string"

}

Response samples

• 200

Content type

application/json

{ }

/notification

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/notification

Response samples

• 200

Content type

application/json

[

• {

  • "notification_id": 0,
  • "notification_type": 0,
  • "criteria_id": 0

  }

]

/notification

query Parameters

hardware_id	string
notification_type required	string
criteria_id required	string

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/notification

Response samples

• 200

Content type

application/json

{

• "ID": 0

}

/criteria/{id}

path Parameters

id required

string

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/criteria/{id}

Response samples

• 200

Content type

application/json

{

• "criteria_id": 0,
• "criteria_type": 0,
• "magnitude": 0,
• "duration": 0

}

/criteria/{id}

path Parameters

id required

string

query Parameters

criteria_type	string
duration	string
magnitude	string

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/criteria/{id}

Response samples

• 200

Content type

application/json

{ }

/criteria/{id}

path Parameters

id required

string

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/criteria/{id}

Response samples

• 200

Content type

application/json

{ }

/resolution/{name}

path Parameters

name required

string

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/resolution/{name}

Response samples

• 200

Content type

application/json

{

• "resolution_name": "string",
• "width": 0,
• "height": 0

}

/resolution/{name}

path Parameters

name required

string

query Parameters

width	string
height	string
resolution_name	string

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/resolution/{name}

Response samples

• 200

Content type

application/json

{ }

/resolution/{name}

path Parameters

name required

string

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/resolution/{name}

Response samples

• 200

Content type

application/json

{ }

/file/all

Request Body schema: application/json

token

string

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/file/all

Request samples

• Payload

Content type

application/json

{

• "token": "string"

}

Response samples

• 200

Content type

application/json

[

• {

  • "recording_id": 0,
  • "hardware_id": 0,
  • "account_id": 0,
  • "file_name": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "date": "2019-08-24"

  }

]

/account/password

Request Body schema: application/json

username required	string
token	string
password required	string
code required	string

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/account/password

Request samples

• Payload

Content type

application/json

{

• "username": "string",
• "token": "string",
• "password": "string",
• "code": "string"

}

Response samples

• 200

Content type

application/json

{ }

/recording

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/recording

Response samples

• 200

Content type

application/json

[

• {

  • "recording_id": 0,
  • "hardware_id": 0,
  • "account_id": 0,
  • "file_name": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "date": "2019-08-24"

  }

]

/recording

query Parameters

hardware_id required	string
year	string
hour	string
minute	string
file_name required	string
second	string
month	string
date	string
timestamp	string
account_id required	string

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/recording

Response samples

• 200

Content type

application/json

{

• "ID": 0

}

/account/livestream/device

Request Body schema: application/json

token required	string
device_id required	string

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/account/livestream/device

Request samples

• Payload

Content type

application/json

{

• "token": "string",
• "device_id": "string"

}

Response samples

• 200

Content type

application/json

{ }

/account/email/device

Request Body schema: application/json

token required	string
device_id required	string

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/account/email/device

Request samples

• Payload

Content type

application/json

{

• "token": "string",
• "device_id": "string"

}

Response samples

• 200

Content type

application/json

{ }

/path

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/path

Response samples

• 200

Content type

application/json

{ }

/recording/start

Request Body schema: application/json

token required	string
device_id required	string

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/recording/start

Request samples

• Payload

Content type

application/json

{

• "token": "string",
• "device_id": "string"

}

Response samples

• 200

Content type

application/json

{ }

/hardware

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/hardware

Response samples

• 200

Content type

application/json

[

• {

  • "hardware_id": 0,
  • "account_id": 0,
  • "device_id": "string",
  • "max_resolution": "string",
  • "channel_name": "string",
  • "playback_url": "string",
  • "ingest_endpoint": "string",
  • "stream_key": "string",
  • "device_name": "string",
  • "arn": "string",
  • "s3_recording_prefix": "string"

  }

]

/hardware

query Parameters

name required	string
max_resolution required	string

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/hardware

Response samples

• 200

Content type

application/json

{

• "ID": 0

}

/criteria

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/criteria

Response samples

• 200

Content type

application/json

[

• {

  • "criteria_id": 0,
  • "criteria_type": 0,
  • "magnitude": 0,
  • "duration": 0

  }

]

/criteria

query Parameters

criteria_type required	string
duration required	string
magnitude required	string

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/criteria

Response samples

• 200

Content type

application/json

{ }

/account/profile

Request Body schema: application/json

token

string

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/account/profile

Request samples

• Payload

Content type

application/json

{

• "token": "string"

}

Response samples

• 200

Content type

application/json

{ }

/hardware/newname

Request Body schema: application/json

token

string

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/hardware/newname

Request samples

• Payload

Content type

application/json

{

• "token": "string"

}

Response samples

• 200

Content type

application/json

{ }

/account/verify/token

Request Body schema: application/json

token

string

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/account/verify/token

Request samples

• Payload

Content type

application/json

{

• "token": "string"

}

Response samples

• 200

Content type

application/json

{ }

/notification/{id}/hardware

path Parameters

id required

string

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/notification/{id}/hardware

Response samples

• 200

Content type

application/json

[

• {

  • "hardware_id": 0,
  • "account_id": 0,
  • "device_id": "string",
  • "max_resolution": "string",
  • "channel_name": "string",
  • "playback_url": "string",
  • "ingest_endpoint": "string",
  • "stream_key": "string",
  • "device_name": "string",
  • "arn": "string",
  • "s3_recording_prefix": "string"

  }

]

/account/signin

Request Body schema: application/json

username required	string
password required	string

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/account/signin

Request samples

• Payload

Content type

application/json

{

• "username": "string",
• "password": "string"

}

Response samples

• 200

Content type

application/json

{ }

/recording/is_recording

Request Body schema: application/json

token required	string
device_id required	string

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/recording/is_recording

Request samples

• Payload

Content type

application/json

{

• "token": "string",
• "device_id": "string"

}

Response samples

• 200

Content type

application/json

{ }

/recording/stop

Request Body schema: application/json

token required	string
device_id required	string

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/recording/stop

Request samples

• Payload

Content type

application/json

{

• "token": "string",
• "device_id": "string"

}

Response samples

• 200

Content type

application/json

{ }

/

Request Body schema: application/json

object (Empty)

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/

Request samples

• Payload

Content type

application/json

{ }

Response samples

• 200

Content type

image/pngapplication/jsonimage/jpegvideo/mp4image/png

No sample

/

Request Body schema: application/json

object (Empty)

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/

Request samples

• Payload

Content type

application/json

{ }

Response samples

• 200

Content type

application/json

{

• "server_information": "string"

}

/account/add/device

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/account/add/device

Response samples

• 200

Content type

application/json

{ }

/hardware/delete

Request Body schema: application/json

token required	string
device_id required	string

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/hardware/delete

Request samples

• Payload

Content type

application/json

{

• "token": "string",
• "device_id": "string"

}

Response samples

• 200

Content type

application/json

{ }

/file/delete

Request Body schema: application/json

token required	string
file_name required	string

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/file/delete

Request samples

• Payload

Content type

application/json

{

• "token": "string",
• "file_name": "string"

}

Response samples

• 200

Content type

application/json

{ }

/notification/{id}/hardware/{hardware_id}

path Parameters

hardware_id required	string
id required	string

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/notification/{id}/hardware/{hardware_id}

Response samples

• 200

Content type

application/json

{ }

/account

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/account

Response samples

• 200

Content type

application/json

[

• {

  • "account_id": 0,
  • "username": "string",
  • "password": "string",
  • "email": "string",
  • "status": "string",
  • "token": "string"

  }

]

/account

query Parameters

password required	string
username required	string
email required	string

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/account

Response samples

• 200

Content type

application/json

{

• "ID": 0

}

/hardware/code

Request Body schema: application/json

token required	string
code required	string

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/hardware/code

Request samples

• Payload

Content type

application/json

{

• "token": "string",
• "code": "string"

}

Response samples

• 200

Content type

application/json

{ }

/account/get/device

Request Body schema: application/json

token required	string
device_id required	string

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/account/get/device

Request samples

• Payload

Content type

application/json

{

• "token": "string",
• "device_id": "string"

}

Response samples

• 200

Content type

application/json

{ }

/hardware/share

Request Body schema: application/json

token required	string
device_id required	string

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/hardware/share

Request samples

• Payload

Content type

application/json

{

• "token": "string",
• "device_id": "string"

}

Response samples

• 200

Content type

application/json

{ }

/account/delete

Request Body schema: application/json

token

string

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/account/delete

Request samples

• Payload

Content type

application/json

{

• "token": "string"

}

Response samples

• 200

Content type

application/json

{ }

/saving_policy/{id}/hardware

path Parameters

id required

string

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/saving_policy/{id}/hardware

Response samples

• 200

Content type

application/json

[

• {

  • "hardware_id": 0,
  • "account_id": 0,
  • "device_id": "string",
  • "max_resolution": "string",
  • "channel_name": "string",
  • "playback_url": "string",
  • "ingest_endpoint": "string",
  • "stream_key": "string",
  • "device_name": "string",
  • "arn": "string",
  • "s3_recording_prefix": "string"

  }

]

/email

Request Body schema: application/json

ToMail required	string
Subject required	string
LetterBody required	string

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/email

Request samples

• Payload

Content type

application/json

{

• "ToMail": "string",
• "Subject": "string",
• "LetterBody": "string"

}

Response samples

• 200

Content type

application/json

{ }

/account/signup

Request Body schema: application/json

username required	string
password required	string
email required	string

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/account/signup

Request samples

• Payload

Content type

application/json

{

• "username": "string",
• "password": "string",
• "email": "string"

}

Response samples

• 200

Content type

application/json

{ }

/account/verify/device

header Parameters

x-api-key	string
Content-type	string

Request Body schema: application/json

token required	string
device_id required	string

Responses

https://nk0fs4t630.execute-api.us-east-1.amazonaws.com/{basePath}/account/verify/device

Request samples

• Payload

Content type

application/json

{

• "token": "string",
• "device_id": "string"

}

Response samples

• 200

Content type

application/json

{ }