docs.swisshomeguard.com Open in urlscan Pro
54.196.33.224  Public Scan

URL: https://docs.swisshomeguard.com/
Submission: On March 01 via automatic, source certstream-suspicious — Scanned from DE

Form analysis 0 forms found in the DOM

Text Content

 * Body
 * Headers (16)

 * Body
 * Headers (16)

 * Body
 * Headers (16)




Public


Documentation Settings
ENVIRONMENT
Production

LAYOUT
Single Column

LANGUAGE
cURL - cURL


Public API
Introduction
GET
System
PATCH
Recording
PATCH
Alarm
PATCH
Siren
PATCH
Schedule


PUBLIC API

Public API to be used by developers that wha to integrate SHG into their own
solution.

AUTHORIZATIONBearer Token
Token

<token>


GETSYSTEM


https://dev-api.swisshomeguard.com/v1/system
AUTHORIZATIONBearer Token
Token

<token>

HEADERS
Accept

application/json

PARAMS
alarm

schedule

recording

Example Request
200 - JSON

curl


curl --location 'https://dev-api.swisshomeguard.com/v1/system' \
--header 'Accept: application/json'

Example Response
 * Body
 * Headers (16)

View More
javascript


{
  "data": {
    "system_name": "D0001043-01",
    "recording": false,
    "alarm": false,
    "schedule": false,
    "siren": false,
    "can_update": {
      "recording": true,
      "alarm": true,
      "schedule": true,
      "siren": true
    }
  }
}

Server

nginx

Content-Type

application/json

Transfer-Encoding

chunked

Vary

Accept-Encoding

Cache-Control

no-cache, private

Date

Mon, 25 Jul 2022 14:48:45 GMT

X-Debug-Db-Scope

SCOPE_PUBLIC

X-Debug-Route-Name

public-api.v1.system.index

X-Debug-Route-Action

App\Http\Controllers\PublicApi\v1\SystemController@index

X-Debug-Ver

2022.07.251431 / 325da7f6

X-Debug-Included-Files

524

Access-Control-Allow-Headers

Origin, Content-Type, Accept, Authorization, X-Requested-With, Application,
Cache-Control, If-Modified-Since, ETag, X-Socket-ID, X-CSRF-TOKEN, X-XSRF-TOKEN

Access-Control-Allow-Credentials

true

X-Req-Time

0.013

X-Hostname

svd-dkr0048

Content-Encoding

gzip


PATCHRECORDING


https://dev-api.swisshomeguard.com/v1/system/recording/
AUTHORIZATIONBearer Token
Token

<token>

HEADERS
Accept

application/json

Example Request
200 - JSON

curl


curl --location --request PATCH 'https://dev-api.swisshomeguard.com/v1/system/recording/' \
--header 'Accept: application/json' \
--data '{
    "state": true
}'

Example Response
 * Body
 * Headers (16)

View More
javascript


{
  "data": {
    "system_name": "D0001043-01",
    "recording": true,
    "alarm": false,
    "schedule": false,
    "siren": false,
    "can_update": {
      "recording": true,
      "alarm": true,
      "schedule": true,
      "siren": true
    }
  }
}

Server

nginx

Content-Type

application/json

Transfer-Encoding

chunked

Vary

Accept-Encoding

Cache-Control

no-cache, private

Date

Mon, 25 Jul 2022 14:51:34 GMT

X-Debug-Db-Scope

SCOPE_PUBLIC

X-Debug-Route-Name

public-api.v1.system.recording.update

X-Debug-Route-Action

App\Http\Controllers\PublicApi\v1\SystemController@updateRecording

X-Debug-Ver

2022.07.251431 / 325da7f6

X-Debug-Included-Files

550

Access-Control-Allow-Headers

Origin, Content-Type, Accept, Authorization, X-Requested-With, Application,
Cache-Control, If-Modified-Since, ETag, X-Socket-ID, X-CSRF-TOKEN, X-XSRF-TOKEN

Access-Control-Allow-Credentials

true

X-Req-Time

0.021

X-Hostname

svd-dkr0048

Content-Encoding

gzip


PATCHALARM


https://dev-api.swisshomeguard.com/v1/system/alarm-central
AUTHORIZATIONBearer Token
Token

<token>

HEADERS
Accept

application/json

Bodyraw (json)
json


{
    "state": true
}

Example Request
200 - JSON

curl


curl --location --request PATCH 'https://dev-api.swisshomeguard.com/v1/system/alarm' \
--header 'Accept: application/json' \
--data '{
    "state": true

}'

Example Response
 * Body
 * Headers (16)

View More
javascript


{
  "data": {
    "system_name": "D0001043-01",
    "recording": true,
    "alarm": true,
    "schedule": false,
    "siren": false,
    "can_update": {
      "recording": false,
      "alarm": true,
      "schedule": true,
      "siren": true
    }
  }
}

Server

nginx

Content-Type

application/json

Transfer-Encoding

chunked

Vary

Accept-Encoding

Cache-Control

no-cache, private

Date

Mon, 25 Jul 2022 14:54:39 GMT

X-Debug-Db-Scope

SCOPE_PUBLIC

X-Debug-Route-Name

public-api.v1.system.alarm.update

X-Debug-Route-Action

App\Http\Controllers\PublicApi\v1\SystemController@updateAlarm

X-Debug-Ver

2022.07.251431 / 325da7f6

X-Debug-Included-Files

550

Access-Control-Allow-Headers

Origin, Content-Type, Accept, Authorization, X-Requested-With, Application,
Cache-Control, If-Modified-Since, ETag, X-Socket-ID, X-CSRF-TOKEN, X-XSRF-TOKEN

Access-Control-Allow-Credentials

true

X-Req-Time

0.015

X-Hostname

svd-dkr0048

Content-Encoding

gzip