• Socket Transition Service
• Authentication
• ACL
  • getACL list
  • postUpload Excel/CSV
• Alert
  • postAlert Active
  • putAlert Create
  • delAlert Delete
  • postAlert Disable
  • postAlert Enable
  • postAlert ID
  • postAlert List by Channel ID
  • getNotification Gallery
  • getNotification Gallery Image by ID
  • getNotifications By Range
  • getNotification By UUID
  • patchAlert Update
• Analytics
  • getEvents By Range
  • getChannel Stats
  • getUseCase Stats
  • postUseCase Stats
• User
  • getUser Auth
  • postUser Auth
  • postUser Config By ID
  • postUser Config Update By ID
  • putUser Register
  • delUser Delete
  • postUser Get By ID
  • postUser Info
  • postUser List
  • patchUser Update
• Auto
  • postAuto Test
• Configuration
  • getStatus Storage
  • postIs INIT
  • postReset STS
  • getGet SMS Config
  • postUpdate SMS Config
  • getGet SMTP Config
  • postUpdate SMTP Config
  • getStatus Storage
• Customer
  • putCustomer Create
  • delCustomer Delete
  • getCustomer ID
  • getCustomer List
  • patchCustomer Update
  • getCustomer View
• Organization
  • patchCustomer Site Assign
  • patchCustomer Site Unassign
  • putOrganization Create
  • delOrganization Delete
  • getOrganization ID
  • getOrganization List
  • patchOrganization Update
• Device
  • putDevice Create
  • delDevice Delete
  • getDevice ID
  • getDevice List
  • patchDevice Update
  • getDevice List
• StaticContent
  • putStatic Content Create
  • delStatic Content Delete
  • getStatic Content ID
  • getStatic Content List
  • patchStatic Content Update
• Generic
  • getAsset Upload Image
  • getGet Secure Image
  • postUpload Image
• Setting
  • getNimble Configuration Status
  • postNimble Configuration Update
  • getList Nimble Configuration
  • getNimble Stats
• Pipeline
  • postPipeline Create
  • getDefault Pipeline Element Information
  • delPipeline Delete
  • getPipeline ID
  • getPipeline Element Information
  • getPipeline List
  • patchPipeline Update
• Role
  • postRole List
• Schedule
  • putSchedule Create
  • delSchedule Delete
  • postSchedule ID
  • postSchedule List by Channel ID
  • patchSchedule Update
• Site
  • putSite Create
  • delSite Delete
  • getSite ID
  • getSites List
  • patchSite Update
  • getSite ID
• Source
  • postSource Create
  • delSource Delete
  • getSource ID
  • getSource List
  • getSource Mapping
  • patchSource Update
• Status
  • getStatus Check
• UseCase
  • postUseCase Assign
  • putUseCase Create
  • delUseCase Delete
  • getUseCase ID
  • postUseCase List
  • postUseCase UnAssign
  • patchUseCase Update
• Channel
  • postChannel ChannelAssign
  • putChannel ChannelCreate
  • delChannel ChannelDelete
  • getChannel ID
  • postChannel List
  • getChannel Status
  • postChannel UnAssign
  • patchChannel ChannelUpdate

Documentation Powered by Redocly

STS APIs (1.0)

Download OpenAPI specification:Download

API Support: support@megh.com URL: https://support.megh.com/ License: Apache 2.0 Terms of Service

Socket Transition Service

API documentation.

Authentication

OAuth2Password

Security Scheme Type	OAuth2
password OAuth Flow	Token URL: http://localhost:8000/oauth2/token

ACL

ACL list

Lists all the UI modules for all the roles by default.

Sample OUTPUT

{
  "message": "string",
  "response": [
    {
      "components": [
        {
          "component_key": 0,
          "component_name": "string"
        }
      ],
      "module_key": "string",
      "module_name": "string",
      "module_path": "string"
    }
  ],
  "response_code": 0
}

To get list of UI modules for a specific role, role_key is accepted and query params.

Authorizations:

OAuth2Password

Responses

https://localhost:8000/api/v1/acl/list

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": [

  • {

    • "components": [

      • {

        • "component_key": 0,
        • "component_name": "string"

        }

      ],
    • "module_key": "string",
    • "module_name": "string",
    • "module_path": "string"

    }

  ],
• "response_code": 0

}

Upload Excel/CSV

Takes in a file and stores the file.

Upload a file with form pram modulefile

Sample CSV file content

type,key,name,role,/channel/list,module_key
mod,dashboard,Dashboard,admin|user|viewer,/dashboard,
comp,28,DashboardCard,admin|user|viewer,,dashboard
mod,dashboard-old,Dashboard,admin|user|viewer,/dashboard-old,
comp,29,UseCaseCard,admin|user|viewer,,dashboard-old

Authorizations:

OAuth2Password

query Parameters

modulefile required

string Default: "test.csv" csv module file

Responses

https://localhost:8000/api/v1/acl/upload

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": null,
• "response_code": 0

}

Alert

Alert Active

Alert Active API.

Sample INPUT

{
  "channel_id": "string"
}

Sample OUTPUT

{
  "message": "Active alert",
  "response": [
    {
      "alert_actions": [
        {
          "action_access_id": "string",
          "action_access_token": "string",
          "action_auth_header": "string",
          "action_external_link": "string",
          "action_header": "string",
          "action_is_auto_payload": true,
          "action_is_secure": true,
          "action_message": "string",
          "action_method": "string",
          "action_payload": "string",
          "action_process_delay": 0,
          "action_query": "string",
          "action_subject": "string",
          "action_to": "string",
          "action_type": "string",
          "action_url": "string"
        }
      ],
      "alert_frequency": 0,
      "alert_id": "string",
      "alert_name": "string",
      "alert_priority": "string",
      "alert_threshold": "string",
      "alert_threshold_condition": "string",
      "alert_threshold_key": "string",
      "is_active": true
    }
  ],
  "response_code": 200
}

Authorizations:

OAuth2Password

Request Body schema: application/json

Alert ID Payload

channel_id required

string

Responses

https://localhost:8000/api/v1/alert/active

Request samples

• Payload

Content type

application/json

{

• "channel_id": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": [

  • {

    • "alert_actions": [

      • {

        • "action_access_id": "string",
        • "action_access_token": "string",
        • "action_auth_header": "string",
        • "action_external_link": "string",
        • "action_header": "string",
        • "action_is_auto_payload": true,
        • "action_is_secure": true,
        • "action_message": "string",
        • "action_method": "string",
        • "action_payload": "string",
        • "action_process_delay": 0,
        • "action_query": "string",
        • "action_subject": "string",
        • "action_to": "string",
        • "action_type": "string",
        • "action_url": "string"

        }

      ],
    • "alert_frequency": 0,
    • "alert_id": "string",
    • "alert_name": "string",
    • "alert_priority": "string",
    • "alert_threshold": "string",
    • "alert_threshold_condition": "string",
    • "alert_threshold_key": "string",
    • "is_active": true

    }

  ],
• "response_code": 0

}

Alert Create

Alert Create API.

Sample INPUT

{
  "alert_actions": [
    {
      "action_access_id": "string",
      "action_access_token": "string",
      "action_auth_header": "string",
      "action_external_link": "string",
      "action_header": "string",
      "action_is_auto_payload": true,
      "action_is_secure": true,
      "action_message": "string",
      "action_method": "string",
      "action_payload": "string",
      "action_process_delay": 0,
      "action_query": "string",
      "action_subject": "string",
      "action_to": "string",
      "action_type": "string",
      "action_url": "string",
      "additionalProp1": {}
    }
  ],
  "alert_frequency": 0,
  "alert_name": "string",
  "alert_priority": "string",
  "alert_threshold": "string",
  "alert_threshold_condition": "string",
  "alert_threshold_key": "string",
  "channel_id": "string"
}

Sample OUTPUT

{
  "message": "Alert created",
  "response": null,
  "response_code": 201
}

Authorizations:

OAuth2Password

Request Body schema: application/json

Alert Create Payload

required	Array of objects[ items ]
alert_frequency required	integer [ 0 .. 86400 ]
alert_name required	string
alert_priority required	string
alert_threshold required	string
alert_threshold_condition required	string
alert_threshold_key required	string
channel_id required	string

Responses

https://localhost:8000/api/v1/alert/create

Request samples

• Payload

Content type

application/json

{

• "alert_actions": [

  • {

    • "action_access_id": "string",
    • "action_access_token": "string",
    • "action_auth_header": "string",
    • "action_external_link": "string",
    • "action_header": "string",
    • "action_is_auto_payload": true,
    • "action_is_secure": true,
    • "action_message": "string",
    • "action_method": "string",
    • "action_payload": "string",
    • "action_process_delay": 0,
    • "action_query": "string",
    • "action_subject": "string",
    • "action_to": "string",
    • "action_type": "string",
    • "action_url": "string"

    }

  ],
• "alert_frequency": 86400,
• "alert_name": "string",
• "alert_priority": "string",
• "alert_threshold": "string",
• "alert_threshold_condition": "string",
• "alert_threshold_key": "string",
• "channel_id": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": null,
• "response_code": 0

}

Alert Delete

Alert Delete API

Sample INPUT

{
  "alert_id": "string"
}

Sample OUTPUT

{
  "message": "Alert deleted",
  "response": null,
  "response_code": 200
}

Authorizations:

OAuth2Password

Request Body schema: application/json

Alert Delete Payload

alert_id required

string

Responses

https://localhost:8000/api/v1/alert/delete

Request samples

• Payload

Content type

application/json

{

• "alert_id": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": null,
• "response_code": 0

}

Alert Disable

Alert De-Activate API.

Sample INPUT

{
  "alert_id": "string"
}

Sample OUTPUT

{
  "message": "Alert deactivated",
  "response": null,
  "response_code": 200
}

Authorizations:

OAuth2Password

Request Body schema: application/json

Alert Disable Payload

alert_id required	string
channel_id required	string

Responses

https://localhost:8000/api/v1/alert/disable

Request samples

• Payload

Content type

application/json

{

• "alert_id": "string",
• "channel_id": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": {

  • "alert_actions": [

    • {

      • "action_access_id": "string",
      • "action_access_token": "string",
      • "action_auth_header": "string",
      • "action_external_link": "string",
      • "action_header": "string",
      • "action_is_auto_payload": true,
      • "action_is_secure": true,
      • "action_message": "string",
      • "action_method": "string",
      • "action_payload": "string",
      • "action_process_delay": 0,
      • "action_query": "string",
      • "action_subject": "string",
      • "action_to": "string",
      • "action_type": "string",
      • "action_url": "string"

      }

    ],
  • "alert_frequency": 0,
  • "alert_id": "string",
  • "alert_name": "string",
  • "alert_priority": "string",
  • "alert_threshold": "string",
  • "alert_threshold_condition": "string",
  • "alert_threshold_key": "string",
  • "is_active": true

  },
• "response_code": 0

}

Alert Enable

Alert Activate API.

Sample INPUT

{
  "alert_id": "string"
}

Sample OUTPUT

{
  "message": "Alert activated",
  "response": null,
  "response_code": 200
}

Authorizations:

OAuth2Password

Request Body schema: application/json

Alert Enable Payload

alert_id required	string
channel_id required	string

Responses

https://localhost:8000/api/v1/alert/enable

Request samples

• Payload

Content type

application/json

{

• "alert_id": "string",
• "channel_id": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": {

  • "alert_actions": [

    • {

      • "action_access_id": "string",
      • "action_access_token": "string",
      • "action_auth_header": "string",
      • "action_external_link": "string",
      • "action_header": "string",
      • "action_is_auto_payload": true,
      • "action_is_secure": true,
      • "action_message": "string",
      • "action_method": "string",
      • "action_payload": "string",
      • "action_process_delay": 0,
      • "action_query": "string",
      • "action_subject": "string",
      • "action_to": "string",
      • "action_type": "string",
      • "action_url": "string"

      }

    ],
  • "alert_frequency": 0,
  • "alert_id": "string",
  • "alert_name": "string",
  • "alert_priority": "string",
  • "alert_threshold": "string",
  • "alert_threshold_condition": "string",
  • "alert_threshold_key": "string",
  • "is_active": true

  },
• "response_code": 0

}

Alert ID

Alert ID API.

Sample INPUT

{
  "alert_id": "string"
}

Sample OUTPUT

{
  "message": "Alert by ID",
  "response": {
    "alert_actions": [
      {
        "action_access_id": "string",
        "action_access_token": "string",
        "action_auth_header": "string",
        "action_external_link": "string",
        "action_header": "string",
        "action_is_auto_payload": true,
        "action_is_secure": true,
        "action_message": "string",
        "action_method": "string",
        "action_payload": "string",
        "action_process_delay": 0,
        "action_query": "string",
        "action_subject": "string",
        "action_to": "string",
        "action_type": "string",
        "action_url": "string"
      }
    ],
    "alert_frequency": 0,
    "alert_id": "string",
    "alert_name": "string",
    "alert_priority": "string",
    "alert_threshold": "string",
    "alert_threshold_condition": "string",
    "alert_threshold_key": "string",
    "is_active": true
  },
  "response_code": 200
}

Authorizations:

OAuth2Password

Request Body schema: application/json

Alert ID Payload

alert_id required

string

Responses

https://localhost:8000/api/v1/alert/id

Request samples

• Payload

Content type

application/json

{

• "alert_id": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": {

  • "alert_actions": [

    • {

      • "action_access_id": "string",
      • "action_access_token": "string",
      • "action_auth_header": "string",
      • "action_external_link": "string",
      • "action_header": "string",
      • "action_is_auto_payload": true,
      • "action_is_secure": true,
      • "action_message": "string",
      • "action_method": "string",
      • "action_payload": "string",
      • "action_process_delay": 0,
      • "action_query": "string",
      • "action_subject": "string",
      • "action_to": "string",
      • "action_type": "string",
      • "action_url": "string"

      }

    ],
  • "alert_frequency": 0,
  • "alert_id": "string",
  • "alert_name": "string",
  • "alert_priority": "string",
  • "alert_threshold": "string",
  • "alert_threshold_condition": "string",
  • "alert_threshold_key": "string",
  • "is_active": true

  },
• "response_code": 0

}

Alert List by Channel ID

Alert List API.

Sample INPUT

{
  "channel_id": "string"
}

Sample OUTPUT

{
  "message": "Alert list",
  "response": [
    {
      "alert_actions": [
        {
          "action_access_id": "string",
          "action_access_token": "string",
          "action_auth_header": "string",
          "action_external_link": "string",
          "action_header": "string",
          "action_is_auto_payload": true,
          "action_is_secure": true,
          "action_message": "string",
          "action_method": "string",
          "action_payload": "string",
          "action_process_delay": 0,
          "action_query": "string",
          "action_subject": "string",
          "action_to": "string",
          "action_type": "string",
          "action_url": "string"
        }
      ],
      "alert_frequency": 0,
      "alert_id": "string",
      "alert_name": "string",
      "alert_priority": "string",
      "alert_threshold": "string",
      "alert_threshold_condition": "string",
      "alert_threshold_key": "string",
      "is_active": true
    }
  ],
  "response_code": 200
}

Authorizations:

OAuth2Password

Request Body schema: application/json

Alert List Payload

channel_id required

string

Responses

https://localhost:8000/api/v1/alert/list

Request samples

• Payload

Content type

application/json

{

• "channel_id": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": [

  • {

    • "alert_actions": [

      • {

        • "action_access_id": "string",
        • "action_access_token": "string",
        • "action_auth_header": "string",
        • "action_external_link": "string",
        • "action_header": "string",
        • "action_is_auto_payload": true,
        • "action_is_secure": true,
        • "action_message": "string",
        • "action_method": "string",
        • "action_payload": "string",
        • "action_process_delay": 0,
        • "action_query": "string",
        • "action_subject": "string",
        • "action_to": "string",
        • "action_type": "string",
        • "action_url": "string"

        }

      ],
    • "alert_frequency": 0,
    • "alert_id": "string",
    • "alert_name": "string",
    • "alert_priority": "string",
    • "alert_threshold": "string",
    • "alert_threshold_condition": "string",
    • "alert_threshold_key": "string",
    • "is_active": true

    }

  ],
• "response_code": 0

}

Notification Gallery

Notification Gallery API.

Sample INPUT

// Query params

{
  "usecase_key": "string",
  "channel_id": "string",
  "notification_uuid": "string"
}

Sample Output

{
  "message": "Notifications gallery by UUID",
  "response": {
    "channel_id": "string",
    "gallery": [
      {
        "image": [
          0
        ],
        "time_stamp": "string",
        "uuid": "string"
      }
    ],
    "usecase_key": "string"
  },
  "response_code": 200
}

Authorizations:

OAuth2Password

query Parameters

stream_key required	string Stream Key
channel_id required	string Channel ID
notification_offset	integer Notification Offset
notification_limit	integer Notification Limit
start required	string Start Time
end required	string End Time

Responses

https://localhost:8000/api/v1/alert/notification/gallery

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": {

  • "channel_id": "string",
  • "gallery": [

    • {

      • "image": [

        • 0

        ],
      • "time_stamp": "string",
      • "uuid": "string"

      }

    ],
  • "usecase_key": "string"

  },
• "response_code": 0

}

Notification Gallery Image by ID

Notification Gallery API.

Sample INPUT

// Query params

{
  "usecase_key": "string",
  "channel_id": "string",
  "notification_uuid": "string"
}

Sample Output

{
  "message": "Notifications gallery by UUID",
  "response": {
    "channel_id": "string",
    "gallery": [
      {
        "image": [
          0
        ],
        "time_stamp": "string",
        "uuid": "string"
      }
    ],
    "usecase_key": "string"
  },
  "response_code": 200
}

Authorizations:

OAuth2Password

query Parameters

channel_id required	string Channel ID
notification_uuid	integer Notification UUID

Responses

https://localhost:8000/api/v1/alert/notification/gallery/uuid

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": {

  • "channel_id": "string",
  • "gallery": [

    • {

      • "image": [

        • 0

        ],
      • "time_stamp": "string",
      • "uuid": "string"

      }

    ],
  • "usecase_key": "string"

  },
• "response_code": 0

}

Notifications By Range

Notification By Range API.

Sample INPUT

// Query params

{
  "usecase_key": "string",
  "channel_id": "string",
  "notification_offset": 0,
  "notification_limit": 0,
  "start": "string",
  "end": "string"
}

Sample OUTPUT

Hello

{
  "message": "Notifications by range",
  "response": {
    "channel_id": "string",
    "end": "string",
    "notifications": [
      {
        "channel_id": "string",
        "notification_data": {
          "attachment": "string",
          "from": "string",
          "message": "string",
          "subject": "string",
          "to": "string"
        },
        "notification_extra": "string",
        "notification_time": "string",
        "notification_uuid": "string",
        "usecase_key": "string"
      }
    ],
    "start": "string",
    "usecase_key": "string"
  },
  "response_code": 200
}

Authorizations:

OAuth2Password

query Parameters

usecase required	string UseCase
channel_id required	string Channel ID
notification_offset	integer Notification Offset
notification_limit	integer Notification Limit
start required	string Start Time
end required	string End Time

Responses

https://localhost:8000/api/v1/alert/notification/range

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": {

  • "channel_id": "string",
  • "end": "string",
  • "notifications": [

    • {

      • "channel_id": "string",
      • "notification_data": {

        • "attachment": "string",
        • "from": "string",
        • "message": "string",
        • "subject": "string",
        • "to": "string"

        },
      • "notification_extra": "string",
      • "notification_time": "string",
      • "notification_uuid": "string",
      • "usecase_key": "string"

      }

    ],
  • "start": "string",
  • "usecase_key": "string"

  },
• "response_code": 0

}

Notification By UUID

Notification By UUID API.

Sample INPUT

// Query params

{
  "usecase_key": "string",
  "channel_id": "string",
  "notification_uuid": "string"
}

Sample OUTPUT

Hello

{
  "message": "Notification by UUID",
  "response": {
    "channel_id": "string",
    "notification_data": {
      "attachment": "string",
      "from": "string",
      "message": "string",
      "subject": "string",
      "to": "string"
    },
    "notification_extra": "string",
    "notification_time": "string",
    "notification_uuid": "string",
    "usecase_key": "string"
  },
  "response_code": 200
}

Authorizations:

OAuth2Password

query Parameters

usecase required	string UseCase Key
channel_id required	string Channel ID
notification_uuid required	string Notification UUID

Responses

https://localhost:8000/api/v1/alert/notification/uuid

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": {

  • "channel_id": "string",
  • "notification_data": {

    • "attachment": "string",
    • "from": "string",
    • "message": "string",
    • "subject": "string",
    • "to": "string"

    },
  • "notification_extra": "string",
  • "notification_time": "string",
  • "notification_uuid": "string",
  • "usecase_key": "string"

  },
• "response_code": 0

}

Alert Update

Alert Update API.

Sample INPUT

{
  "alert_actions": [
    {
      "action_access_id": "string",
      "action_access_token": "string",
      "action_auth_header": "string",
      "action_external_link": "string",
      "action_header": "string",
      "action_is_auto_payload": true,
      "action_is_secure": true,
      "action_message": "string",
      "action_method": "string",
      "action_payload": "string",
      "action_process_delay": 0,
      "action_query": "string",
      "action_subject": "string",
      "action_to": "string",
      "action_type": "string",
      "action_url": "string"
    }
  ],
  "alert_frequency": 0,
  "alert_id": "string",
  "alert_name": "string",
  "alert_priority": "string",
  "alert_threshold": "string",
  "alert_threshold_condition": "string",
  "alert_threshold_key": "string",
  "is_active": true
}

Sample OUTPUT

{
  "message": "Alert updated",
  "response": {
    "alert_actions": [
      {
        "action_access_id": "string",
        "action_access_token": "string",
        "action_auth_header": "string",
        "action_external_link": "string",
        "action_header": "string",
        "action_is_auto_payload": true,
        "action_is_secure": true,
        "action_message": "string",
        "action_method": "string",
        "action_payload": "string",
        "action_process_delay": 0,
        "action_query": "string",
        "action_subject": "string",
        "action_to": "string",
        "action_type": "string",
        "action_url": "string"
      }
    ],
    "alert_frequency": 0,
    "alert_id": "string",
    "alert_name": "string",
    "alert_priority": "string",
    "alert_threshold": "string",
    "alert_threshold_condition": "string",
    "alert_threshold_key": "string",
    "is_active": true
  },
  "response_code": 200
}

Authorizations:

OAuth2Password

Request Body schema: application/json

Alert Update Payload

required	Array of objects[ items ]
alert_frequency required	integer [ 0 .. 86400 ]
alert_id required	string
alert_name required	string
alert_priority required	string
alert_threshold required	string
alert_threshold_condition required	string
alert_threshold_key required	string
channel_id required	string

Responses

https://localhost:8000/api/v1/alert/update

Request samples

• Payload

Content type

application/json

{

• "alert_actions": [

  • {

    • "action_access_id": "string",
    • "action_access_token": "string",
    • "action_auth_header": "string",
    • "action_external_link": "string",
    • "action_header": "string",
    • "action_is_auto_payload": true,
    • "action_is_secure": true,
    • "action_message": "string",
    • "action_method": "string",
    • "action_payload": "string",
    • "action_process_delay": 0,
    • "action_query": "string",
    • "action_subject": "string",
    • "action_to": "string",
    • "action_type": "string",
    • "action_url": "string"

    }

  ],
• "alert_frequency": 86400,
• "alert_id": "string",
• "alert_name": "string",
• "alert_priority": "string",
• "alert_threshold": "string",
• "alert_threshold_condition": "string",
• "alert_threshold_key": "string",
• "channel_id": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": {

  • "alert_actions": [

    • {

      • "action_access_id": "string",
      • "action_access_token": "string",
      • "action_auth_header": "string",
      • "action_external_link": "string",
      • "action_header": "string",
      • "action_is_auto_payload": true,
      • "action_is_secure": true,
      • "action_message": "string",
      • "action_method": "string",
      • "action_payload": "string",
      • "action_process_delay": 0,
      • "action_query": "string",
      • "action_subject": "string",
      • "action_to": "string",
      • "action_type": "string",
      • "action_url": "string"

      }

    ],
  • "alert_frequency": 0,
  • "alert_id": "string",
  • "alert_name": "string",
  • "alert_priority": "string",
  • "alert_threshold": "string",
  • "alert_threshold_condition": "string",
  • "alert_threshold_key": "string",
  • "is_active": true

  },
• "response_code": 0

}

Analytics

Events By Range

Event By Range API.

Sample INPUT

// Query params

{
  "usecase_key": "string",
  "usecase_meta_key": [
    "string"
  ],
  "channel_id": "string",
  "event_offset": 0,
  "event_limit": "string",
  "start": "string",
  "end": "string",
  "agg_frequency": "string",
  "details": false,
  "type": 0
}

Sample OUTPUT

{
  "message": "Alert activated",
  "response": {
    "agg_frequency": "string",
    "channel_id": "string",
    "end": "string",
    "event_limit": 0,
    "event_offset": 0,
    "events": [
      {
        "alert": 0,
        "down": 0,
        "dwell_time": 0,
        "fire": 0,
        "frame_collision": 0,
        "frame_near_miss": 0,
        "high_smoke": 0,
        "id": 0,
        "ids": [
          "string"
        ],
        "intermediate_smoke": 0,
        "low_smoke": 0,
        "metadata": "string",
        "moving_average_count": 0,
        "non_violation": 0,
        "occupancy": 0,
        "threshold": "string",
        "time": "string",
        "total": 0,
        "total_collision": 0,
        "total_near_miss": 0,
        "up": 0,
        "violation": 0
      }
    ],
    "start": "string",
    "usecase_key": "string"
  },
  "response_code": 200
}

Authorizations:

OAuth2Password

query Parameters

usecase required	string UseCase Key
usecase_meta_key required	string UseCase Meta Key
channel_id required	string Channel ID
event_offset	integer Event Offset
event_limit	integer Event Limit
start required	string Start Time
end required	string End Time
agg_frequency required	string Default: "100ms" Aggregation Frequency
details required	boolean Default: false details

Responses

https://localhost:8000/api/v1/alert/event/range

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": {

  • "agg_frequency": "string",
  • "channel_id": "string",
  • "end": "string",
  • "event_limit": 0,
  • "event_offset": 0,
  • "events": [

    • {

      • "alert": 0,
      • "down": 0,
      • "dwell_time": 0,
      • "fire": 0,
      • "frame_collision": 0,
      • "frame_near_miss": 0,
      • "high_smoke": 0,
      • "id": 0,
      • "ids": [

        • "string"

        ],
      • "intermediate_smoke": 0,
      • "low_smoke": 0,
      • "metadata": "string",
      • "moving_average_count": 0,
      • "non_violation": 0,
      • "occupancy": 0,
      • "threshold": "string",
      • "time": "string",
      • "total": 0,
      • "total_collision": 0,
      • "total_near_miss": 0,
      • "up": 0,
      • "violation": 0

      }

    ],
  • "start": "string",
  • "usecase_key": "string"

  },
• "response_code": 0

}

Channel Stats

Event Alert Stats API.

Sample INPUT

// Query params

{
  "usecase_key": "string",
  "usecase_meta_key": [
    "string"
  ],
  "channel_id": "string",
  "frequency": "-string"
}

Sample OUTPUT

{
  "message": "Alert activated",
  "response": {
    "channel_alert": {
      "channel": "string",
      "condition": "string",
      "count": 0,
      "key": "string",
      "name": "string",
      "time": "string"
    },
    "channel_id": "string",
    "channel_key": "string",
    "channel_name": "string",
    "channel_stats": {
      "alert": 0,
      "down": 0,
      "dwell_time": 0,
      "fire": 0,
      "frame_collision": 0,
      "frame_near_miss": 0,
      "high_smoke": 0,
      "ids": [
        "string"
      ],
      "intermediate_smoke": 0,
      "low_smoke": 0,
      "moving_average_count": 0,
      "non_violation": 0,
      "occupancy": 0,
      "total": 0,
      "total_collision": 0,
      "total_near_miss": 0,
      "up": 0,
      "violation": 0
    },
    "channel_total_alert": 0,
    "channel_total_notification": 0,
    "usecase_key": "string"
  },
  "response_code": 200
}

Authorizations:

OAuth2Password

query Parameters

usecase required	string UseCase Key
usecase_meta_key required	string UseCase Meta Key
channel_id required	string Channel ID
frequency required	string Default: "-1h" Frequency

Responses

https://localhost:8000/api/v1/alert/event/stats

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": {

  • "channel_alert": {

    • "channel": "string",
    • "condition": "string",
    • "count": 0,
    • "key": "string",
    • "name": "string",
    • "time": "string"

    },
  • "channel_id": "string",
  • "channel_key": "string",
  • "channel_name": "string",
  • "channel_stats": {

    • "alert": 0,
    • "down": 0,
    • "dwell_time": 0,
    • "fire": 0,
    • "frame_collision": 0,
    • "frame_near_miss": 0,
    • "high_smoke": 0,
    • "ids": [

      • "string"

      ],
    • "intermediate_smoke": 0,
    • "low_smoke": 0,
    • "moving_average_count": 0,
    • "non_violation": 0,
    • "occupancy": 0,
    • "total": 0,
    • "total_collision": 0,
    • "total_near_miss": 0,
    • "up": 0,
    • "violation": 0

    },
  • "channel_total_alert": 0,
  • "channel_total_notification": 0,
  • "usecase_key": "string"

  },
• "response_code": 0

}

UseCase Stats

Notification Stats By Usecase API.

Sample INPUT

// Query params

{
  "usecase_key": "string",
  "usecase_meta_key": [
    "string",
    "string",
    "string"
  ],
  "channel_id": "string",
  "frequency": "string",
  "details": true
}

Sample OUTPUT

Hello

{
  "message": "Notification stats",
  "response": {
    "usecase_channel": [
      {
        "channel_alert": {
          "channel": "string",
          "condition": "string",
          "count": 0,
          "key": "string",
          "name": "string",
          "time": "string"
        },
        "channel_id": "string",
        "channel_key": "string",
        "channel_name": "string",
        "channel_stats": {
          "alert": 0,
          "down": 0,
          "dwell_time": 0,
          "fire": 0,
          "frame_collision": 0,
          "frame_near_miss": 0,
          "high_smoke": 0,
          "ids": [
            "string"
          ],
          "intermediate_smoke": 0,
          "low_smoke": 0,
          "moving_average_count": 0,
          "non_violation": 0,
          "occupancy": 0,
          "total": 0,
          "total_collision": 0,
          "total_near_miss": 0,
          "up": 0,
          "violation": 0
        },
        "channel_total_alert": 0,
        "channel_total_notification": 0,
        "usecase_key": "string"
      }
    ],
    "usecase_key": "string",
    "usecase_total_alert": 0,
    "usecase_total_notification": 0,
    "usecase_total_stats": {
      "down": 0,
      "dwelltime": 0,
      "fire": 0,
      "framecollision": 0,
      "framenearmiss": 0,
      "highsmoke": 0,
      "intermediatesmoke": 0,
      "lowsmoke": 0,
      "movingaveragecount": 0,
      "nonviolation": 0,
      "occupancy": 0,
      "total": 0,
      "totalcollision": 0,
      "totalnearmiss": 0,
      "up": 0,
      "violation": 0
    }
  },
  "response_code": 200
}

Authorizations:

OAuth2Password

query Parameters

usecase required	string UseCase Key
usecase_meta_key required	string UseCase Meta Key
frequency required	string Default: "-1h" Frequency
details required	boolean Default: false details

Responses

https://localhost:8000/api/v1/alert/notification/stats

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": {

  • "usecase_channel": [

    • {

      • "channel_alert": {

        • "channel": "string",
        • "condition": "string",
        • "count": 0,
        • "key": "string",
        • "name": "string",
        • "time": "string"

        },
      • "channel_id": "string",
      • "channel_key": "string",
      • "channel_name": "string",
      • "channel_stats": {

        • "alert": 0,
        • "down": 0,
        • "dwell_time": 0,
        • "fire": 0,
        • "frame_collision": 0,
        • "frame_near_miss": 0,
        • "high_smoke": 0,
        • "ids": [

          • "string"

          ],
        • "intermediate_smoke": 0,
        • "low_smoke": 0,
        • "moving_average_count": 0,
        • "non_violation": 0,
        • "occupancy": 0,
        • "total": 0,
        • "total_collision": 0,
        • "total_near_miss": 0,
        • "up": 0,
        • "violation": 0

        },
      • "channel_total_alert": 0,
      • "channel_total_notification": 0,
      • "usecase_key": "string"

      }

    ],
  • "usecase_key": "string",
  • "usecase_total_alert": 0,
  • "usecase_total_notification": 0,
  • "usecase_total_stats": {

    • "down": 0,
    • "dwelltime": 0,
    • "fire": 0,
    • "framecollision": 0,
    • "framenearmiss": 0,
    • "highsmoke": 0,
    • "intermediatesmoke": 0,
    • "lowsmoke": 0,
    • "movingaveragecount": 0,
    • "nonviolation": 0,
    • "occupancy": 0,
    • "total": 0,
    • "totalcollision": 0,
    • "totalnearmiss": 0,
    • "up": 0,
    • "violation": 0

    }

  },
• "response_code": 0

}

UseCase Stats

Usecase Stats API

Sample INPUT

{
  "details": true,
  "frequency": "string",
  "usecase_key": "string",
  "usecase_meta_key": [
    "string"
  ]
}

Sample OUTPUT

 {
  "message": "Usecase deleted",
  "response":  {
    "usecase_channel": [
      {
        "channel_alert": {
          "channel": "string",
          "condition": "string",
          "count": 0,
          "key": "string",
          "name": "string",
          "time": "string"
        },
        "channel_id": "string",
        "channel_key": "string",
        "channel_name": "string",
        "channel_stats": {
          "alert": 0,
          "down": 0,
          "dwell_time": 0,
          "fire": 0,
          "frame_collision": 0,
          "frame_near_miss": 0,
          "high_smoke": 0,
          "ids": [
            "string"
          ],
          "intermediate_smoke": 0,
          "low_smoke": 0,
          "moving_average_count": 0,
          "non_violation": 0,
          "occupancy": 0,
          "total": 0,
          "total_collision": 0,
          "total_near_miss": 0,
          "up": 0,
          "violation": 0
        },
        "channel_total_alert": 0,
        "channel_total_notification": 0,
        "usecase_key": "string"
      }
    ],
    "usecase_key": "string",
    "usecase_total_alert": 0,
    "usecase_total_notification": 0,
    "usecase_total_stats": {
      "alert": 0,
      "down": 0,
      "dwell_time": 0,
      "fire": 0,
      "frame_collision": 0,
      "frame_near_miss": 0,
      "high_smoke": 0,
      "ids": [
        "string"
      ],
      "intermediate_smoke": 0,
      "low_smoke": 0,
      "moving_average_count": 0,
      "non_violation": 0,
      "occupancy": 0,
      "total": 0,
      "total_collision": 0,
      "total_near_miss": 0,
      "up": 0,
      "violation": 0
    }
  },
  "response_code": 200
}

Authorizations:

OAuth2Password

Request Body schema: application/json

UseCase Stats Payload

details required	boolean
frequency required	string
usecase_key required	string
usecase_meta_key required	Array of strings

Responses

https://localhost:8000/api/v1/usecase/stats

Request samples

• Payload

Content type

application/json

{

• "details": true,
• "frequency": "string",
• "usecase_key": "string",
• "usecase_meta_key": [

  • "string"

  ]

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": {

  • "usecase_channel": [

    • {

      • "channel_alert": {

        • "channel": "string",
        • "condition": "string",
        • "count": 0,
        • "key": "string",
        • "name": "string",
        • "time": "string"

        },
      • "channel_id": "string",
      • "channel_key": "string",
      • "channel_name": "string",
      • "channel_stats": {

        • "alert": 0,
        • "down": 0,
        • "dwell_time": 0,
        • "fire": 0,
        • "frame_collision": 0,
        • "frame_near_miss": 0,
        • "high_smoke": 0,
        • "ids": [

          • "string"

          ],
        • "intermediate_smoke": 0,
        • "low_smoke": 0,
        • "moving_average_count": 0,
        • "non_violation": 0,
        • "occupancy": 0,
        • "total": 0,
        • "total_collision": 0,
        • "total_near_miss": 0,
        • "up": 0,
        • "violation": 0

        },
      • "channel_total_alert": 0,
      • "channel_total_notification": 0,
      • "usecase_key": "string"

      }

    ],
  • "usecase_key": "string",
  • "usecase_total_alert": 0,
  • "usecase_total_notification": 0,
  • "usecase_total_stats": {

    • "alert": 0,
    • "down": 0,
    • "dwell_time": 0,
    • "fire": 0,
    • "frame_collision": 0,
    • "frame_near_miss": 0,
    • "high_smoke": 0,
    • "ids": [

      • "string"

      ],
    • "intermediate_smoke": 0,
    • "low_smoke": 0,
    • "moving_average_count": 0,
    • "non_violation": 0,
    • "occupancy": 0,
    • "total": 0,
    • "total_collision": 0,
    • "total_near_miss": 0,
    • "up": 0,
    • "violation": 0

    }

  },
• "response_code": 0

}

User

User Auth

User Auth with return Access token

query Parameters

is_secret	boolean Reveal Secret
client_id	string Reveal Secret for Client ID

Responses

https://localhost:8000/api/v1/auth/client/list

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "message": "string",
• "response": null,
• "response_code": 0

}

User Auth

User Auth with return Access token

Request Body schema: application/json

User Auth Payload

email required	string
password required	string

Responses

https://localhost:8000/api/v1/login

Request samples

• Payload

Content type

application/json

{

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

}

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "message": "string",
• "response": null,
• "response_code": 0

}

User Config By ID

User Config Update By ID

Sample INPUT

{
  "user_config": {
    "channel_ids": [
      "string"
    ],
    "role_id": "string",
    "ui_config": {
      "additionalProp1": {}
    },
    "usecase_ids": [
      "string"
    ],
    "user_id": "string"
  },
  "user_id": "string"
}

Sample OUTPUT

{
  "message": "User Config Updated",
  "response": null,
  "response_code": 200
}

Authorizations:

OAuth2Password

Request Body schema: application/json

User Config By ID Payload

	object (user.userConfigResp)
user_id required	string

Responses

https://localhost:8000/api/v1/user/config

Request samples

• Payload

Content type

application/json

{

• "user_config": {

  • "channel_ids": [

    • "string"

    ],
  • "role_id": "string",
  • "ui_config": { },
  • "usecase_ids": [

    • "string"

    ],
  • "user_id": "string"

  },
• "user_id": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": {

  • "channel_ids": [

    • "string"

    ],
  • "role_id": "string",
  • "ui_config": { },
  • "usecase_ids": [

    • "string"

    ],
  • "user_id": "string"

  },
• "response_code": 0

}

User Config Update By ID

User Config Update By ID

Sample INPUT

{
  "user_config": {
    "channel_ids": [
      "string"
    ],
    "role_id": "string",
    "ui_config": {
      "additionalProp1": {}
    },
    "usecase_ids": [
      "string"
    ],
    "user_id": "string"
  },
  "user_id": "string"
}

Sample OUTPUT

{
  "message": "User Config Updated",
  "response": null,
  "response_code": 200
}

Authorizations:

OAuth2Password

Request Body schema: application/json

User Config Update By ID Payload

	object (user.userConfigResp)
user_id required	string

Responses

https://localhost:8000/api/v1/user/config/update

Request samples

• Payload

Content type

application/json

{

• "user_config": {

  • "channel_ids": [

    • "string"

    ],
  • "role_id": "string",
  • "ui_config": { },
  • "usecase_ids": [

    • "string"

    ],
  • "user_id": "string"

  },
• "user_id": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": null,
• "response_code": 0

}

User Register

New User Register

Sample INPUT

{
  "email": "string",
  "first_name": "string",
  "last_name": "string",
  "password": "string",
  "role_key": "string"
}

Sample OUTPUT

{
  "message": "User Registered",
  "response": {
    "avatar": "string",
    "channel_ids": [
      "string"
    ],
    "email": "string",
    "first_name": "string",
    "is_active": true,
    "is_verified": true,
    "last_logged_in_at": "string",
    "last_name": "string",
    "role_id": "string",
    "role_key": "string",
    "ui_config": {
      "additionalProp1": {}
    },
    "usecase_ids": [
      "string"
    ],
    "user_id": "string",
    "user_name": "string"
  },
  "response_code": 201
}

Request Body schema: application/json

User Register Payload

email required	string
first_name required	string
last_name required	string
password required	string
role_key required	string

Responses

https://localhost:8000/api/v1/user/create

Request samples

• Payload

Content type

application/json

{

• "email": "string",
• "first_name": "string",
• "last_name": "string",
• "password": "string",
• "role_key": "string"

}

Response samples

• 200
• 201
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": {

  • "avatar": "string",
  • "channel_ids": [

    • "string"

    ],
  • "email": "string",
  • "first_name": "string",
  • "is_active": true,
  • "is_verified": true,
  • "last_logged_in_at": "string",
  • "last_name": "string",
  • "role_id": "string",
  • "role_key": "string",
  • "ui_config": { },
  • "usecase_ids": [

    • "string"

    ],
  • "user_id": "string",
  • "user_name": "string"

  },
• "response_code": 0

}

User Delete

User Delete by ID

Sample INPUT

{
  "user_id": "string"
}

Sample OUTPUT

{
  "message": "User Deleted",
  "response": null,
  "response_code": 200
}

Authorizations:

OAuth2Password

Request Body schema: application/json

User Update Payload

user_id required

string

Responses

https://localhost:8000/api/v1/user/delete

Request samples

• Payload

Content type

application/json

{

• "user_id": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": null,
• "response_code": 0

}

User Get By ID

User Get by ID

Sample INPUT

{
  "user_id": "string"
}

Sample OUTPUT

{
  "message": "User By ID",
  "response": {
    "avatar": "string",
    "channel_ids": [
      "string"
    ],
    "email": "string",
    "first_name": "string",
    "is_active": true,
    "is_verified": true,
    "last_logged_in_at": "string",
    "last_name": "string",
    "role_id": "string",
    "role_key": "string",
    "ui_config": {
      "additionalProp1": {}
    },
    "usecase_ids": [
      "string"
    ],
    "user_id": "string",
    "user_name": "string"
  },
  "response_code": 200
}

Authorizations:

OAuth2Password

Request Body schema: application/json

User Get By ID Payload

user_id required

string

Responses

https://localhost:8000/api/v1/user/id

Request samples

• Payload

Content type

application/json

{

• "user_id": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": {

  • "avatar": "string",
  • "channel_ids": [

    • "string"

    ],
  • "email": "string",
  • "first_name": "string",
  • "is_active": true,
  • "is_verified": true,
  • "last_logged_in_at": "string",
  • "last_name": "string",
  • "role_id": "string",
  • "role_key": "string",
  • "ui_config": { },
  • "usecase_ids": [

    • "string"

    ],
  • "user_id": "string",
  • "user_name": "string"

  },
• "response_code": 0

}

User Info

User Info by Access token

Sample OUTPUT

{
  "message": "User By ID",
  "response": {
    "avatar": "string",
    "channel_ids": [
      "string"
    ],
    "email": "string",
    "first_name": "string",
    "is_active": true,
    "is_verified": true,
    "last_logged_in_at": "string",
    "last_name": "string",
    "role_id": "string",
    "role_key": "string",
    "ui_config": {
      "additionalProp1": {}
    },
    "usecase_ids": [
      "string"
    ],
    "user_id": "string",
    "user_name": "string",
    "user_config": {
      "channel_ids": [
        "string"
      ],
      "role_id": "string",
      "ui_config": {
        "additionalProp1": {}
      },
      "usecase_ids": [
        "string"
      ],
      "user_id": "string"
    }
  },
  "response_code": 200
}

Authorizations:

OAuth2Password

Responses

https://localhost:8000/api/v1/user/info

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": {

  • "avatar": "string",
  • "channel_ids": [

    • "string"

    ],
  • "email": "string",
  • "first_name": "string",
  • "is_active": true,
  • "is_verified": true,
  • "last_logged_in_at": "string",
  • "last_name": "string",
  • "role_id": "string",
  • "role_key": "string",
  • "ui_config": { },
  • "usecase_ids": [

    • "string"

    ],
  • "user_id": "string",
  • "user_name": "string",
  • "user_config": {

    • "channel_ids": [

      • "string"

      ],
    • "role_id": "string",
    • "ui_config": { },
    • "usecase_ids": [

      • "string"

      ],
    • "user_id": "string"

    }

  },
• "response_code": 0

}

User List

User List`

Sample OUTPUT

{
  "message": "User List",
  "response": [
    {
      "avatar": "string",
      "channel_ids": [
        "string"
      ],
      "email": "string",
      "first_name": "string",
      "is_active": true,
      "is_verified": true,
      "last_logged_in_at": "string",
      "last_name": "string",
      "role_id": "string",
      "role_key": "string",
      "ui_config": {
        "additionalProp1": {}
      },
      "usecase_ids": [
        "string"
      ],
      "user_id": "string",
      "user_name": "string"
    }
  ],
  "response_code": 200
}

Authorizations:

OAuth2Password

Responses

https://localhost:8000/api/v1/user/list

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": [

  • {

    • "avatar": "string",
    • "channel_ids": [

      • "string"

      ],
    • "email": "string",
    • "first_name": "string",
    • "is_active": true,
    • "is_verified": true,
    • "last_logged_in_at": "string",
    • "last_name": "string",
    • "role_id": "string",
    • "role_key": "string",
    • "ui_config": { },
    • "usecase_ids": [

      • "string"

      ],
    • "user_id": "string",
    • "user_name": "string"

    }

  ],
• "response_code": 0

}

User Update

User Update by ID

Sample INPUT

{
  "change_password": true,
  "confirm_password": "string",
  "email": "string",
  "first_name": "string",
  "last_name": "string",
  "password": "string",
  "role_id": "string",
  "user_id": "string"
}

Sample OUTPUT

{
  "message": "User Updated",
  "response": null,
  "response_code": 200
}

Authorizations:

OAuth2Password

Request Body schema: application/json

User Update Payload

change_password required	boolean
confirm_password	string
email required	string
first_name	string
last_name	string
password	string
role_id required	string
user_id required	string

Responses

https://localhost:8000/api/v1/user/update

Request samples

• Payload

Content type

application/json

{

• "change_password": true,
• "confirm_password": "string",
• "email": "string",
• "first_name": "string",
• "last_name": "string",
• "password": "string",
• "role_id": "string",
• "user_id": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": {

  • "avatar": "string",
  • "channel_ids": [

    • "string"

    ],
  • "email": "string",
  • "first_name": "string",
  • "is_active": true,
  • "is_verified": true,
  • "last_logged_in_at": "string",
  • "last_name": "string",
  • "role_id": "string",
  • "role_key": "string",
  • "ui_config": { },
  • "usecase_ids": [

    • "string"

    ],
  • "user_id": "string",
  • "user_name": "string"

  },
• "response_code": 0

}

Auto

Auto Test

Auto Test API.

Sample OUTPUT

{
    "message": "Auto Test",
    "response": null,
    "response_code": 200
}

Responses

https://localhost:8000/api/v1/auto/test

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": null,
• "response_code": 0

}

Configuration

Status Storage

Storage Information + Account Information

Responses

https://localhost:8000/api/v1/config/account

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": null,
• "response_code": 0

}

Is INIT

Config Init API.

Sample OUTPUT

  {
    "message": "Init Settings",
    "response": {},
    "response_code": 200
  } 

Authorizations:

OAuth2Password

Responses

https://localhost:8000/api/v1/config/init

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": { },
• "response_code": 0

}

Reset STS

Access control list

Authorizations:

OAuth2Password

Responses

https://localhost:8000/api/v1/config/reset

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": null,
• "response_code": 0

}

Get SMS Config

Get SMS Config API.

Sample OUTPUT

{
    "message": "SMS Settings",
    "response": {
        "sms_auth_key": "string",
        "sms_auth_token": "string",
        "sms_provider": "string",
        "sms_from": "string",
        "sms_to": "string"
    },
    "response_code": 200
}

Authorizations:

OAuth2Password

query Parameters

is_secret required

boolean Reveal Secret

Responses

https://localhost:8000/api/v1/config/sms

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": {

  • "sms_auth_key": "string",
  • "sms_auth_token": "string",
  • "sms_from": "string",
  • "sms_provider": "string",
  • "sms_to": "string"

  },
• "response_code": 0

}

Update SMS Config

Update SMS Config API.

Sample INPUT

{
  "sms_auth_key": "string",
  "sms_auth_token": "string",
  "sms_provider": "string",
  "sms_from": "string",
  "sms_to": "string"
}

Sample OUTPUT

{
  "message": "SMS settings updated",
  "response": null,
  "response_code": 200
}

Authorizations:

OAuth2Password

Responses

https://localhost:8000/api/v1/config/sms

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": null,
• "response_code": 0

}

Get SMTP Config

Get SMS Config API.

Sample OUTPUT

{
  "message": "SMTP Settings",
  "response": {
    "smtp_attachment": true,
    "smtp_auth": true,
    "smtp_from": "string",
    "smtp_host": "string",
    "smtp_password": "string",
    "smtp_port": 0,
    "smtp_to": "string",
    "smtp_username": "string"
  },
  "response_code": 200
}

Authorizations:

OAuth2Password

query Parameters

is_secret required

boolean Reveal Secret

Responses

https://localhost:8000/api/v1/config/smtp

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": {

  • "smtp_attachment": true,
  • "smtp_auth": true,
  • "smtp_from": "string",
  • "smtp_host": "string",
  • "smtp_password": "string",
  • "smtp_port": 0,
  • "smtp_to": "string",
  • "smtp_username": "string"

  },
• "response_code": 0

}

Update SMTP Config

Update SMTP Config API.

Sample INPUT

{
  "smtp_attachment": true,
  "smtp_auth": true,
  "smtp_from": "string",
  "smtp_host": "string",
  "smtp_password": "string",
  "smtp_port": 0,
  "smtp_to": "string",
  "smtp_username": "string"
}

Sample OUTPUT

{
  "message": "SMTP settings updated",
  "response": null,
  "response_code": 200
}

Authorizations:

OAuth2Password

Responses

https://localhost:8000/api/v1/config/smtp

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": null,
• "response_code": 0

}

Status Storage

Storage Information

Responses

https://localhost:8000/api/v1/config/storage

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": null,
• "response_code": 0

}

Customer

Customer Create

Customer Create API.

Sample INPUT

{
  "customer_address": {
    "customer_area": "string",
    "customer_city": "string",
    "customer_country": "string",
    "customer_state": "string",
    "customer_street": "string",
    "customer_unit": "string",
    "customer_zip": "string"
  },
  "customer_contact": [
    "string"
  ],
  "customer_description": "string",
  "customer_icon": "string",
  "customer_id": "string",
  "customer_key": "string",
  "customer_name": "string",
  "customer_sites": [
    "string"
  ],
  "customer_type": "string",
  "organization_id": "string"
}

Sample OUTPUT

{
  "message": "Customer Created",
  "response": null,
  "response_code": 201
}

Authorizations:

OAuth2Password

Request Body schema: application/json

Customer Create Payload

required	object (customer.customerAddress)
customer_contact	Array of strings
customer_description required	string
customer_icon required	string
customer_key required	string
customer_name required	string
customer_sites	Array of strings
customer_type	string
organization_id required	string

Responses

https://localhost:8000/api/v1/customer/create

Request samples

• Payload

Content type

application/json

{

• "customer_address": {

  • "customer_area": "string",
  • "customer_city": "string",
  • "customer_country": "string",
  • "customer_state": "string",
  • "customer_street": "string",
  • "customer_unit": "string",
  • "customer_zip": "string"

  },
• "customer_contact": [

  • "string"

  ],
• "customer_description": "string",
• "customer_icon": "string",
• "customer_key": "string",
• "customer_name": "string",
• "customer_sites": [

  • "string"

  ],
• "customer_type": "string",
• "organization_id": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": null,
• "response_code": 0

}

Customer Delete

Customer Delete API.

Sample INPUT

{
    "customer_id": "string"
}

Sample OUTPUT

{
    "message": "Customer deleted",
    "response": null,
    "response_code": 200
}

Authorizations:

OAuth2Password

Request Body schema: application/json

Customer Delete Payload

customer_id required

string

Responses

https://localhost:8000/api/v1/customer/delete

Request samples

• Payload

Content type

application/json

{

• "customer_id": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": null,
• "response_code": 0

}

Customer ID

Customer ID API.

Sample INPUT

// Query params

{
  "customer_id": "string"
}

Sample OUTPUT

{
  "message": "Customer Id",
  "response": {
    "customer_address": {
      "customer_area": "string",
      "customer_city": "string",
      "customer_country": "string",
      "customer_state": "string",
      "customer_street": "string",
      "customer_unit": "string",
      "customer_zip": "string"
    },
    "customer_contact": [
      "string"
    ],
    "customer_description": "string",
    "customer_icon": "string",
    "customer_id": "string",
    "customer_key": "string",
    "customer_name": "string",
    "customer_sites": [
      "string"
    ],
    "customer_type": "string",
    "organization_id": "string"
  },
  "response_code": 200
}

Authorizations:

OAuth2Password

query Parameters

customer_id required

string Customer ID

Responses

https://localhost:8000/api/v1/customer/id

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": {

  • "customer_address": {

    • "customer_area": "string",
    • "customer_city": "string",
    • "customer_country": "string",
    • "customer_state": "string",
    • "customer_street": "string",
    • "customer_unit": "string",
    • "customer_zip": "string"

    },
  • "customer_contact": [

    • "string"

    ],
  • "customer_description": "string",
  • "customer_icon": "string",
  • "customer_id": "string",
  • "customer_key": "string",
  • "customer_name": "string",
  • "customer_sites": [

    • "string"

    ],
  • "customer_type": "string",
  • "organization_id": "string"

  },
• "response_code": 0

}

Customer List

Customer List API.

Sample INPUT

// Query params

{
  "organization_id": "string",
  "is_default": "string"
}

Sample OUTPUT

{
  "message": "Customer List",
  "response": [
    {
      "customer_address": {
        "customer_area": "string",
        "customer_city": "string",
        "customer_country": "string",
        "customer_state": "string",
        "customer_street": "string",
        "customer_unit": "string",
        "customer_zip": "string"
      },
      "customer_contact": [
        "string"
      ],
      "customer_description": "string",
      "customer_icon": "string",
      "customer_id": "string",
      "customer_key": "string",
      "customer_name": "string",
      "customer_sites": [
        "string"
      ],
      "customer_type": "string",
      "organization_id": "string"
    }
  ],
  "response_code": 200
}

Authorizations:

OAuth2Password

query Parameters

organization_id required	string Organization ID
is_default	string Includes Default Customer

Responses

https://localhost:8000/api/v1/customer/list

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": [

  • {

    • "customer_address": {

      • "customer_area": "string",
      • "customer_city": "string",
      • "customer_country": "string",
      • "customer_state": "string",
      • "customer_street": "string",
      • "customer_unit": "string",
      • "customer_zip": "string"

      },
    • "customer_contact": [

      • "string"

      ],
    • "customer_description": "string",
    • "customer_icon": "string",
    • "customer_id": "string",
    • "customer_key": "string",
    • "customer_name": "string",
    • "customer_sites": [

      • "string"

      ],
    • "customer_type": "string",
    • "organization_id": "string"

    }

  ],
• "response_code": 0

}

Customer Update

Customer Update API.

Sample INPUT

{
  "customer_address": {
    "customer_area": "string",
    "customer_city": "string",
    "customer_country": "string",
    "customer_state": "string",
    "customer_street": "string",
    "customer_unit": "string",
    "customer_zip": "string"
  },
  "customer_contact": [
    "string"
  ],
  "customer_description": "string",
  "customer_icon": "string",
  "customer_id": "string",
  "customer_key": "string",
  "customer_name": "string",
  "customer_sites": [
    "string"
  ],
  "customer_type": "string",
  "organization_id": "string"
}

Sample OUTPUT

{
  "message": "Customer updated",
  "response": null,
  "response_code": 200
}

Authorizations:

OAuth2Password

Request Body schema: application/json

Customer Update Payload

required	object (customer.customerAddress)
customer_contact	Array of strings
customer_description required	string
customer_icon required	string
customer_id required	string
customer_key required	string
customer_name required	string
customer_sites	Array of strings
customer_type	string
organization_id required	string

Responses

https://localhost:8000/api/v1/customer/update

Request samples

• Payload

Content type

application/json

{

• "customer_address": {

  • "customer_area": "string",
  • "customer_city": "string",
  • "customer_country": "string",
  • "customer_state": "string",
  • "customer_street": "string",
  • "customer_unit": "string",
  • "customer_zip": "string"

  },
• "customer_contact": [

  • "string"

  ],
• "customer_description": "string",
• "customer_icon": "string",
• "customer_id": "string",
• "customer_key": "string",
• "customer_name": "string",
• "customer_sites": [

  • "string"

  ],
• "customer_type": "string",
• "organization_id": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": null,
• "response_code": 0

}

Customer View

Customer View API

Sample INPUT

// Query params

{
  "customer_id": "string",
  "type": 1
}

Sample OUTPUT Type 1

{
  "message": "Customer site map",
  "response": [
    {
      "site_address": {
        "site_area": "string",
        "site_city": "string",
        "site_country": "string",
        "site_geolocation": {
          "lat": 0,
          "long": 0
        },
        "site_state": "string",
        "site_street": "string",
        "site_unit": "string",
        "site_zip": "string"
      },
      "site_description": "string",
      "site_devices": [
        {
          "device_id": "string",
          "device_identifier": "string",
          "device_name": "string",
          "device_source": [
            {
              "source_address": "string",
              "source_fps": 0,
              "source_id": "string",
              "source_name": "string",
              "source_sid": 0,
              "source_type": "string"
            }
          ],
          "device_state": true,
          "device_status": "string",
          "device_tags": {
            "additionalProp1": "string",
            "additionalProp2": "string",
            "additionalProp3": "string"
          },
          "device_type": "string",
          "device_uuid": "string",
          "device_value": "string",
          "source_channels": [
            {
              "channel_favorite": true,
              "channel_id": "string",
              "channel_key": "string",
              "channel_name": "string",
              "channel_sid": "string",
              "channel_threshold_duration": 0,
              "device_id": "string",
              "is_active": true,
              "is_storage": true,
              "is_verified": true,
              "nimble_id": "string",
              "pipeline_id": "string",
              "source_id": "string",
              "usecase_icon": "string",
              "usecase_id": "string",
              "usecase_key": "string",
              "usecase_meta_key": [
                "string"
              ],
              "usecase_name": "string"
            }
          ]
        }
      ],
      "site_icon": "string",
      "site_id": "string",
      "site_image": "string",
      "site_key": "string",
      "site_name": "string",
      "site_type": "string"
    }
  ],
  "response_code": 200
}

Sample OUTPUT Type 2

{
  "message": "Customer site map",
  "response": [
    {
      "usecase_background_color": "string",
      "usecase_channels": [
        {
          "channel_favorite": true,
          "channel_id": "string",
          "channel_key": "string",
          "channel_name": "string",
          "channel_sid": "string",
          "channel_threshold_duration": 0,
          "device_id": "string",
          "is_active": true,
          "is_storage": true,
          "is_verified": true,
          "nimble_id": "string",
          "pipeline_id": "string",
          "site_id": "string",
          "source_id": "string",
          "usecase_icon": "string",
          "usecase_id": "string",
          "usecase_key": "string",
          "usecase_meta_key": [
            "string"
          ],
          "usecase_name": "string"
        }
      ],
      "usecase_component_key": "string",
      "usecase_desc": "string",
      "usecase_icon": "string",
      "usecase_id": "string",
      "usecase_key": "string",
      "usecase_meta_key": [
        "string"
      ],
      "usecase_name": "string"
    }
  ],
  "response_code": 200
}

Authorizations:

OAuth2Password

query Parameters

customer_id required	string Customer ID
type required	integer type

Responses

https://localhost:8000/api/v1/customer/view

Response samples

• 200
• 202
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": [

  • {

    • "site_address": {

      • "site_area": "string",
      • "site_city": "string",
      • "site_country": "string",
      • "site_geolocation": {

        • "lat": 0,
        • "long": 0

        },
      • "site_state": "string",
      • "site_street": "string",
      • "site_unit": "string",
      • "site_zip": "string"

      },
    • "site_description": "string",
    • "site_devices": [

      • {

        • "device_id": "string",
        • "device_identifier": "string",
        • "device_name": "string",
        • "device_source": [

          • {

            • "source_address": "string",
            • "source_fps": 0,
            • "source_id": "string",
            • "source_name": "string",
            • "source_sid": 0,
            • "source_type": "string"

            }

          ],
        • "device_state": true,
        • "device_status": "string",
        • "device_tags": {

          • "property1": "string",
          • "property2": "string"

          },
        • "device_type": "string",
        • "device_uuid": "string",
        • "device_value": "string",
        • "source_channels": [

          • {

            • "channel_favorite": true,
            • "channel_id": "string",
            • "channel_key": "string",
            • "channel_name": "string",
            • "channel_sid": "string",
            • "channel_threshold_duration": 0,
            • "device_id": "string",
            • "is_active": true,
            • "is_storage": true,
            • "is_verified": true,
            • "nimble_id": "string",
            • "pipeline_id": "string",
            • "source_id": "string",
            • "usecase_icon": "string",
            • "usecase_id": "string",
            • "usecase_key": "string",
            • "usecase_meta_key": [

              • "string"

              ],
            • "usecase_name": "string"

            }

          ]

        }

      ],
    • "site_icon": "string",
    • "site_id": "string",
    • "site_image": "string",
    • "site_key": "string",
    • "site_name": "string",
    • "site_type": "string"

    }

  ],
• "response_code": 0

}

Organization

Customer Site Assign

Customer Site Assign API.

Sample INPUT

{
  "customer_id": "string",
  "site_ids": [
    "string"
  ]
}

Sample OUTPUT

{
  "message": "Assigned site(s) to customer",
  "response": null,
  "response_code": 200
}

Authorizations:

OAuth2Password

Request Body schema: application/json

Customer Site Assign Payload

customer_id required	string
site_ids required	Array of strings

Responses

https://localhost:8000/api/v1/customer/site/assign

Request samples

• Payload

Content type

application/json

{

• "customer_id": "string",
• "site_ids": [

  • "string"

  ]

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": null,
• "response_code": 0

}

Customer Site Unassign

Customer Site Unassign API.

Sample INPUT

{
  "customer_id": "string",
  "site_ids": [
    "string"
  ]
}

Sample OUTPUT

{
    "message": "Unassigned site(s) to customer",
    "response": null,
    "response_code": 200
}

Authorizations:

OAuth2Password

Request Body schema: application/json

Customer Site Assign Payload

customer_id required	string
site_ids required	Array of strings

Responses

https://localhost:8000/api/v1/customer/site/unassign

Request samples

• Payload

Content type

application/json

{

• "customer_id": "string",
• "site_ids": [

  • "string"

  ]

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": null,
• "response_code": 0

}

Organization Create

Organization Create API

Sample INPUT

{
  "organization_address": {
    "organization_area": "string",
    "organization_city": "string",
    "organization_country": "string",
    "organization_geolocation": {
      "lat": 0,
      "long": 0
    },
    "organization_state": "string",
    "organization_street": "string",
    "organization_unit": "string",
    "organization_zip": "string"
  },
  "organization_description": "string",
  "organization_icon": "string",
  "organization_id": "string",
  "organization_key": "string",
  "organization_name": "string",
  "organization_website": "string"
}

Sample OUTPUT

{
  "message": "Organization created",
  "response": null,
  "response_code": 200
}

Authorizations:

OAuth2Password

Request Body schema: application/json

Organization Create Payload

required	object (organization.organizationAddress)
organization_description required	string
organization_icon required	string
organization_key required	string
organization_name required	string
organization_website required	string

Responses

https://localhost:8000/api/v1/organization/create

Request samples

• Payload

Content type

application/json

{

• "organization_address": {

  • "organization_area": "string",
  • "organization_city": "string",
  • "organization_country": "string",
  • "organization_geolocation": {

    • "lat": 0,
    • "long": 0

    },
  • "organization_state": "string",
  • "organization_street": "string",
  • "organization_unit": "string",
  • "organization_zip": "string"

  },
• "organization_description": "string",
• "organization_icon": "string",
• "organization_key": "string",
• "organization_name": "string",
• "organization_website": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": null,
• "response_code": 0

}

Organization Delete

Organization Delete API

Sample INPUT

{
  "organization_id": "string"
}

Sample OUTPUT

{
  "message": "Organization Deleted",
  "response": null,
  "response_code": 200
}

Authorizations:

OAuth2Password

Request Body schema: application/json

Organization Delete Payload

organization_id required

string

Responses

https://localhost:8000/api/v1/organization/delete

Request samples

• Payload

Content type

application/json

{

• "organization_id": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": null,
• "response_code": 0

}

Organization ID

Organization ID API

Sample INPUT

// Query params

{
  "organization_id": "string"
}

Sample OUTPUT

{
  "message": "Organization ID",
  "response": [
    {
      "organization_address": {
        "organization_area": "string",
        "organization_city": "string",
        "organization_country": "string",
        "organization_geolocation": {
          "lat": 0,
          "long": 0
        },
        "organization_state": "string",
        "organization_street": "string",
        "organization_unit": "string",
        "organization_zip": "string"
      },
      "organization_description": "string",
      "organization_icon": "string",
      "organization_id": "string",
      "organization_key": "string",
      "organization_name": "string",
      "organization_website": "string"
    }
  ],
  "response_code": 200
}

Authorizations:

OAuth2Password

query Parameters

organization_id required

string Organization ID

Responses

https://localhost:8000/api/v1/organization/id

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": {

  • "organization_address": {

    • "organization_area": "string",
    • "organization_city": "string",
    • "organization_country": "string",
    • "organization_geolocation": {

      • "lat": 0,
      • "long": 0

      },
    • "organization_state": "string",
    • "organization_street": "string",
    • "organization_unit": "string",
    • "organization_zip": "string"

    },
  • "organization_description": "string",
  • "organization_icon": "string",
  • "organization_id": "string",
  • "organization_key": "string",
  • "organization_name": "string",
  • "organization_website": "string"

  },
• "response_code": 0

}

Organization List

Organization List API

Sample OUTPUT

{
  "message": "string",
  "response": [
    {
      "organization_address": {
        "organization_area": "string",
        "organization_city": "string",
        "organization_country": "string",
        "organization_geolocation": {
          "lat": 0,
          "long": 0
        },
        "organization_state": "string",
        "organization_street": "string",
        "organization_unit": "string",
        "organization_zip": "string"
      },
      "organization_description": "string",
      "organization_icon": "string",
      "organization_id": "string",
      "organization_key": "string",
      "organization_name": "string",
      "organization_website": "string"
    }
  ],
  "response_code": 0
}

Authorizations:

OAuth2Password

Responses

https://localhost:8000/api/v1/organization/list

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": [

  • {

    • "organization_address": {

      • "organization_area": "string",
      • "organization_city": "string",
      • "organization_country": "string",
      • "organization_geolocation": {

        • "lat": 0,
        • "long": 0

        },
      • "organization_state": "string",
      • "organization_street": "string",
      • "organization_unit": "string",
      • "organization_zip": "string"

      },
    • "organization_description": "string",
    • "organization_icon": "string",
    • "organization_id": "string",
    • "organization_key": "string",
    • "organization_name": "string",
    • "organization_website": "string"

    }

  ],
• "response_code": 0

}

Organization Update

Organization Update API

Sample INPUT

{
  "organization_address": {
    "organization_area": "string",
    "organization_city": "string",
    "organization_country": "string",
    "organization_geolocation": {
      "lat": 0,
      "long": 0
    },
    "organization_state": "string",
    "organization_street": "string",
    "organization_unit": "string",
    "organization_zip": "string"
  },
  "organization_description": "string",
  "organization_icon": "string",
  "organization_id": "string",
  "organization_key": "string",
  "organization_name": "string",
  "organization_website": "string"
}

Sample OUTPUT

{
  "message": "Organization updated",
  "response": null,
  "response_code": 200
}

Authorizations:

OAuth2Password

Request Body schema: application/json

Organization Update Payload

required	object (organization.organizationAddress)
organization_description required	string
organization_icon required	string
organization_id required	string
organization_key required	string
organization_name required	string
organization_website required	string

Responses

https://localhost:8000/api/v1/organization/update

Request samples

• Payload

Content type

application/json

{

• "organization_address": {

  • "organization_area": "string",
  • "organization_city": "string",
  • "organization_country": "string",
  • "organization_geolocation": {

    • "lat": 0,
    • "long": 0

    },
  • "organization_state": "string",
  • "organization_street": "string",
  • "organization_unit": "string",
  • "organization_zip": "string"

  },
• "organization_description": "string",
• "organization_icon": "string",
• "organization_id": "string",
• "organization_key": "string",
• "organization_name": "string",
• "organization_website": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": null,
• "response_code": 0

}

Device

Device Create

Device Create API

Sample INPUT

    {
  "device_identifier": "string",
  "device_name": "string",
  "device_streams": [
    {
      "address": "string",
      "fps": {
        "input": 0
      },
      "id": 0,
      "password": "string",
      "port": 0,
      "protocol": "string",
      "resolution": {
        "height": 0,
        "width": 0
      },
      "type": "string",
      "username": "string",
      "uuid": "string"
    }
  ],
  "device_tags": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "device_type": "string",
  "device_uuid": "string",
  "site_id": "string"
}

Sample OUTPUT

{
  "message": "Device created",
  "response": {
    "device_id": "string"
  },
  "response_code": 201
}

Authorizations:

OAuth2Password

Request Body schema: application/json

Device Create Payload

device_identifier required	string
device_name required	string
	Array of objects (device.deviceStream) [ items ]
required	object
device_type required	string
device_uuid	string
site_id required	string

Responses

https://localhost:8000/api/v1/device/create

Request samples

• Payload

Content type

application/json

{

• "device_identifier": "string",
• "device_name": "string",
• "device_streams": [

  • {

    • "address": "string",
    • "fps": {

      • "input": 0

      },
    • "id": 0,
    • "password": "string",
    • "port": 0,
    • "protocol": "string",
    • "resolution": {

      • "height": 0,
      • "width": 0

      },
    • "type": "string",
    • "username": "string",
    • "uuid": "string"

    }

  ],
• "device_tags": {

  • "property1": "string",
  • "property2": "string"

  },
• "device_type": "string",
• "device_uuid": "string",
• "site_id": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": {

  • "device_id": "string"

  },
• "response_code": 0

}

Device Delete

Device Delete API

Sample INPUT

{
    "device_id": "string"
}

Sample OUTPUT

{
    "message": "Device deleted",
    "response": null,
    "response_code": 200
}

Authorizations:

OAuth2Password

Request Body schema: application/json

Device Delete Payload

device_id required

string

Responses

https://localhost:8000/api/v1/device/delete

Request samples

• Payload

Content type

application/json

{

• "device_id": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": null,
• "response_code": 0

}

Device ID

Device ID API

Sample INPUT

// Query params

{
  "device_id": "string"
}

Sample OUTPUT

{
  "message": "Device ID",
  "response": {
    "device_id": "string",
    "device_identifier": "string",
    "device_name": "string",
    "device_source": [
      {
        "source_address": "string",
        "source_channels": [
          {
            "channel_favorite": true,
            "channel_id": "string",
            "channel_key": "string",
            "channel_name": "string",
            "channel_sid": "string",
            "channel_threshold_duration": 0,
            "is_active": true,
            "is_storage": true,
            "is_verified": true,
            "nimble_id": "string",
            "pipeline_id": "string",
            "source_id": "string",
            "usecase_icon": "string",
            "usecase_id": "string",
            "usecase_key": "string",
            "usecase_meta_key": [
              "string"
            ],
            "usecase_name": "string"
          }
        ],
        "source_fps": 0,
        "source_id": "string",
        "source_name": "string",
        "source_sid": 0,
        "source_type": "string"
      }
    ],
    "device_state": true,
    "device_status": "string",
    "device_streams": [
      {
        "address": "string",
        "fps": {
          "input": 0
        },
        "id": 0,
        "password": "string",
        "port": 0,
        "protocol": "string",
        "resolution": {
          "height": 0,
          "width": 0
        },
        "type": "string",
        "username": "string",
        "uuid": "string"
      }
    ],
    "device_tags": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    },
    "device_type": "string",
    "device_uuid": "string",
    "device_value": "string",
    "site_id": "string",
    "source_channels": [
      {
        "channel_favorite": true,
        "channel_id": "string",
        "channel_key": "string",
        "channel_name": "string",
        "channel_sid": "string",
        "channel_threshold_duration": 0,
        "is_active": true,
        "is_storage": true,
        "is_verified": true,
        "nimble_id": "string",
        "pipeline_id": "string",
        "source_id": "string",
        "usecase_icon": "string",
        "usecase_id": "string",
        "usecase_key": "string",
        "usecase_meta_key": [
          "string"
        ],
        "usecase_name": "string"
      }
    ]
  },
  "response_code": 200
}

Authorizations:

OAuth2Password

query Parameters

device_id required

string Device ID

Responses

https://localhost:8000/api/v1/device/id

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": {

  • "device_id": "string",
  • "device_identifier": "string",
  • "device_name": "string",
  • "device_source": [

    • {

      • "source_address": "string",
      • "source_channels": [

        • {

          • "channel_favorite": true,
          • "channel_id": "string",
          • "channel_key": "string",
          • "channel_name": "string",
          • "channel_sid": "string",
          • "channel_threshold_duration": 0,
          • "is_active": true,
          • "is_storage": true,
          • "is_verified": true,
          • "nimble_id": "string",
          • "pipeline_id": "string",
          • "source_id": "string",
          • "usecase_icon": "string",
          • "usecase_id": "string",
          • "usecase_key": "string",
          • "usecase_meta_key": [

            • "string"

            ],
          • "usecase_name": "string"

          }

        ],
      • "source_fps": 0,
      • "source_id": "string",
      • "source_name": "string",
      • "source_sid": 0,
      • "source_type": "string"

      }

    ],
  • "device_state": true,
  • "device_status": "string",
  • "device_streams": [

    • {

      • "address": "string",
      • "fps": {

        • "input": 0

        },
      • "id": 0,
      • "password": "string",
      • "port": 0,
      • "protocol": "string",
      • "resolution": {

        • "height": 0,
        • "width": 0

        },
      • "type": "string",
      • "username": "string",
      • "uuid": "string"

      }

    ],
  • "device_tags": {

    • "property1": "string",
    • "property2": "string"

    },
  • "device_type": "string",
  • "device_uuid": "string",
  • "device_value": "string",
  • "site_id": "string",
  • "source_channels": [

    • {

      • "channel_favorite": true,
      • "channel_id": "string",
      • "channel_key": "string",
      • "channel_name": "string",
      • "channel_sid": "string",
      • "channel_threshold_duration": 0,
      • "is_active": true,
      • "is_storage": true,
      • "is_verified": true,
      • "nimble_id": "string",
      • "pipeline_id": "string",
      • "source_id": "string",
      • "usecase_icon": "string",
      • "usecase_id": "string",
      • "usecase_key": "string",
      • "usecase_meta_key": [

        • "string"

        ],
      • "usecase_name": "string"

      }

    ]

  },
• "response_code": 0

}

Device List

Device List API

Sample INPUT

// Query params

{
  "site_id": "string"
}

Sample OUTPUT

{
  "message": "Device List",
  "response": [
    {
      "device_id": "string",
      "device_identifier": "string",
      "device_name": "string",
      "device_source": [
        {
          "source_address": "string",
          "source_channels": [
            {
              "channel_favorite": true,
              "channel_id": "string",
              "channel_key": "string",
              "channel_name": "string",
              "channel_sid": "string",
              "channel_threshold_duration": 0,
              "is_active": true,
              "is_storage": true,
              "is_verified": true,
              "nimble_id": "string",
              "pipeline_id": "string",
              "source_id": "string",
              "usecase_icon": "string",
              "usecase_id": "string",
              "usecase_key": "string",
              "usecase_meta_key": [
                "string"
              ],
              "usecase_name": "string"
            }
          ],
          "source_fps": 0,
          "source_id": "string",
          "source_name": "string",
          "source_sid": 0,
          "source_type": "string"
        }
      ],
      "device_state": true,
      "device_status": "string",
      "device_streams": [
        {
          "address": "string",
          "fps": {
            "input": 0
          },
          "id": 0,
          "password": "string",
          "port": 0,
          "protocol": "string",
          "resolution": {
            "height": 0,
            "width": 0
          },
          "type": "string",
          "username": "string",
          "uuid": "string"
        }
      ],
      "device_tags": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "device_type": "string",
      "device_uuid": "string",
      "device_value": "string",
      "site_id": "string",
      "source_channels": [
        {
          "channel_favorite": true,
          "channel_id": "string",
          "channel_key": "string",
          "channel_name": "string",
          "channel_sid": "string",
          "channel_threshold_duration": 0,
          "is_active": true,
          "is_storage": true,
          "is_verified": true,
          "nimble_id": "string",
          "pipeline_id": "string",
          "source_id": "string",
          "usecase_icon": "string",
          "usecase_id": "string",
          "usecase_key": "string",
          "usecase_meta_key": [
            "string"
          ],
          "usecase_name": "string"
        }
      ]
    }
  ],
  "response_code": 200
}

Authorizations:

OAuth2Password

query Parameters

site_id required

string Site ID

Responses

https://localhost:8000/api/v1/device/list

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": [

  • {

    • "device_id": "string",
    • "device_identifier": "string",
    • "device_name": "string",
    • "device_source": [

      • {

        • "source_address": "string",
        • "source_channels": [

          • {

            • "channel_favorite": true,
            • "channel_id": "string",
            • "channel_key": "string",
            • "channel_name": "string",
            • "channel_sid": "string",
            • "channel_threshold_duration": 0,
            • "is_active": true,
            • "is_storage": true,
            • "is_verified": true,
            • "nimble_id": "string",
            • "pipeline_id": "string",
            • "source_id": "string",
            • "usecase_icon": "string",
            • "usecase_id": "string",
            • "usecase_key": "string",
            • "usecase_meta_key": [

              • "string"

              ],
            • "usecase_name": "string"

            }

          ],
        • "source_fps": 0,
        • "source_id": "string",
        • "source_name": "string",
        • "source_sid": 0,
        • "source_type": "string"

        }

      ],
    • "device_state": true,
    • "device_status": "string",
    • "device_streams": [

      • {

        • "address": "string",
        • "fps": {

          • "input": 0

          },
        • "id": 0,
        • "password": "string",
        • "port": 0,
        • "protocol": "string",
        • "resolution": {

          • "height": 0,
          • "width": 0

          },
        • "type": "string",
        • "username": "string",
        • "uuid": "string"

        }

      ],
    • "device_tags": {

      • "property1": "string",
      • "property2": "string"

      },
    • "device_type": "string",
    • "device_uuid": "string",
    • "device_value": "string",
    • "site_id": "string",
    • "source_channels": [

      • {

        • "channel_favorite": true,
        • "channel_id": "string",
        • "channel_key": "string",
        • "channel_name": "string",
        • "channel_sid": "string",
        • "channel_threshold_duration": 0,
        • "is_active": true,
        • "is_storage": true,
        • "is_verified": true,
        • "nimble_id": "string",
        • "pipeline_id": "string",
        • "source_id": "string",
        • "usecase_icon": "string",
        • "usecase_id": "string",
        • "usecase_key": "string",
        • "usecase_meta_key": [

          • "string"

          ],
        • "usecase_name": "string"

        }

      ]

    }

  ],
• "response_code": 0

}

Device Update

Device Update API

Sample INPUT

{
  "device_id": "string",
  "device_identifier": "string",
  "device_name": "string",
  "device_source": [
    {
      "source_address": "string",
      "source_channels": [
        {
          "channel_favorite": true,
          "channel_id": "string",
          "channel_key": "string",
          "channel_name": "string",
          "channel_sid": "string",
          "channel_threshold_duration": 0,
          "is_active": true,
          "is_storage": true,
          "is_verified": true,
          "nimble_id": "string",
          "pipeline_id": "string",
          "source_id": "string",
          "usecase_icon": "string",
          "usecase_id": "string",
          "usecase_key": "string",
          "usecase_meta_key": [
            "string"
          ],
          "usecase_name": "string"
        }
      ],
      "source_fps": 0,
      "source_id": "string",
      "source_name": "string",
      "source_sid": 0,
      "source_type": "string"
    }
  ],
  "device_state": true,
  "device_status": "string",
  "device_streams": [
    {
      "address": "string",
      "fps": {
        "input": 0
      },
      "id": 0,
      "password": "string",
      "port": 0,
      "protocol": "string",
      "resolution": {
        "height": 0,
        "width": 0
      },
      "type": "string",
      "username": "string",
      "uuid": "string"
    }
  ],
  "device_tags": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "device_type": "string",
  "device_uuid": "string",
  "device_value": "string",
  "site_id": "string",
  "source_channels": [
    {
      "channel_favorite": true,
      "channel_id": "string",
      "channel_key": "string",
      "channel_name": "string",
      "channel_sid": "string",
      "channel_threshold_duration": 0,
      "is_active": true,
      "is_storage": true,
      "is_verified": true,
      "nimble_id": "string",
      "pipeline_id": "string",
      "source_id": "string",
      "usecase_icon": "string",
      "usecase_id": "string",
      "usecase_key": "string",
      "usecase_meta_key": [
        "string"
      ],
      "usecase_name": "string"
    }
  ]
}

Sample OUTPUT

{
"message": "Device Updated",
"response": null,
"response_code": 200
}

Authorizations:

OAuth2Password

Request Body schema: application/json

Device Update Payload

device_id required	string
device_identifier required	string
device_name required	string
	Array of objects (device.deviceStream) [ items ]
required	object
device_type required	string
device_uuid	string
site_id required	string

Responses

https://localhost:8000/api/v1/device/update

Request samples

• Payload

Content type

application/json

{

• "device_id": "string",
• "device_identifier": "string",
• "device_name": "string",
• "device_streams": [

  • {

    • "address": "string",
    • "fps": {

      • "input": 0

      },
    • "id": 0,
    • "password": "string",
    • "port": 0,
    • "protocol": "string",
    • "resolution": {

      • "height": 0,
      • "width": 0

      },
    • "type": "string",
    • "username": "string",
    • "uuid": "string"

    }

  ],
• "device_tags": {

  • "property1": "string",
  • "property2": "string"

  },
• "device_type": "string",
• "device_uuid": "string",
• "site_id": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": null,
• "response_code": 0

}

Device List

Device View API

Sample INPUT

// Query params

{
  "device_id": "string"
}

Sample OUTPUT

{
  "message": "Device view",
  "response": {
    "site_id": "string",
    "device_uuid": "string",
    "device_name": "string",
    "device_type": "string",
    "device_identifier": "string",
    "device_tags": {
      "tag": "string",
      "device_streams": [
        {
          "id": "string",
          "uuid": "string",
          "fps": {
            "input": "string"
          },
          "type": "string",
          "protocol": "string",
          "address": "string",
          "port": "string",
          "username": "string",
          "password": "string",
          "resolution": {
            "width": 0,
            "height": 0
          }
        }
      ]
    }
  },
  "response_code": 200
}

Authorizations:

OAuth2Password

query Parameters

device_id required

string Device ID

Responses

https://localhost:8000/api/v1/device/view

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": {

  • "device_id": "string",
  • "device_identifier": "string",
  • "device_name": "string",
  • "device_source": [

    • {

      • "source_address": "string",
      • "source_channels": [

        • {

          • "channel_favorite": true,
          • "channel_id": "string",
          • "channel_key": "string",
          • "channel_name": "string",
          • "channel_sid": "string",
          • "channel_threshold_duration": 0,
          • "is_active": true,
          • "is_storage": true,
          • "is_verified": true,
          • "nimble_id": "string",
          • "pipeline_id": "string",
          • "source_id": "string",
          • "usecase_icon": "string",
          • "usecase_id": "string",
          • "usecase_key": "string",
          • "usecase_meta_key": [

            • "string"

            ],
          • "usecase_name": "string"

          }

        ],
      • "source_fps": 0,
      • "source_id": "string",
      • "source_name": "string",
      • "source_sid": 0,
      • "source_type": "string"

      }

    ],
  • "device_state": true,
  • "device_status": "string",
  • "device_streams": [

    • {

      • "address": "string",
      • "fps": {

        • "input": 0

        },
      • "id": 0,
      • "password": "string",
      • "port": 0,
      • "protocol": "string",
      • "resolution": {

        • "height": 0,
        • "width": 0

        },
      • "type": "string",
      • "username": "string",
      • "uuid": "string"

      }

    ],
  • "device_tags": {

    • "property1": "string",
    • "property2": "string"

    },
  • "device_type": "string",
  • "device_uuid": "string",
  • "device_value": "string",
  • "site_id": "string",
  • "source_channels": [

    • {

      • "channel_favorite": true,
      • "channel_id": "string",
      • "channel_key": "string",
      • "channel_name": "string",
      • "channel_sid": "string",
      • "channel_threshold_duration": 0,
      • "is_active": true,
      • "is_storage": true,
      • "is_verified": true,
      • "nimble_id": "string",
      • "pipeline_id": "string",
      • "source_id": "string",
      • "usecase_icon": "string",
      • "usecase_id": "string",
      • "usecase_key": "string",
      • "usecase_meta_key": [

        • "string"

        ],
      • "usecase_name": "string"

      }

    ],
  • "device_sources": [

    • {

      • "source_address": "string",
      • "source_channels": [

        • {

          • "channel_favorite": true,
          • "channel_id": "string",
          • "channel_key": "string",
          • "channel_name": "string",
          • "channel_sid": "string",
          • "channel_threshold_duration": 0,
          • "is_active": true,
          • "is_storage": true,
          • "is_verified": true,
          • "nimble_id": "string",
          • "pipeline_id": "string",
          • "source_id": "string",
          • "usecase_icon": "string",
          • "usecase_id": "string",
          • "usecase_key": "string",
          • "usecase_meta_key": [

            • "string"

            ],
          • "usecase_name": "string"

          }

        ],
      • "source_fps": 0,
      • "source_id": "string",
      • "source_name": "string",
      • "source_sid": 0,
      • "source_type": "string"

      }

    ]

  },
• "response_code": 0

}

StaticContent

Static Content Create

Static Create API

Sample INPUT

{
  "device_id": "string",
  "id": 0,
  "static_content_data": {
    "additionalProp1": {}
  },
  "static_content_name": "string",
  "static_content_type": "string"
}

Sample OUTPUT

{
    "message": "Zone created",
    "response": null,
    "response_code": 201
}

Authorizations:

OAuth2Password

Request Body schema: application/json

Static Content Payload

device_id required	string
id required	integer
required	object
static_content_name required	string
static_content_type required	string

Responses

https://localhost:8000/api/v1/device/static/create

Request samples

• Payload

Content type

application/json

{

• "device_id": "string",
• "id": 0,
• "static_content_data": { },
• "static_content_name": "string",
• "static_content_type": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": null,
• "response_code": 0

}

Static Content Delete

Static Delete API

Sample INPUT

{
  "static_content_id": "string"
}

Sample OUTPUT

{
    "message": "Static Content Deleted",
    "response": null,
    "response_code": 200
}

Authorizations:

OAuth2Password

Request Body schema: application/json

Static Content Payload

static_content_id required

string

Responses

https://localhost:8000/api/v1/device/static/delete

Request samples

• Payload

Content type

application/json

{

• "static_content_id": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": null,
• "response_code": 0

}

Static Content ID

Static ID API

Sample INPUT

// Query params

{
  "static_content_id": "string"
}

Sample OUTPUT

{
    "message": "Zone created",
    "response": {
      "device_id": "string",
      "id": 0,
      "static_content_data": {
        "additionalProp1": {}
      },
      "static_content_name": "string",
      "static_content_type": "string"
    },
    "response_code": 201
}

Authorizations:

OAuth2Password

query Parameters

static_id required

string Static ID

Responses

https://localhost:8000/api/v1/device/static/id

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": {

  • "device_id": "string",
  • "id": 0,
  • "static_content_data": { },
  • "static_content_id": "string",
  • "static_content_name": "string",
  • "static_content_type": "string"

  },
• "response_code": 0

}

Static Content List

Static List API

Sample INPUT

// Query params

{
  "device_id": "string"
}

Sample OUTPUT

{
  "message": "Zone List",
  "response": [
    {
      "device_id": "string",
      "id": 0,
      "static_content_data": {
        "additionalProp1": {}
      },
      "static_content_name": "string",
      "static_content_type": "string"
    }
  ],
  "response_code": 201
}

Authorizations:

OAuth2Password

query Parameters

device_id required

string Device ID

Responses

https://localhost:8000/api/v1/device/static/list

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": [

  • {

    • "device_id": "string",
    • "id": 0,
    • "static_content_data": { },
    • "static_content_id": "string",
    • "static_content_name": "string",
    • "static_content_type": "string"

    }

  ],
• "response_code": 0

}

Static Content Update

Static Update API

Sample INPUT

{
  "device_id": "string",
  "id": 0,
  "static_content_data": {
    "additionalProp1": {}
  },
  "static_content_name": "string",
  "static_content_type": "string"
}

Sample OUTPUT

{
    "message": "Zone updated",
    "response": null,
    "response_code": 201
}

Authorizations:

OAuth2Password

Request Body schema: application/json

Static Content Payload

device_id required	string
id required	integer
required	object
static_content_id required	string
static_content_name required	string
static_content_type required	string

Responses

https://localhost:8000/api/v1/device/static/update

Request samples

• Payload

Content type

application/json

{

• "device_id": "string",
• "id": 0,
• "static_content_data": { },
• "static_content_id": "string",
• "static_content_name": "string",
• "static_content_type": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": null,
• "response_code": 0

}

Generic

Asset Upload Image

Takes in a file as part of a multipart form and stores the file

Authorizations:

OAuth2Password

query Parameters

path required

string Path

Responses

https://localhost:8000/api/v1/generic/asset

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": null,
• "response_code": 0

}

Get Secure Image

Takes in a file as part of a multipart form and stores the file

Authorizations:

OAuth2Password

query Parameters

path required	string Asset Path
type required	string Asset Type

Responses

https://localhost:8000/api/v1/generic/asset/secure

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": null,
• "response_code": 0

}

Upload Image

Takes in a file as part of a multipart form and stores the file

Authorizations:

OAuth2Password

Request Body schema: application/json

Accepts .jpg

string

Responses

https://localhost:8000/api/v1/generic/upload

Request samples

• Payload

Content type

application/json

"string"

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": null,
• "response_code": 0

}

Setting

Nimble Configuration Status

Nimble Conf Get API

Sample OUTPUT

{
  "message": "string",
  "response": {},
  "response_code": 0
}

Authorizations:

OAuth2Password

Responses

https://localhost:8000/api/v1/nimble/config

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": null,
• "response_code": 0

}

Nimble Configuration Update

Nimble Conf Update API

Sample INPUT

{
  "nimble_host": "string",
  "site_key": "string"
}

Sample OUTPUT

{
  "message": "string",
  "response": {},
  "response_code": 0
}

Authorizations:

OAuth2Password

Request Body schema: application/json

Nimble Config Set Payload

nimble_host	string
site_key	string

Responses

https://localhost:8000/api/v1/nimble/config

Request samples

• Payload

Content type

application/json

{

• "nimble_host": "string",
• "site_key": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": null,
• "response_code": 0

}

List Nimble Configuration

Nimble List API

Sample OUTPUT

{
  "message": "string",
  "response": [
    {
      "nimble_address": "string",
      "nimble_api_version": "string",
      "nimble_created_at": "string",
      "nimble_hash": "string",
      "nimble_host_name": "string",
      "nimble_id": "string",
      "nimble_is_active": true,
      "nimble_is_secure": true,
      "nimble_is_statistics": true,
      "nimble_name": "string",
      "nimble_port": 0,
      "nimble_routes": {
        "additionalProp1": {}
      },
      "nimble_status": 0,
      "nimble_updated_at": "string",
      "nimble_version": "string",
      "site_id": "string",
      "site_key": "string"
    }
  ],
  "response_code": 0
}

Authorizations:

OAuth2Password

query Parameters

site_ids required

boolean Site ID

Responses

https://localhost:8000/api/v1/nimble/list

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": [

  • {

    • "nimble_address": "string",
    • "nimble_api_version": "string",
    • "nimble_created_at": "string",
    • "nimble_hash": "string",
    • "nimble_host_name": "string",
    • "nimble_id": "string",
    • "nimble_is_active": true,
    • "nimble_is_secure": true,
    • "nimble_is_statistics": true,
    • "nimble_name": "string",
    • "nimble_port": 0,
    • "nimble_routes": { },
    • "nimble_status": 0,
    • "nimble_updated_at": "string",
    • "nimble_version": "string",
    • "site_id": "string",
    • "site_key": "string"

    }

  ],
• "response_code": 0

}

Nimble Stats

Nimble Stats API

Sample OUTPUT

{
  "message": "string",
  "response": {
    "nimble_id": "string",
    "nimble_stats": [
      {
        "cpu": 0,
        "mem_physical": 0,
        "mem_virtual": 0,
        "time": "string"
      }
    ],
    "nimble_uptime": 0
  },
  "response_code": 0
}

Authorizations:

OAuth2Password

query Parameters

nimble_id required

boolean Nimble ID

Responses

https://localhost:8000/api/v1/nimble/stats

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": {

  • "nimble_id": "string",
  • "nimble_stats": [

    • {

      • "cpu": 0,
      • "mem_physical": 0,
      • "mem_virtual": 0,
      • "time": "string"

      }

    ],
  • "nimble_uptime": 0

  },
• "response_code": 0

}

Pipeline

Pipeline Create

Pipeline Create API

Sample INPUT

{
  "nimble_id": "string",
  "pipeline_elements": [
    {}
  ],
  "pipeline_name": "string",
  "pipeline_source": [
    0
  ],
  "pipeline_usecase": "string"
}

Sample OUTPUT

{
  "message": "Pipeline created",
  "response": null,
  "response_code": 201
}

Authorizations:

OAuth2Password

Request Body schema: application/json

Pipeline Create Payload

nimble_id required	string
pipeline_elements required	Array of any[ items ]
pipeline_name required	string
pipeline_source required	Array of integers[ items ]
pipeline_usecase required	string

Responses

https://localhost:8000/api/v1/pipeline/create

Request samples

• Payload

Content type

application/json

{

• "nimble_id": "string",
• "pipeline_elements": [

  • null

  ],
• "pipeline_name": "string",
• "pipeline_source": [

  • 0

  ],
• "pipeline_usecase": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": null,
• "response_code": 0

}

Default Pipeline Element Information

Pipeline Defaults API

Sample INPUT

// Query params

{
  "usecase_key": "string"
}

Sample OUTPUT

{
  "message": "Default Pipeline Elements",
  "response": {
    "default_data": {
      "additionalProp1": {}
    }
  },
  "response_code": 200
}

Authorizations:

OAuth2Password

query Parameters

usecase_key required

string UseCase Key

Responses

https://localhost:8000/api/v1/pipeline/defaults

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": {

  • "default_data": { }

  },
• "response_code": 0

}

Pipeline Delete

Pipeline Delete API

Sample INPUT

{
  "pipeline_id": "string"
}

Sample OUTPUT

{
  "message": "Pipeline deleted",
  "response": null,
  "response_code": 200
}

Authorizations:

OAuth2Password

Request Body schema: application/json

Pipeline Delete Payload

pipeline_id required

string

Responses

https://localhost:8000/api/v1/pipeline/delete

Request samples

• Payload

Content type

application/json

{

• "pipeline_id": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": null,
• "response_code": 0

}

Pipeline ID

Pipeline ID API

Sample INPUT

// Query params

{
  "pipeline_id": "string"
}

Sample OUTPUT

{
  "message": "Pipeline ID",
  "response": {
    "nimble_id": "string",
    "pipeline_elements": [
      {}
    ],
    "pipeline_id": "string",
    "pipeline_name": "string",
    "pipeline_source": [
      0
    ],
    "pipeline_usecase": "string"
  },
  "response_code": 200
}

Authorizations:

OAuth2Password

query Parameters

pipeline_id required

string Pipeline ID

Responses

https://localhost:8000/api/v1/pipeline/id

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": {

  • "nimble_id": "string",
  • "pipeline_elements": [

    • null

    ],
  • "pipeline_id": "string",
  • "pipeline_name": "string",
  • "pipeline_source": [

    • 0

    ],
  • "pipeline_usecase": "string"

  },
• "response_code": 0

}

Pipeline Element Information

Pipeline Info API

Sample OUTPUT

{
  "message": "Pipeline Info",
  "response": {},
  "response_code": 200
}

Authorizations:

OAuth2Password

Responses

https://localhost:8000/api/v1/pipeline/info

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": null,
• "response_code": 0

}

Pipeline List

Pipeline List API

Sample OUTPUT

{
  "message": "Pipeline List",
  "response": [
    {
      "nimble_id": "string",
      "pipeline_elements": [
        {}
      ],
      "pipeline_id": "string",
      "pipeline_name": "string",
      "pipeline_source": [
        0
      ],
      "pipeline_usecase": "string"
    }
  ],
  "response_code": 200
}

Authorizations:

OAuth2Password

Responses

https://localhost:8000/api/v1/pipeline/list

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": [

  • {

    • "nimble_id": "string",
    • "pipeline_elements": [

      • null

      ],
    • "pipeline_id": "string",
    • "pipeline_name": "string",
    • "pipeline_source": [

      • 0

      ],
    • "pipeline_usecase": "string"

    }

  ],
• "response_code": 0

}

Pipeline Update

Pipeline Update API

Sample INPUT

{
  "nimble_id": "string",
  "pipeline_elements": [
    {}
  ],
  "pipeline_name": "string",
  "pipeline_source": [
    0
  ],
  "pipeline_usecase": "string"
}

Sample OUTPUT

{
  "message": "Pipeline updated",
  "response": null,
  "response_code": 200
}

Authorizations:

OAuth2Password

Request Body schema: application/json

Pipeline Update Payload

nimble_id required	string
pipeline_elements required	Array of any[ items ]
pipeline_name required	string
pipeline_source required	Array of integers[ items ]
pipeline_usecase required	string

Responses

https://localhost:8000/api/v1/pipeline/update

Request samples

• Payload

Content type

application/json

{

• "nimble_id": "string",
• "pipeline_elements": [

  • null

  ],
• "pipeline_name": "string",
• "pipeline_source": [

  • 0

  ],
• "pipeline_usecase": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": null,
• "response_code": 0

}

Role

Role List

Role List

Sample OUTPUT

{
  "message": "Roles List",
  "response": [
    {
      "role_id": "string",
      "role_key": "string",
      "role_name": "string"
    }
  ],
  "response_code": 200
}

Authorizations:

OAuth2Password

Responses

https://localhost:8000/api/v1/role/list

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": [

  • {

    • "role_id": "string",
    • "role_key": "string",
    • "role_name": "string"

    }

  ],
• "response_code": 0

}

Schedule

Schedule Create

Schedule Create API

Sample INPUT

{
  "alert_id": "string",
  "channel_id": "string",
  "schedule_name": "string",
  "schedule_occurrence": [
    {
      "occurrence_activate_cron": "string",
      "occurrence_constraint": "string",
      "occurrence_deactivate_cron": "string",
      "occurrence_end_time": "string",
      "occurrence_id": 0,
      "occurrence_is_allday": true,
      "occurrence_start_time": "string"
    }
  ],
  "schedule_type": "string"
}

Sample OUTPUT

{
  "message": "Schedule created",
  "response": null,
  "response_code": 201
}

Authorizations:

OAuth2Password

Request Body schema: application/json

Schedule Create Payload

alert_id required	string
channel_id required	string
schedule_name required	string
required	Array of objects (schedule.scheduleOccurrence) [ items ]
schedule_type	string

Responses

https://localhost:8000/api/v1/schedule/create

Request samples

• Payload

Content type

application/json

{

• "alert_id": "string",
• "channel_id": "string",
• "schedule_name": "string",
• "schedule_occurrence": [

  • {

    • "occurrence_activate_cron": "string",
    • "occurrence_constraint": "string",
    • "occurrence_deactivate_cron": "string",
    • "occurrence_end_time": "string",
    • "occurrence_id": 0,
    • "occurrence_is_allday": true,
    • "occurrence_start_time": "string"

    }

  ],
• "schedule_type": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": null,
• "response_code": 0

}

Schedule Delete

Schedule Delete API

Sample INPUT

{
  "schedule_id": "string"
}

Sample OUTPUT

{
  "message": "Schedule deleted",
  "response": null,
  "response_code": 200
}

Authorizations:

OAuth2Password

Request Body schema: application/json

Schedule Delete Payload

schedule_id required

string

Responses

https://localhost:8000/api/v1/schedule/delete

Request samples

• Payload

Content type

application/json

{

• "schedule_id": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": null,
• "response_code": 0

}

Schedule ID

Schedule ID API

Sample INPUT

{
  "schedule_id": "string"
}

Sample OUTPUT

{
  "message": "Schedule ID",
  "response": {
    "alert_id": "string",
    "channel_id": "string",
    "is_active": true,
    "schedule_id": "string",
    "schedule_name": "string",
    "schedule_occurrence": [
      {
        "occurrence_activate_cron": "string",
        "occurrence_constraint": "string",
        "occurrence_deactivate_cron": "string",
        "occurrence_end_time": "string",
        "occurrence_id": 0,
        "occurrence_is_allday": true,
        "occurrence_start_time": "string"
      }
    ],
    "schedule_type": "string"
  },
  "response_code": 200
}

Authorizations:

OAuth2Password

Request Body schema: application/json

Schedule ID Payload

schedule_id required

string

Responses

https://localhost:8000/api/v1/schedule/id

Request samples

• Payload

Content type

application/json

{

• "schedule_id": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": {

  • "alert_id": "string",
  • "channel_id": "string",
  • "is_active": true,
  • "schedule_id": "string",
  • "schedule_name": "string",
  • "schedule_occurrence": [

    • {

      • "occurrence_activate_cron": "string",
      • "occurrence_constraint": "string",
      • "occurrence_deactivate_cron": "string",
      • "occurrence_end_time": "string",
      • "occurrence_id": 0,
      • "occurrence_is_allday": true,
      • "occurrence_start_time": "string"

      }

    ],
  • "schedule_type": "string"

  },
• "response_code": 0

}

Schedule List by Channel ID

Schedule List By Channel ID API

Sample INPUT

{
  "channel_id": "string"
}

Sample OUTPUT

{
  "message": "Schedule List",
  "response": {
    "alert_id": "string",
    "channel_id": "string",
    "is_active": true,
    "schedule_id": "string",
    "schedule_name": "string",
    "schedule_occurrence": [
      {
        "occurrence_activate_cron": "string",
        "occurrence_constraint": "string",
        "occurrence_deactivate_cron": "string",
        "occurrence_end_time": "string",
        "occurrence_id": 0,
        "occurrence_is_allday": true,
        "occurrence_start_time": "string"
      }
    ],
    "schedule_type": "string"
  },
  "response_code": 200
}

Authorizations:

OAuth2Password

Request Body schema: application/json

Schedule List Payload

channel_id required

string

Responses

https://localhost:8000/api/v1/schedule/list

Request samples

• Payload

Content type

application/json

{

• "channel_id": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": {

  • "alert_id": "string",
  • "channel_id": "string",
  • "is_active": true,
  • "schedule_id": "string",
  • "schedule_name": "string",
  • "schedule_occurrence": [

    • {

      • "occurrence_activate_cron": "string",
      • "occurrence_constraint": "string",
      • "occurrence_deactivate_cron": "string",
      • "occurrence_end_time": "string",
      • "occurrence_id": 0,
      • "occurrence_is_allday": true,
      • "occurrence_start_time": "string"

      }

    ],
  • "schedule_type": "string"

  },
• "response_code": 0

}

Schedule Update

Schedule Update API

Sample INPUT

{
  "alert_id": "string",
  "channel_id": "string",
  "schedule_id": "string",
  "schedule_name": "string",
  "schedule_occurrence": [
    {
      "occurrence_activate_cron": "string",
      "occurrence_constraint": "string",
      "occurrence_deactivate_cron": "string",
      "occurrence_end_time": "string",
      "occurrence_id": 0,
      "occurrence_is_allday": true,
      "occurrence_start_time": "string"
    }
  ],
  "schedule_type": "string"
}

Sample OUTPUT

{
  "message": "Schedule updated",
  "response": {
    "alert_id": "string",
    "channel_id": "string",
    "is_active": true,
    "schedule_id": "string",
    "schedule_name": "string",
    "schedule_occurrence": [
      {
        "occurrence_activate_cron": "string",
        "occurrence_constraint": "string",
        "occurrence_deactivate_cron": "string",
        "occurrence_end_time": "string",
        "occurrence_id": 0,
        "occurrence_is_allday": true,
        "occurrence_start_time": "string"
      }
    ],
    "schedule_type": "string"
  },
  "response_code": 200
}

Authorizations:

OAuth2Password

Request Body schema: application/json

Schedule Update Payload

alert_id required	string
channel_id required	string
schedule_id required	string
schedule_name required	string
required	Array of objects (schedule.scheduleOccurrence) [ items ]
schedule_type	string

Responses

https://localhost:8000/api/v1/schedule/update

Request samples

• Payload

Content type

application/json

{

• "alert_id": "string",
• "channel_id": "string",
• "schedule_id": "string",
• "schedule_name": "string",
• "schedule_occurrence": [

  • {

    • "occurrence_activate_cron": "string",
    • "occurrence_constraint": "string",
    • "occurrence_deactivate_cron": "string",
    • "occurrence_end_time": "string",
    • "occurrence_id": 0,
    • "occurrence_is_allday": true,
    • "occurrence_start_time": "string"

    }

  ],
• "schedule_type": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": {

  • "alert_id": "string",
  • "channel_id": "string",
  • "is_active": true,
  • "schedule_id": "string",
  • "schedule_name": "string",
  • "schedule_occurrence": [

    • {

      • "occurrence_activate_cron": "string",
      • "occurrence_constraint": "string",
      • "occurrence_deactivate_cron": "string",
      • "occurrence_end_time": "string",
      • "occurrence_id": 0,
      • "occurrence_is_allday": true,
      • "occurrence_start_time": "string"

      }

    ],
  • "schedule_type": "string"

  },
• "response_code": 0

}

Site

Site Create

Site Create API

Sample INPUT

{
  "customer_id": "string",
  "organization_id": "string",
  "site_address": {
    "site_area": "string",
    "site_city": "string",
    "site_country": "string",
    "site_geolocation": {
      "lat": 0,
      "long": 0
    },
    "site_state": "string",
    "site_street": "string",
    "site_unit": "string",
    "site_zip": "string"
  },
  "site_description": "string",
  "site_icon": "string",
  "site_image": "string",
  "site_key": "string",
  "site_name": "string",
  "site_type": "string"
}

Sample OUTPUT

{
  "message": "Site Created",
  "response": null,
  "response_code": 201
}

Authorizations:

OAuth2Password

Request Body schema: application/json

Site Create Payload

customer_id required	string
organization_id required	string
required	object (site.siteAddress)
site_description required	string
site_icon required	string
site_image required	string
site_key required	string
site_name required	string
site_type required	string

Responses

https://localhost:8000/api/v1/site/create

Request samples

• Payload

Content type

application/json

{

• "customer_id": "string",
• "organization_id": "string",
• "site_address": {

  • "site_area": "string",
  • "site_city": "string",
  • "site_country": "string",
  • "site_geolocation": {

    • "lat": 0,
    • "long": 0

    },
  • "site_state": "string",
  • "site_street": "string",
  • "site_unit": "string",
  • "site_zip": "string"

  },
• "site_description": "string",
• "site_icon": "string",
• "site_image": "string",
• "site_key": "string",
• "site_name": "string",
• "site_type": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": null,
• "response_code": 0

}

Site Delete

Site Delete API

Sample INPUT

{
  "site_id": "string"
}

Sample OUTPUT

{
  "message": "Site Deleted",
  "response": null,
  "response_code": 200
}

Authorizations:

OAuth2Password

Request Body schema: application/json

Site Delete Payload

site_id required

string

Responses

https://localhost:8000/api/v1/site/delete

Request samples

• Payload

Content type

application/json

{

• "site_id": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": null,
• "response_code": 0

}

Site ID

Site Id API

Sample INPUT

// Query params

{
  "site_id": "string"
}

Sample OUTPUT

{
  "message": "Site ID",
  "response": {
    "site_address": {
      "site_area": "string",
      "site_city": "string",
      "site_country": "string",
      "site_geolocation": {
        "lat": 0,
        "long": 0
      },
      "site_state": "string",
      "site_street": "string",
      "site_unit": "string",
      "site_zip": "string"
    },
    "site_description": "string",
    "site_icon": "string",
    "site_id": "string",
    "site_image": "string",
    "site_key": "string",
    "site_name": "string",
    "site_total_devices": 0,
    "site_type": "string"
  },
  "response_code": 200
}

Authorizations:

OAuth2Password

query Parameters

site_id required

string Site ID

Responses

https://localhost:8000/api/v1/site/id

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": {

  • "site_address": {

    • "site_area": "string",
    • "site_city": "string",
    • "site_country": "string",
    • "site_geolocation": {

      • "lat": 0,
      • "long": 0

      },
    • "site_state": "string",
    • "site_street": "string",
    • "site_unit": "string",
    • "site_zip": "string"

    },
  • "site_description": "string",
  • "site_icon": "string",
  • "site_id": "string",
  • "site_image": "string",
  • "site_key": "string",
  • "site_name": "string",
  • "site_total_devices": 0,
  • "site_type": "string"

  },
• "response_code": 0

}

Sites List

Site List API

Sample INPUT

// Query params

{
  "customer_id": "string"
}

Sample OUTPUT

{
  "message": "Site List",
  "response": [
    {
      "site_address": {
        "site_area": "string",
        "site_city": "string",
        "site_country": "string",
        "site_geolocation": {
          "lat": 0,
          "long": 0
        },
        "site_state": "string",
        "site_street": "string",
        "site_unit": "string",
        "site_zip": "string"
      },
      "site_description": "string",
      "site_icon": "string",
      "site_id": "string",
      "site_image": "string",
      "site_key": "string",
      "site_name": "string",
      "site_total_devices": 0,
      "site_type": "string"
    }
  ],
  "response_code": 200
}

Authorizations:

OAuth2Password

query Parameters

customer_id required

string Customer ID

Responses

https://localhost:8000/api/v1/site/list

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": [

  • {

    • "site_address": {

      • "site_area": "string",
      • "site_city": "string",
      • "site_country": "string",
      • "site_geolocation": {

        • "lat": 0,
        • "long": 0

        },
      • "site_state": "string",
      • "site_street": "string",
      • "site_unit": "string",
      • "site_zip": "string"

      },
    • "site_description": "string",
    • "site_icon": "string",
    • "site_id": "string",
    • "site_image": "string",
    • "site_key": "string",
    • "site_name": "string",
    • "site_total_devices": 0,
    • "site_type": "string"

    }

  ],
• "response_code": 0

}

Site Update

Site Update API

Sample INPUT

{
  "customer_id": "string",
  "site_address": {
    "site_area": "string",
    "site_city": "string",
    "site_country": "string",
    "site_geolocation": {
      "lat": 0,
      "long": 0
    },
    "site_state": "string",
    "site_street": "string",
    "site_unit": "string",
    "site_zip": "string"
  },
  "site_description": "string",
  "site_icon": "string",
  "site_id": "string",
  "site_image": "string",
  "site_key": "string",
  "site_name": "string",
  "site_total_devices": 0,
  "site_type": "string"
}

Sample OUTPUT

{
  "message": "Site Updated",
  "response": null,
  "response_code": 200
}

Authorizations:

OAuth2Password

Request Body schema: application/json

Site Update Payload

customer_id required	string
organization_id required	string
required	object (site.siteAddress)
site_description required	string
site_icon required	string
site_id required	string
site_image required	string
site_key required	string
site_name required	string
site_type required	string

Responses

https://localhost:8000/api/v1/site/update

Request samples

• Payload

Content type

application/json

{

• "customer_id": "string",
• "organization_id": "string",
• "site_address": {

  • "site_area": "string",
  • "site_city": "string",
  • "site_country": "string",
  • "site_geolocation": {

    • "lat": 0,
    • "long": 0

    },
  • "site_state": "string",
  • "site_street": "string",
  • "site_unit": "string",
  • "site_zip": "string"

  },
• "site_description": "string",
• "site_icon": "string",
• "site_id": "string",
• "site_image": "string",
• "site_key": "string",
• "site_name": "string",
• "site_type": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": null,
• "response_code": 0

}

Site ID

Site View API

Sample INPUT

// Query params

{
  "site_id": "string"
}

Sample OUTPUT

{
  "message": "Site view",
  "response": {
    "site_address": {
      "site_area": "string",
      "site_city": "string",
      "site_country": "string",
      "site_geolocation": {
        "lat": 0,
        "long": 0
      },
      "site_state": "string",
      "site_street": "string",
      "site_unit": "string",
      "site_zip": "string"
    },
    "site_description": "string",
    "site_devices": [
      {
        "device_id": "string",
        "device_identifier": "string",
        "device_name": "string",
        "device_source": [
          {
            "source_address": "string",
            "source_fps": 0,
            "source_id": "string",
            "source_name": "string",
            "source_sid": 0,
            "source_type": "string"
          }
        ],
        "device_state": true,
        "device_status": "string",
        "device_tags": {
          "additionalProp1": "string",
          "additionalProp2": "string",
          "additionalProp3": "string"
        },
        "device_type": "string",
        "device_uuid": "string",
        "device_value": "string",
        "source_channels": [
          {
            "channel_favorite": true,
            "channel_id": "string",
            "channel_key": "string",
            "channel_name": "string",
            "channel_sid": "string",
            "channel_threshold_duration": 0,
            "device_id": "string",
            "is_active": true,
            "is_storage": true,
            "is_verified": true,
            "nimble_id": "string",
            "pipeline_id": "string",
            "source_id": "string",
            "usecase_icon": "string",
            "usecase_id": "string",
            "usecase_key": "string",
            "usecase_meta_key": [
              "string"
            ],
            "usecase_name": "string"
          }
        ]
      }
    ],
    "site_icon": "string",
    "site_id": "string",
    "site_image": "string",
    "site_key": "string",
    "site_name": "string",
    "site_type": "string"
  },
  "response_code": 200
}

Authorizations:

OAuth2Password

query Parameters

site_id required

string Site ID

Responses

https://localhost:8000/api/v1/site/view

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": {

  • "site_address": {

    • "site_area": "string",
    • "site_city": "string",
    • "site_country": "string",
    • "site_geolocation": {

      • "lat": 0,
      • "long": 0

      },
    • "site_state": "string",
    • "site_street": "string",
    • "site_unit": "string",
    • "site_zip": "string"

    },
  • "site_description": "string",
  • "site_devices": [

    • {

      • "device_id": "string",
      • "device_identifier": "string",
      • "device_name": "string",
      • "device_source": [

        • {

          • "source_address": "string",
          • "source_fps": 0,
          • "source_id": "string",
          • "source_name": "string",
          • "source_sid": 0,
          • "source_type": "string"

          }

        ],
      • "device_state": true,
      • "device_status": "string",
      • "device_tags": {

        • "property1": "string",
        • "property2": "string"

        },
      • "device_type": "string",
      • "device_uuid": "string",
      • "device_value": "string",
      • "source_channels": [

        • {

          • "channel_favorite": true,
          • "channel_id": "string",
          • "channel_key": "string",
          • "channel_name": "string",
          • "channel_sid": "string",
          • "channel_threshold_duration": 0,
          • "device_id": "string",
          • "is_active": true,
          • "is_storage": true,
          • "is_verified": true,
          • "nimble_id": "string",
          • "pipeline_id": "string",
          • "source_id": "string",
          • "usecase_icon": "string",
          • "usecase_id": "string",
          • "usecase_key": "string",
          • "usecase_meta_key": [

            • "string"

            ],
          • "usecase_name": "string"

          }

        ]

      }

    ],
  • "site_icon": "string",
  • "site_id": "string",
  • "site_image": "string",
  • "site_key": "string",
  • "site_name": "string",
  • "site_type": "string"

  },
• "response_code": 0

}

Source

Source Create

Source Create API

Sample INPUT

{
  "device_id": "string",
  "nimble_id": "string",
  "source_address": "string",
  "source_fps": 0,
  "source_name": "string",
  "source_type": "string",
  "static_content": [
    {
      "additionalProp1": {}
    }
  ]
}

Sample OUTPUT

{
  "message": "Source Created",
  "response": null,
  "response_code": 201
}

Authorizations:

OAuth2Password

Request Body schema: application/json

Source Create Payload

device_id required	string
nimble_id required	string
source_address required	string
source_fps required	number
source_name required	string
source_type required	string
	Array of objects[ items ]

Responses

https://localhost:8000/api/v1/source/create

Request samples

• Payload

Content type

application/json

{

• "device_id": "string",
• "nimble_id": "string",
• "source_address": "string",
• "source_fps": 0,
• "source_name": "string",
• "source_type": "string",
• "static_content": [

  • { }

  ]

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": null,
• "response_code": 0

}

Source Delete

Source Delete API

Sample INPUT

{
  "source_id": "string"
}

Sample OUTPUT

{
  "message": "Source Deleted",
  "response": null,
  "response_code": 200
}

Authorizations:

OAuth2Password

Request Body schema: application/json

Source Delete Payload

source_id required

string

Responses

https://localhost:8000/api/v1/source/delete

Request samples

• Payload

Content type

application/json

{

• "source_id": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": null,
• "response_code": 0

}

Source ID

Source ID API

Sample INPUT

// Query params

{
  "source_id": "string"
}

Sample OUTPUT

{
  "message": "Source ID",
  "response": {
    "device_id": "string",
    "nimble_id": "string",
    "source_address": "string",
    "source_channels": [
      {
        "channel_favorite": true,
        "channel_id": "string",
        "channel_key": "string",
        "channel_name": "string",
        "channel_sid": "string",
        "channel_threshold_duration": 0,
        "is_active": true,
        "is_storage": true,
        "is_verified": true,
        "nimble_id": "string",
        "pipeline_id": "string",
        "source_id": "string",
        "usecase_icon": "string",
        "usecase_id": "string",
        "usecase_key": "string",
        "usecase_meta_key": [
          "string"
        ],
        "usecase_name": "string"
      }
    ],
    "source_fps": 0,
    "source_id": "string",
    "source_name": "string",
    "source_type": "string",
    "static_content": [
      {
        "additionalProp1": {}
      }
    ]
  },
  "response_code": 200
}

Authorizations:

OAuth2Password

query Parameters

source_id required

string Source ID

Responses

https://localhost:8000/api/v1/source/id

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": {

  • "device_id": "string",
  • "nimble_id": "string",
  • "source_address": "string",
  • "source_channels": [

    • {

      • "channel_favorite": true,
      • "channel_id": "string",
      • "channel_key": "string",
      • "channel_name": "string",
      • "channel_sid": "string",
      • "channel_threshold_duration": 0,
      • "is_active": true,
      • "is_storage": true,
      • "is_verified": true,
      • "nimble_id": "string",
      • "pipeline_id": "string",
      • "source_id": "string",
      • "usecase_icon": "string",
      • "usecase_id": "string",
      • "usecase_key": "string",
      • "usecase_meta_key": [

        • "string"

        ],
      • "usecase_name": "string"

      }

    ],
  • "source_fps": 0,
  • "source_id": "string",
  • "source_name": "string",
  • "source_type": "string",
  • "static_content": [

    • { }

    ]

  },
• "response_code": 0

}

Source List

Source List API

Sample INPUT

// Query params

{
  "device_id": "string"
}

Sample OUTPUT

{
  "message": "Source List",
  "response": [
    {
      "device_id": "string",
      "nimble_id": "string",
      "source_address": "string",
      "source_channels": [
        {
          "channel_favorite": true,
          "channel_id": "string",
          "channel_key": "string",
          "channel_name": "string",
          "channel_sid": "string",
          "channel_threshold_duration": 0,
          "is_active": true,
          "is_storage": true,
          "is_verified": true,
          "nimble_id": "string",
          "pipeline_id": "string",
          "source_id": "string",
          "usecase_icon": "string",
          "usecase_id": "string",
          "usecase_key": "string",
          "usecase_meta_key": [
            "string"
          ],
          "usecase_name": "string"
        }
      ],
      "source_fps": 0,
      "source_id": "string",
      "source_name": "string",
      "source_type": "string",
      "static_content": [
        {
          "additionalProp1": {}
        }
      ]
    }
  ],
  "response_code": 200
}

Authorizations:

OAuth2Password

query Parameters

device_id required

string Device ID

Responses

https://localhost:8000/api/v1/source/list

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": [

  • {

    • "device_id": "string",
    • "nimble_id": "string",
    • "source_address": "string",
    • "source_channels": [

      • {

        • "channel_favorite": true,
        • "channel_id": "string",
        • "channel_key": "string",
        • "channel_name": "string",
        • "channel_sid": "string",
        • "channel_threshold_duration": 0,
        • "is_active": true,
        • "is_storage": true,
        • "is_verified": true,
        • "nimble_id": "string",
        • "pipeline_id": "string",
        • "source_id": "string",
        • "usecase_icon": "string",
        • "usecase_id": "string",
        • "usecase_key": "string",
        • "usecase_meta_key": [

          • "string"

          ],
        • "usecase_name": "string"

        }

      ],
    • "source_fps": 0,
    • "source_id": "string",
    • "source_name": "string",
    • "source_type": "string",
    • "static_content": [

      • { }

      ]

    }

  ],
• "response_code": 0

}

Source Mapping

Source Mapping API

Sample INPUT

// Query params

{
  "is_default": "string",
  "site_id": "string"
}

Sample OUTPUT

{
  "message": "Source List",
  "response": {
    "is_default": true,
    "nimble_address": "string",
    "nimble_hostname": "string",
    "nimble_id": "string",
    "site_id": "string",
    "site_name": "string",
    "sources": [
      {
        "device_id": "string",
        "nimble_id": "string",
        "source_address": "string",
        "source_channels": [
          {
            "channel_favorite": true,
            "channel_id": "string",
            "channel_key": "string",
            "channel_name": "string",
            "channel_sid": "string",
            "channel_threshold_duration": 0,
            "is_active": true,
            "is_storage": true,
            "is_verified": true,
            "nimble_id": "string",
            "pipeline_id": "string",
            "source_id": "string",
            "usecase_icon": "string",
            "usecase_id": "string",
            "usecase_key": "string",
            "usecase_meta_key": [
              "string"
            ],
            "usecase_name": "string"
          }
        ],
        "source_fps": 0,
        "source_id": "string",
        "source_name": "string",
        "source_type": "string",
        "static_content": [
          {
            "additionalProp1": {}
          }
        ]
      }
    ]
  },
  "response_code": 200
}

Authorizations:

OAuth2Password

query Parameters

is_default required	string Include Default Site
site_id	string Specific Site data

Responses

https://localhost:8000/api/v1/source/mapping

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": {

  • "is_default": true,
  • "nimble_address": "string",
  • "nimble_hostname": "string",
  • "nimble_id": "string",
  • "site_id": "string",
  • "site_name": "string",
  • "sources": [

    • {

      • "device_id": "string",
      • "nimble_id": "string",
      • "source_address": "string",
      • "source_channels": [

        • {

          • "channel_favorite": true,
          • "channel_id": "string",
          • "channel_key": "string",
          • "channel_name": "string",
          • "channel_sid": "string",
          • "channel_threshold_duration": 0,
          • "is_active": true,
          • "is_storage": true,
          • "is_verified": true,
          • "nimble_id": "string",
          • "pipeline_id": "string",
          • "source_id": "string",
          • "usecase_icon": "string",
          • "usecase_id": "string",
          • "usecase_key": "string",
          • "usecase_meta_key": [

            • "string"

            ],
          • "usecase_name": "string"

          }

        ],
      • "source_fps": 0,
      • "source_id": "string",
      • "source_name": "string",
      • "source_type": "string",
      • "static_content": [

        • { }

        ]

      }

    ]

  },
• "response_code": 0

}

Source Update

Source Update API

Sample INPUT

{
  "device_id": "string",
  "nimble_id": "string",
  "source_address": "string",
  "source_fps": 0,
  "source_name": "string",
  "source_type": "string",
  "static_content": [
    {
      "additionalProp1": {}
    }
  ]
}

Sample OUTPUT

{
  "message": "Source Updated",
  "response": {
    "device_id": "string",
    "nimble_id": "string",
    "source_address": "string",
    "source_channels": [
      {
        "channel_favorite": true,
        "channel_id": "string",
        "channel_key": "string",
        "channel_name": "string",
        "channel_sid": "string",
        "channel_threshold_duration": 0,
        "is_active": true,
        "is_storage": true,
        "is_verified": true,
        "nimble_id": "string",
        "pipeline_id": "string",
        "source_id": "string",
        "usecase_icon": "string",
        "usecase_id": "string",
        "usecase_key": "string",
        "usecase_meta_key": [
          "string"
        ],
        "usecase_name": "string"
      }
    ],
    "source_fps": 0,
    "source_id": "string",
    "source_name": "string",
    "source_type": "string",
    "static_content": [
      {
        "additionalProp1": {}
      }
    ]
  },
  "response_code": 200
}

Authorizations:

OAuth2Password

Request Body schema: application/json

Source Update Payload

device_id required	string
nimble_id required	string
source_address required	string
source_fps required	number
source_name required	string
source_type required	string
	Array of objects[ items ]

Responses

https://localhost:8000/api/v1/source/update

Request samples

• Payload

Content type

application/json

{

• "device_id": "string",
• "nimble_id": "string",
• "source_address": "string",
• "source_fps": 0,
• "source_name": "string",
• "source_type": "string",
• "static_content": [

  • { }

  ]

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": {

  • "device_id": "string",
  • "nimble_id": "string",
  • "source_address": "string",
  • "source_channels": [

    • {

      • "channel_favorite": true,
      • "channel_id": "string",
      • "channel_key": "string",
      • "channel_name": "string",
      • "channel_sid": "string",
      • "channel_threshold_duration": 0,
      • "is_active": true,
      • "is_storage": true,
      • "is_verified": true,
      • "nimble_id": "string",
      • "pipeline_id": "string",
      • "source_id": "string",
      • "usecase_icon": "string",
      • "usecase_id": "string",
      • "usecase_key": "string",
      • "usecase_meta_key": [

        • "string"

        ],
      • "usecase_name": "string"

      }

    ],
  • "source_fps": 0,
  • "source_id": "string",
  • "source_name": "string",
  • "source_type": "string",
  • "static_content": [

    • { }

    ]

  },
• "response_code": 0

}

Status

Status Check

Status Check

Sample OUTPUT

 {
  "message": "STS Status",
  "response": {
    "is_onboarding": true,
    "nimble_module": true,
    "sms_module": true,
    "smtp_module": true,
    "storage_module": true,
    "websocket_module": true
  },
  "response_code": 200
}

Responses

https://localhost:8000/api/v1/status

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": {

  • "is_onboarding": true,
  • "nimble_module": true,
  • "sms_module": true,
  • "smtp_module": true,
  • "storage_module": true,
  • "websocket_module": true

  },
• "response_code": 0

}

UseCase

UseCase Assign

Usecase Assign API

Sample INPUT

{
  "usecase_id": [
    "string"
  ],
  "user_id": "string"
}

Sample OUTPUT

 {
  "message": "Usecase assigned",
  "response": null,
  "response_code": 200
}

Authorizations:

OAuth2Password

Request Body schema: application/json

UseCase Assign Payload

usecase_id required	Array of strings
user_id required	string

Responses

https://localhost:8000/api/v1/usecase/assign

Request samples

• Payload

Content type

application/json

{

• "usecase_id": [

  • "string"

  ],
• "user_id": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": null,
• "response_code": 0

}

UseCase Create

Usecase Create API

Sample INPUT

{
  "usecase_background_color": "string",
  "usecase_channel_count": 0,
  "usecase_component_key": "string",
  "usecase_desc": "string",
  "usecase_icon": "string",
  "usecase_key": "string",
  "usecase_meta_key": [
    "string"
  ],
  "usecase_name": "string"
}

Sample OUTPUT

 {
  "message": "Usecase created",
  "response": null,
  "response_code": 201
}

Authorizations:

OAuth2Password

Request Body schema: application/json

UseCase Create Payload

usecase_background_color	string
usecase_channel_count	integer
usecase_component_key	string
usecase_desc	string
usecase_icon	string
usecase_key	string
usecase_meta_key	Array of strings
usecase_name	string

Responses

https://localhost:8000/api/v1/usecase/create

Request samples

• Payload

Content type

application/json

{

• "usecase_background_color": "string",
• "usecase_channel_count": 0,
• "usecase_component_key": "string",
• "usecase_desc": "string",
• "usecase_icon": "string",
• "usecase_key": "string",
• "usecase_meta_key": [

  • "string"

  ],
• "usecase_name": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": null,
• "response_code": 0

}

UseCase Delete

Usecase Delete API

Sample INPUT

{
  "usecase_id": "string"
}

Sample OUTPUT

 {
  "message": "Usecase deleted",
  "response": null,
  "response_code": 200
}

Authorizations:

OAuth2Password

Request Body schema: application/json

UseCase Delete Payload

usecase_id required

string

Responses

https://localhost:8000/api/v1/usecase/delete

Request samples

• Payload

Content type

application/json

{

• "usecase_id": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": null,
• "response_code": 0

}

UseCase ID

Usecase ID API

Sample INPUT

// Query params

{
  "usecase_id": "string"
}

Sample OUTPUT

 {
  "message": "Usecase deleted",
  "response": {
    "usecase_background_color": "string",
    "usecase_channel_count": 0,
    "usecase_component_key": "string",
    "usecase_desc": "string",
    "usecase_icon": "string",
    "usecase_id": "string",
    "usecase_key": "string",
    "usecase_meta_key": [
      "string"
    ],
    "usecase_name": "string"
  },
  "response_code": 200
}

Authorizations:

OAuth2Password

query Parameters

usecase_id required

string UseCase ID

Responses

https://localhost:8000/api/v1/usecase/id

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": {

  • "usecase_background_color": "string",
  • "usecase_channel_count": 0,
  • "usecase_component_key": "string",
  • "usecase_desc": "string",
  • "usecase_icon": "string",
  • "usecase_id": "string",
  • "usecase_key": "string",
  • "usecase_meta_key": [

    • "string"

    ],
  • "usecase_name": "string"

  },
• "response_code": 0

}

UseCase List

Usecase List API

Sample OUTPUT

 {
  "message": "Usecase list",
  "response": [
    {
      "usecase_background_color": "string",
      "usecase_channel_count": 0,
      "usecase_component_key": "string",
      "usecase_desc": "string",
      "usecase_icon": "string",
      "usecase_id": "string",
      "usecase_key": "string",
      "usecase_meta_key": [
        "string"
      ],
      "usecase_name": "string"
    }
  ],
  "response_code": 200
}

Authorizations:

OAuth2Password

Responses

https://localhost:8000/api/v1/usecase/list

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": [

  • {

    • "usecase_background_color": "string",
    • "usecase_channel_count": 0,
    • "usecase_component_key": "string",
    • "usecase_desc": "string",
    • "usecase_icon": "string",
    • "usecase_id": "string",
    • "usecase_key": "string",
    • "usecase_meta_key": [

      • "string"

      ],
    • "usecase_name": "string"

    }

  ],
• "response_code": 0

}

UseCase UnAssign

Usecase UnAssign API

Sample INPUT

{
  "usecase_id": [
    "string"
  ],
  "user_id": "string"
}

Sample OUTPUT

 {
  "message": "Usecase un-assigned",
  "response": null,
  "response_code": 200
}

Authorizations:

OAuth2Password

Request Body schema: application/json

UseCase UnAssign Payload

usecase_id required	Array of strings
user_id required	string

Responses

https://localhost:8000/api/v1/usecase/unassign

Request samples

• Payload

Content type

application/json

{

• "usecase_id": [

  • "string"

  ],
• "user_id": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": null,
• "response_code": 0

}

UseCase Update

Usecase Update API

Sample INPUT

{
  "usecase_background_color": "string",
  "usecase_channel_count": 0,
  "usecase_component_key": "string",
  "usecase_desc": "string",
  "usecase_icon": "string",
  "usecase_id": "string",
  "usecase_key": "string",
  "usecase_meta_key": [
    "string"
  ],
  "usecase_name": "string"
}

Sample OUTPUT

 {
  "message": "Usecase updated",
  "response": null,
  "response_code": 200
}

Authorizations:

OAuth2Password

Request Body schema: application/json

UseCase Update Payload

usecase_background_color	string
usecase_channel_count	integer
usecase_component_key	string
usecase_desc	string
usecase_icon	string
usecase_key	string
usecase_name	string

Responses

https://localhost:8000/api/v1/usecase/update

Request samples

• Payload

Content type

application/json

{

• "usecase_background_color": "string",
• "usecase_channel_count": 0,
• "usecase_component_key": "string",
• "usecase_desc": "string",
• "usecase_icon": "string",
• "usecase_key": "string",
• "usecase_name": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": null,
• "response_code": 0

}

Channel

Channel ChannelAssign

Channel Assign API

Sample INPUT

{
  "channel_id": [
    "string"
  ],
  "user_id": "string"
}

Sample OUTPUT

 {
  "message": "Channel assigned",
  "response": null,
  "response_code": 200
}

Authorizations:

OAuth2Password

Request Body schema: application/json

Channel ChannelAssign Payload

channel_id required	Array of strings
user_id required	string

Responses

https://localhost:8000/api/v1/usecase/channel/assign

Request samples

• Payload

Content type

application/json

{

• "channel_id": [

  • "string"

  ],
• "user_id": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": null,
• "response_code": 0

}

Channel ChannelCreate

Channel Create API

Sample INPUT

{
  "channel_name": "string",
  "channel_sid": "string",
  "channel_threshold": "string",
  "channel_threshold_duration": 0,
  "usecase_key": "string"
}

Sample OUTPUT

 {
  "message": "Channel Created",
  "response": null,
  "response_code": 201
}

Authorizations:

OAuth2Password

Request Body schema: application/json

Channel ChannelCreate Payload

channel_name required	string
channel_sid required	string
channel_threshold required	string
channel_threshold_duration	integer
usecase_key required	string

Responses

https://localhost:8000/api/v1/usecase/channel/create

Request samples

• Payload

Content type

application/json

{

• "channel_name": "string",
• "channel_sid": "string",
• "channel_threshold": "string",
• "channel_threshold_duration": 0,
• "usecase_key": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": null,
• "response_code": 0

}

Channel ChannelDelete

Channel Delete API

Sample INPUT

{
  "channel_id": "string"
}

Sample OUTPUT

 {
  "message": "Channel Deleted",
  "response": null,
  "response_code": 200
}

Authorizations:

OAuth2Password

Request Body schema: application/json

Channel ChannelDelete Payload

channel_id required

string

Responses

https://localhost:8000/api/v1/usecase/channel/delete

Request samples

• Payload

Content type

application/json

{

• "channel_id": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": null,
• "response_code": 0

}

Channel ID

Channel ID API

Sample INPUT

// Query params

{
  "channel_id": "string"
}

Sample OUTPUT

 {
  "message": "Channel ID",
  "response": {
    "channel_favorite": true,
    "channel_id": "string",
    "channel_key": "string",
    "channel_name": "string",
    "channel_sid": "string",
    "channel_threshold": "string",
    "channel_threshold_duration": 0,
    "is_active": true,
    "is_storage": true,
    "is_verified": true,
    "pipeline_id": "string",
    "usecase_key": "string"
  },
  "response_code": 200
}

Authorizations:

OAuth2Password

query Parameters

channel_id required

string Channel ID

Responses

https://localhost:8000/api/v1/usecase/channel/id

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": {

  • "channel_favorite": true,
  • "channel_id": "string",
  • "channel_key": "string",
  • "channel_name": "string",
  • "channel_sid": "string",
  • "channel_threshold": "string",
  • "channel_threshold_duration": 0,
  • "is_active": true,
  • "is_storage": true,
  • "is_verified": true,
  • "pipeline_id": "string",
  • "usecase_key": "string"

  },
• "response_code": 0

}

Channel List

Channel List By Key API

Sample INPUT

// Query params

{
  "usecase_key": "string"
}

Sample OUTPUT

 {
  "message": "Channel List",
  "response": [
    {
      "channel_favorite": true,
      "channel_id": "string",
      "channel_key": "string",
      "channel_name": "string",
      "channel_sid": "string",
      "channel_threshold": "string",
      "channel_threshold_duration": 0,
      "is_active": true,
      "is_storage": true,
      "is_verified": true,
      "pipeline_id": "string",
      "usecase_key": "string"
    }
  ],
  "response_code": 200
}

Authorizations:

OAuth2Password

Request Body schema: application/json

Channel List Payload

usecase_key required

string

Responses

https://localhost:8000/api/v1/usecase/channel/list

Request samples

• Payload

Content type

application/json

{

• "usecase_key": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": [

  • {

    • "channel_favorite": true,
    • "channel_id": "string",
    • "channel_key": "string",
    • "channel_name": "string",
    • "channel_sid": "string",
    • "channel_threshold": "string",
    • "channel_threshold_duration": 0,
    • "is_active": true,
    • "is_storage": true,
    • "is_verified": true,
    • "pipeline_id": "string",
    • "usecase_key": "string"

    }

  ],
• "response_code": 0

}

Channel Status

Channel Status API

Sample INPUT

// Query params

{
  "channel_id": "string"
}

Sample OUTPUT

 {
  "message": "Channel Status",
  "response": {
    "is_active": true,
    "is_storage": true,
    "is_verified": true
  },
  "response_code": 200
}

Authorizations:

OAuth2Password

query Parameters

channel_id required

string Channel ID

Responses

https://localhost:8000/api/v1/usecase/channel/status

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": {

  • "is_active": true,
  • "is_storage": true,
  • "is_verified": true

  },
• "response_code": 0

}

Channel UnAssign

Channel UnAssign API

Sample INPUT

{
  "channel_id": [
    "string"
  ],
  "user_id": "string"
}

Sample OUTPUT

 {
  "message": "Channel un-assigned",
  "response": null,
  "response_code": 200
}

Authorizations:

OAuth2Password

Request Body schema: application/json

Channel UnAssign Payload

channel_id required	Array of strings
user_id required	string

Responses

https://localhost:8000/api/v1/usecase/channel/unassign

Request samples

• Payload

Content type

application/json

{

• "channel_id": [

  • "string"

  ],
• "user_id": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": null,
• "response_code": 0

}

Channel ChannelUpdate

Channel Update API

Sample INPUT

{
  "channel_id": "string",
  "channel_key": "string",
  "channel_name": "string",
  "channel_sid": "string",
  "channel_threshold": "string",
  "channel_threshold_duration": 0,
  "usecase_key": "string"
}

Sample OUTPUT

 {
  "message": "Channel Updated",
  "response": {
    "channel_favorite": true,
    "channel_id": "string",
    "channel_key": "string",
    "channel_name": "string",
    "channel_sid": "string",
    "channel_threshold": "string",
    "channel_threshold_duration": 0,
    "is_active": true,
    "is_storage": true,
    "is_verified": true,
    "pipeline_id": "string",
    "usecase_key": "string"
  },
  "response_code": 200
}

Authorizations:

OAuth2Password

Request Body schema: application/json

Channel ChannelUpdate Payload

channel_id required	string
channel_key required	string
channel_name	string
channel_sid	string
channel_threshold	string
channel_threshold_duration	integer
usecase_key required	string

Responses

https://localhost:8000/api/v1/usecase/channel/update

Request samples

• Payload

Content type

application/json

{

• "channel_id": "string",
• "channel_key": "string",
• "channel_name": "string",
• "channel_sid": "string",
• "channel_threshold": "string",
• "channel_threshold_duration": 0,
• "usecase_key": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "message": "string",
• "response": {

  • "channel_favorite": true,
  • "channel_id": "string",
  • "channel_key": "string",
  • "channel_name": "string",
  • "channel_sid": "string",
  • "channel_threshold": "string",
  • "channel_threshold_duration": 0,
  • "is_active": true,
  • "is_storage": true,
  • "is_verified": true,
  • "pipeline_id": "string",
  • "usecase_key": "string"

  },
• "response_code": 0

}