API | REST | OpenAPI¶
This page provides searchable REST references and downloadable OpenAPI descriptions for picoScan120 and picoScan150. For REST concepts, authentication, and request patterns, see REST API / OpenAPI.
picoScan150_2.3.3.0R.yaml (Download)
picoScan120_2.3.3.0R.yaml (Download)
Always match the file to your device model and actual firmware version. Function availability can vary by variant and installed software package. Use the reference for your model below; the two models do not share every endpoint.
picoScan150 REST API¶
1 - General
POST /checkCredentials¶
Returns authentication success. For more details see https://github.com/SICKAG/sick_scan_rest_client.
Build the JSON body from the request schema below.
Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
Type: object · Nullable: true
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
PUT /update¶
Transfers a firmware file (.spk.signed) from the file location to the device. The maximum possible file size is 100 MB.
See Firmware Update for the firmware update workflow.
This operation uploads a file or uses a non-JSON body. Use the request media type and upload fields below.
Request body
Media type: application/octet-stream
dataTypeType: string
BinaryType: string
Responses
Status 200
GET /parameterbackup¶
Reads/transfers the backup file (json) from/to the device.
See Configuration Backup and Restore for the parameter backup workflow.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/parameterbackup"Responses
Status 200
Media type: application/json
version | Type: string | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
device identification | Type: string | ||||||||||
checksum | Type: string | ||||||||||
parameters | Type: array Items:
|
PUT /parameterbackup¶
Reads/transfers the backup file (json) from/to the device.
See Configuration Backup and Restore for the parameter backup workflow.
This operation uploads a file or uses a non-JSON body. Use the request media type and upload fields below.
Request body
Media type: multipart/form-data
dateiType: string · Format: binary
Json-File
Responses
Status 200
POST /SetPassword¶
Sets the password for the CoLa A/B interface only. In this example the password for user level: Service (4) is set to - test - (integer value of the password hash - test -). For more details see https://github.com/SICKAG/sick_scan_rest_client.
Editable JSON template
{
"data": {
"siUserLevel": "<integer>",
"udiNewPassword": "<integer>"
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
datasiUserLevelType: integer · Format: int8
udiNewPasswordType: integer · Format: uint32
Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /getChallenge¶
Returns a challenge for the challenge and response authentication method. For more details see https://github.com/SICKAG/sick_scan_rest_client
JSON example
{
"data": {
"user": "Run"
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
datauserFields: E_USER_LEVEL_TYPE
Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader | ||||||||
|---|---|---|---|---|---|---|---|---|---|
challenge |
|
POST /changePassword¶
Sets the password for the REST interface. For more details see https://github.com/SICKAG/sick_scan_rest_client.
JSON example
{
"data": {
"encryptedMessage": [],
"userLevel": "Run"
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
dataencryptedMessageDefault:
[]Type: array · Minimum items: 0 · Maximum items: 96
Items:Type: integer · Format: uint8
userLevelFields: E_USER_LEVEL_TYPE
Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /EnableUserLevel¶
Activates / deactivates a specific user level for the REST interface.
This function requires at least user level: Service.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"userLevel": "<integer>",
"isEnabled": false
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader | ||||
|---|---|---|---|---|---|
data |
|
Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /WriteEeprom¶
Saves all parameters permanently.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
headerFields: PostBodyHeader
Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /SoftReset¶
Reboots the device. All non-saved parameters are lost.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"ProcessorNbr": "<integer>"
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
POST /RebootDevice¶
Reboots the device. All parameters are saved.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
headerFields: PostBodyHeader
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
POST /LoadFactoryDefaults¶
Resets all parameters to default.
This function requires at least user level: Service.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
headerFields: PostBodyHeader
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
POST /LoadApplicationDefaults¶
Resets only the user parametrization of the fields, evaluation cases, and parameters under the section "Application". Other parameters like interface settings, echo filter, etc. remain unchanged. This function requires the user level: Service.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
headerFields: PostBodyHeader
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
POST /EnableLegacyUserLevel¶
Activates / deactivates a specific user level for the CoLa A/B interface.
This function requires at least user level: Service.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"userLevel": "<integer>",
"isEnabled": false
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader | ||||
|---|---|---|---|---|---|
data |
|
Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
GET /laserType¶
Returns the type of the sending unit.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/laserType"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
GET /sipmType¶
Returns the type of the receiving unit.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/sipmType"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /RunFirmwareUpdate¶
Starts the firmware update process.
This function requires at least user level: Service.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
headerFields: PostBodyHeader
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /UpdateState¶
Returns the state of the update process.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/UpdateState"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
GET /CreateParameterBackupResult¶
Returns the current status of the parameter backup process.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/CreateParameterBackupResult"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader | ||||
|---|---|---|---|---|---|
data |
|
GET /RestoreParameterBackupResult¶
Returns the current status of the parameter restoration process.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/RestoreParameterBackupResult"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader | ||||||
|---|---|---|---|---|---|---|---|
data |
|
POST /CreateParameterBackup¶
Creates a parameter backup file on the device.
This function requires at least user level: Service.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"Passphrase": " "
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /RestoreParameterBackup¶
Restores the backup file on the device. The restored parameters will then be applied.
This function requires at least user level: Service.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"Passphrase": " ",
"Filter": 0
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader | ||||
|---|---|---|---|---|---|
data |
|
Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
GET /LFTchecksum¶
Returns a checksum over all software parts and configurations.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/LFTchecksum"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
data |
|
POST /CreateSessionToken¶
A short-lived session token to pass to a HTTP request header.
Build the JSON body from the request schema below.
Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
Type: object · Nullable: true
Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader | ||||
|---|---|---|---|---|---|
data |
|
2 - Status
GET /DeviceStatus¶
Returns the device state (9 possible states).
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/DeviceStatus"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
GET /SCdevicestate¶
Returns the device state (busy, ready, or error).
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/SCdevicestate"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
3 - Device Information
GET /DeviceIdent¶
Returns the device name and the firmware version.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/DeviceIdent"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader | ||||
|---|---|---|---|---|---|
data |
|
GET /LocationName¶
Returns/sets the device name.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/LocationName"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /LocationName¶
Returns/sets the device name.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"LocationName": "not defined"
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /SerialNumber¶
Returns the serial number.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/SerialNumber"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
GET /FirmwareVersion¶
Returns the current firmware version.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/FirmwareVersion"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
GET /OrderNumber¶
Returns the order number (SICK part number).
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/OrderNumber"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
GET /DeviceType¶
Returns the device type.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/DeviceType"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /FindMe¶
Sets the device LEDs into blinking mode for better identification.
Editable JSON template
{
"data": {
"uiDuration": "<integer>"
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
datauiDurationType: integer · Format: uint16 · Minimum: 1
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
4 - Basic Settings
GET /LEDState¶
Returns the LED status.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/LEDState"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
GET /LEDEnable¶
Returns/sets the LED mode (on/off).
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/LEDEnable"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /LEDEnable¶
Returns/sets the LED mode (on/off).
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"LEDEnable": true
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
POST /mStartMeasure¶
Starts motor and measurement.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
headerFields: PostBodyHeader
Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /mStandby¶
Enables/disables the Laser (on/off).
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
headerFields: PostBodyHeader
Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /mStopMeasure¶
Stops motor and measurement.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
headerFields: PostBodyHeader
Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
GET /AutoStartMeasure¶
Returns/sets the mode for automatic start of measurement after boot-up.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/AutoStartMeasure"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /AutoStartMeasure¶
Returns/sets the mode for automatic start of measurement after boot-up.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"AutoStartMeasure": true
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /PerformanceProfileNumber¶
Returns/sets the scan configuration (scanning frequency and angular resolution).
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/PerformanceProfileNumber"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /PerformanceProfileNumber¶
Returns/sets the scan configuration (scanning frequency and angular resolution).
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"PerformanceProfileNumber": 2
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /ScanConfig¶
Returns the configuration of angular resolution, scanning frequency, start and stop angle.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/ScanConfig"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
data |
|
GET /EnableLongRangeMode¶
Enables/disables the maximum scanning range depending on the scan configuration.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/EnableLongRangeMode"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /EnableLongRangeMode¶
Enables/disables the maximum scanning range depending on the scan configuration.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"EnableLongRangeMode": false
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /SensitivityMode¶
Returns/sets the sensitivity of the receiver unit.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/SensitivityMode"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /SensitivityMode¶
Returns/sets the sensitivity of the receiver unit.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"SensitivityMode": 1
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
5 - Date and System Time
GET /TSCRole¶
Returns/sets the time synchronization role (none, NTP or PTP).
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/TSCRole"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /TSCRole¶
Returns/sets the time synchronization role (none, NTP or PTP).
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"TSCRole": 0
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /TSCTCSrvAddr¶
Returns/sets the IP address of the time server.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/TSCTCSrvAddr"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /TSCTCSrvAddr¶
Returns/sets the IP address of the time server.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"TSCTCSrvAddr": [
192,
168,
0,
11
]
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /TSCTCtimezone¶
Returns/sets the time zone of the client.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/TSCTCtimezone"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /TSCTCtimezone¶
Returns/sets the time zone of the client.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"TSCTCtimezone": 36
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /TSCTCupdatetime¶
Returns/sets the update time of the client.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/TSCTCupdatetime"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /TSCTCupdatetime¶
Returns/sets the update time of the client.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"TSCTCupdatetime": 600
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /LSPdatetime¶
Returns the current time of the device (years, months, days, hours, minutes, seconds, microseconds).
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/LSPdatetime"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /LSPsetdatetime¶
Sets the time of the device (years, months, days, hours, minutes, seconds, microseconds).
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"DateTime": {
"uiYear": 0,
"usiMonth": 1,
"usiDay": 1,
"usiHour": 0,
"usiMinute": 0,
"usiSec": 0,
"udiUSec": 0
}
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
6 - Filter
GET /MCSenseLevel¶
Returns/sets the fog filter settings.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/MCSenseLevel"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /MCSenseLevel¶
Returns/sets the fog filter settings.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"MCSenseLevel": 0
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /LFPparticle¶
Returns/sets the particle filter settings. Filters out disturbances in the measurement data caused by particles such as dust, snowflakes, or similar. Configure the minimal threshold of the required distance step (mm) between the echo to be filtered and the echoes of surrounding beam angles.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/LFPparticle"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader | ||||
|---|---|---|---|---|---|
data |
|
POST /LFPparticle¶
Returns/sets the particle filter settings. Filters out disturbances in the measurement data caused by particles such as dust, snowflakes, or similar. Configure the minimal threshold of the required distance step (mm) between the echo to be filtered and the echoes of surrounding beam angles.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"LFPparticle": {
"bEnable": false,
"uiThreshold": 500
}
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader | ||||
|---|---|---|---|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /LFPmovingAveragingFilter¶
Returns/sets the mean filter settings. This filter smooths the distance value by calculating the arithmetic mean from the configured number of scans (2..4 scans). Points with zero distance are treated as missing values and are not taken into account for averaging. If all distances considered for averaging have the value 0, the result will be 0 as well.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/LFPmovingAveragingFilter"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader | ||||
|---|---|---|---|---|---|
data |
|
POST /LFPmovingAveragingFilter¶
Returns/sets the mean filter settings. This filter smooths the distance value by calculating the arithmetic mean from the configured number of scans (2..4 scans). Points with zero distance are treated as missing values and are not taken into account for averaging. If all distances considered for averaging have the value 0, the result will be 0 as well.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"LFPmovingAveragingFilter": {
"bEnable": false,
"uiAveragingDepth": 3
}
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader | ||||
|---|---|---|---|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /FREchoFilter¶
Returns/sets the multi-echo filter settings. Depending on the environment the sensor receives several measurement points on the same angular step (multi-echo). The filter can filter out the first echo, the last echo or all echoes.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/FREchoFilter"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /FREchoFilter¶
Returns/sets the multi-echo filter settings. Depending on the environment the sensor receives several measurement points on the same angular step (multi-echo). The filter can filter out the first echo, the last echo or all echoes.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"FREchoFilter": 1
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
7 - Contamination Indication
GET /ContaminationConfig¶
Returns/sets the contamination indication settings such as sensitivity, response time, threshold for warning, and active sectors.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/ContaminationConfig"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
data |
|
POST /ContaminationConfig¶
Returns/sets the contamination indication settings such as sensitivity, response time, threshold for warning, and active sectors.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"ContaminationConfig": {
"eStrategy": 0,
"usiResponseTime": 3,
"eThreshold": 0,
"eCover": 0,
"CustomSectors": [],
"bEnableWarning": true,
"bEnableError": true
}
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /ContaminationActiveSectors¶
Returns the active contamination sectors. Starts by the first sector at -138 degree and continues counterclockwise.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/ContaminationActiveSectors"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
GET /ContaminationData¶
Returns the contamination state of all contamination sectors.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/ContaminationData"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
GET /ContaminationResult¶
Returns the contamination indication state of the device.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/ContaminationResult"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader | ||||
|---|---|---|---|---|---|
data |
|
GET /treatBlockedSectorsAsErrorSectors¶
Returns/sets the state if blocked sectors are treated as blocked or contaminated sectors.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/treatBlockedSectorsAsErrorSectors"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /treatBlockedSectorsAsErrorSectors¶
Returns/sets the state if blocked sectors are treated as blocked or contaminated sectors.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"treatBlockedSectorsAsErrorSectors": false
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
8 - Ethernet
GET /EtherIPAddress¶
Returns/sets the used static IP address.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/EtherIPAddress"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /EtherIPAddress¶
Returns/sets the used static IP address.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"EtherIPAddress": [
192,
168,
0,
1
]
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /EtherIPGateAddress¶
Returns/sets the default gateway address.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/EtherIPGateAddress"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /EtherIPGateAddress¶
Returns/sets the default gateway address.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"EtherIPGateAddress": [
0,
0,
0,
0
]
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /EtherIPMask¶
Returns/sets the subnet mask.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/EtherIPMask"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /EtherIPMask¶
Returns/sets the subnet mask.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"EtherIPMask": [
255,
255,
255,
0
]
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /EtherAddressingMode¶
Returns/sets the mode for the IP address assignment (static or DHCP).
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/EtherAddressingMode"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /EtherAddressingMode¶
Returns/sets the mode for the IP address assignment (static or DHCP).
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"EtherAddressingMode": 0
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /EtherDHCPFallback¶
Returns/sets the mode for the DHCP fallback (retry or static).
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/EtherDHCPFallback"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /EtherDHCPFallback¶
Returns/sets the mode for the DHCP fallback (retry or static).
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"EtherDHCPFallback": 0
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
POST /EthernetUpdate¶
Applies the ethernet settings. This needs to be executed to actually change the ethernet settings.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
headerFields: PostBodyHeader
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /EtherIPAddressDHCP¶
Returns the assigned DHCP IP address.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/EtherIPAddressDHCP"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
GET /EtherIPGateAddressDHCP¶
Returns the assigned DHCP default gateway address.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/EtherIPGateAddressDHCP"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
GET /EtherIPMaskDHCP¶
Returns the assigned DHCP subnet mask.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/EtherIPMaskDHCP"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
GET /EtherMACAddress¶
Returns the MAC address of the ethernet interface.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/EtherMACAddress"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
9 - Inputs and Outputs
GET /InputState¶
Returns the state of all inputs.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/InputState"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader | ||||||||
|---|---|---|---|---|---|---|---|---|---|
data |
|
GET /OutputState¶
Returns the state of all outputs.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/OutputState"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
data |
|
GET /PortState¶
Returns the state of the ports. "PortState" is preferred over "OutputState".
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/PortState"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
data |
|
POST /mResetOutputCounter¶
Resets the counter for the outputs.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
headerFields: PostBodyHeader
Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
GET /enableCloningPlug¶
Enables/disables the cloning functionality of the system plug.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/enableCloningPlug"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /enableCloningPlug¶
Enables/disables the cloning functionality of the system plug.
This function requires at least user level: Service.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"enableCloningPlug": true
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /PortConfiguration¶
Returns/sets the port configuration of all I/Os.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/PortConfiguration"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader | ||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
data | Example:
|
POST /PortConfiguration¶
Returns/sets the port configuration of all I/Os.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"PortConfiguration": [
{
"PortType": 0,
"Name": "IOx",
"InputSettings": {
"Logic": 0,
"Debounce": 10,
"Sensitivity": 0,
"Reserved1": 0,
"Reserved2": 0
},
"OutputSettings": {
"Logic": 0,
"OutputMode": 0,
"RestartType": 0,
"RestartTime": 200,
"RestartInput": 1,
"Combination": 1,
"Reserved3": 0,
"Reserved4": 0,
"Sources": []
},
"EncoderPortType": 0,
"Reserved8": 0,
"Reserved9": 0,
"Reserved10": 0
}
]
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader | ||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
POST /SetOutput¶
Sets the output state for an individual output. Precondition is to set the output source to "SOPAS command".
Editable JSON template
{
"data": {
"Output": "<integer>",
"Value": "<integer>"
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
dataOutputType: integer · Format: uint8
ValueType: integer · Format: uint8
Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
10 - Measurement Data Output
GET /EtherHostIPPort¶
Returns/sets the port settings for the LMDscandata output (CoLa Binary TCP).
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/EtherHostIPPort"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /EtherHostIPPort¶
Returns/sets the port settings for the LMDscandata output (CoLa Binary TCP).
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"EtherHostIPPort": 2112
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /EtherAuxIPPort¶
Returns/sets the port settings for the LMDscandata output 2 (CoLa ASCII TCP).
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/EtherAuxIPPort"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /EtherAuxIPPort¶
Returns/sets the port settings for the LMDscandata output 2 (CoLa ASCII TCP).
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"EtherAuxIPPort": 2111
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /EtherSessionTimeout¶
Returns/sets the session timeout for the LMDscandata output. Be careful with low values as they might cause unexpected disconnections.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/EtherSessionTimeout"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /EtherSessionTimeout¶
Returns/sets the session timeout for the LMDscandata output. Be careful with low values as they might cause unexpected disconnections.
This function requires at least user level: Service.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"EtherSessionTimeout": 15000
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /ScanDataEthSettings¶
Returns/sets the destination IP address settings for measurement data streaming (UDP).
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/ScanDataEthSettings"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader | ||||||
|---|---|---|---|---|---|---|---|
data |
|
POST /ScanDataEthSettings¶
Returns/sets the destination IP address settings for measurement data streaming (UDP).
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"ScanDataEthSettings": {
"Protocol": 1,
"IPAddress": [
192,
168,
0,
100
],
"Port": 2115
}
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader | ||||||
|---|---|---|---|---|---|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /ScanDataEnable¶
Enables/disables the measurement data streaming. The measurement data itself is sent via a UDP-based SICK-specific format. A Python example can be found at https://github.com/SICKAG/ScanSegmentAPI.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/ScanDataEnable"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /ScanDataEnable¶
Enables/disables the measurement data streaming. The measurement data itself is sent via a UDP-based SICK-specific format. A Python example can be found at https://github.com/SICKAG/ScanSegmentAPI.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"ScanDataEnable": false
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /ScanDataFormat¶
Returns/sets the scan data format (e.g. Compact format).
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/ScanDataFormat"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /ScanDataFormat¶
Returns/sets the scan data format (e.g. Compact format).
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"ScanDataFormat": 2
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /rosFrameId¶
Returns/sets the frame ID of the published topics.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/rosFrameId"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /rosFrameId¶
Returns/sets the frame ID of the published topics.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"rosFrameId": "picoScan_"
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /rosParentFrameId¶
Returns/sets the parent frame ID of the published topics.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/rosParentFrameId"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /rosParentFrameId¶
Returns/sets the parent frame ID of the published topics.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"rosParentFrameId": "world"
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /rosNamespace¶
Returns/sets the namespace of the published topics.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/rosNamespace"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /rosNamespace¶
Returns/sets the namespace of the published topics.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"rosNamespace": " "
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /ScanDataConfig¶
Returns/sets the configuration of LMDscandata such as the content of the scan data (e.g. whether to include the RSSI values).
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/ScanDataConfig"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
data |
|
POST /ScanDataConfig¶
Returns/sets the configuration of LMDscandata such as the content of the scan data (e.g. whether to include the RSSI values).
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"ScanDataConfig": {
"reserved": "<integer>",
"RemDataConfig": {
"bEnable": true,
"reserved1": 0,
"reserved2": 0
},
"EnableEncoderBlock": false,
"reserved1": false,
"bEnableDeviceName": false,
"reserved2": false,
"bEnableTimeBlock": false,
"reserved3": 1
}
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /rosDomainId¶
Returns/sets the ROS domain ID used for the ROS 2 communication.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/rosDomainId"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /rosDomainId¶
Returns/sets the ROS domain ID used for the ROS 2 communication.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"rosDomainId": 0
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /compactTelegramType1Content¶
Returns/sets the content of the Compact telegram type 1 (e.g. whether to include the RSSI values).
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/compactTelegramType1Content"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader | ||||
|---|---|---|---|---|---|
data |
|
POST /compactTelegramType1Content¶
Returns/sets the content of the Compact telegram type 1 (e.g. whether to include the RSSI values).
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"compactTelegramType1Content": {
"includeRssi": true,
"includeProperties": true
}
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader | ||||
|---|---|---|---|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /SensorPosition¶
Returns/sets the mounting position in 1/10000 deg. This only affects the PointCloud2 format output by native ROS2.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/SensorPosition"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
data |
|
POST /SensorPosition¶
Returns/sets the mounting position in 1/10000 deg. This only affects the PointCloud2 format output by native ROS2.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"SensorPosition": {
"x": 0,
"y": 0,
"z": 0,
"yaw": 0,
"pitch": 0,
"roll": 0
}
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
11 - IMU Data Output
GET /ImuDataEthSettings¶
Returns/sets the destination IP address settings for IMU data streaming (UDP).
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/ImuDataEthSettings"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader | ||||||
|---|---|---|---|---|---|---|---|
data |
|
POST /ImuDataEthSettings¶
Returns/sets the destination IP address settings for IMU data streaming (UDP).
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"ImuDataEthSettings": {
"Protocol": 1,
"IPAddress": [
192,
168,
0,
100
],
"Port": 7503
}
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader | ||||||
|---|---|---|---|---|---|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /ImuDataEnable¶
Enables/Disables IMU data streaming.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/ImuDataEnable"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /ImuDataEnable¶
Enables/Disables IMU data streaming.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"ImuDataEnable": false
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /InertialMeasurementUnit¶
Returns the current IMU data (e.g. Acceleration, Orientation, ... ). The data is given in the following coordinate system which is based on the DIN70000 system. The x-axis lies on the 90-degree-beam of the 0-degree-layer. The y-axis is perpendicular to the x-axis and lies in the 0-degree-layer. The y-values are rising in the counterclockwise rotation direction (right-handed system). The z-axis is perpendicular to the x-y-plane and the scanner top points to rising z-values.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/InertialMeasurementUnit"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader | ||||||||
|---|---|---|---|---|---|---|---|---|---|
data |
|
12 - Encoder Data Output
GET /EncoderDataEthSettings¶
Returns/sets the destination IP address settings for encoder data streaming (UDP).
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/EncoderDataEthSettings"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader | ||||||
|---|---|---|---|---|---|---|---|
data |
|
POST /EncoderDataEthSettings¶
Returns/sets the destination IP address settings for encoder data streaming (UDP).
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"EncoderDataEthSettings": {
"Protocol": 1,
"IPAddress": [
192,
168,
0,
100
],
"Port": 7504
}
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader | ||||||
|---|---|---|---|---|---|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /EncoderDataEnable¶
Enables/disables the encoder data streaming. The encoder data itself is sent via a UDP-based SICK-specific format.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/EncoderDataEnable"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /EncoderDataEnable¶
Enables/disables the encoder data streaming. The encoder data itself is sent via a UDP-based SICK-specific format.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"EncoderDataEnable": false
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /EncSetting¶
Returns/sets the encoder mode (e.g. phase mode).
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/EncSetting"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /EncSetting¶
Returns/sets the encoder mode (e.g. phase mode).
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"EncSetting": 0
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /ActualEncPosition1Enable¶
Enables/disables the use of the 1st reference signal (port 3).
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/ActualEncPosition1Enable"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /ActualEncPosition1Enable¶
Enables/disables the use of the 1st reference signal (port 3).
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"ActualEncPosition1Enable": false
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /ActualEncPosition2Enable¶
Enables/disables the use of the 2nd reference signal (port 4).
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/ActualEncPosition2Enable"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /ActualEncPosition2Enable¶
Enables/disables the use of the 2nd reference signal (port 4).
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"ActualEncPosition2Enable": false
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /EncResolution¶
Enables/disables the use of the 2nd reference signal (Port4).
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/EncResolution"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /EncResolution¶
Enables/disables the use of the 2nd reference signal (Port4).
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"EncResolution": 1.0
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
POST /mResetEncoderIncrement¶
Resets the encoder tick value.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
headerFields: PostBodyHeader
Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
13 - Data Reduction
GET /LFPangleRangeFilter¶
Returns/sets the angle range filter settings. The filter restricts the output scan to a specified angle range. Filtered measurement values are set to 0. If the content of a complete data segment is set to 0, this segment is not output anymore.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/LFPangleRangeFilter"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
data |
|
POST /LFPangleRangeFilter¶
Returns/sets the angle range filter settings. The filter restricts the output scan to a specified angle range. Filtered measurement values are set to 0. If the content of a complete data segment is set to 0, this segment is not output anymore.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"LFPangleRangeFilter": {
"bEnable": false,
"fThetaStart": -900000,
"fThetaStop": 900000,
"fPhiStart": -900000,
"fPhiStop": 900000,
"uiBeamIncrement": 1
}
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /LFPintervalFilter¶
Returns/sets the interval filter settings. The filter reduces the scan output rate by a given factor.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/LFPintervalFilter"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader | ||||
|---|---|---|---|---|---|
data |
|
POST /LFPintervalFilter¶
Returns/sets the interval filter settings. The filter reduces the scan output rate by a given factor.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"LFPintervalFilter": {
"bEnable": false,
"uiReductionFactor": 2
}
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader | ||||
|---|---|---|---|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
14 - Range Filter
GET /LFPradialDistanceRangeFilter¶
Returns/sets the scanning range filter settings. Restriction of the distance measurements to a specified distance range. Measurement distances outside of the specified range are assigned the distance and RSSI value 0.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/LFPradialDistanceRangeFilter"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader | ||||||
|---|---|---|---|---|---|---|---|
data |
|
POST /LFPradialDistanceRangeFilter¶
Returns/sets the scanning range filter settings. Restriction of the distance measurements to a specified distance range. Measurement distances outside of the specified range are assigned the distance and RSSI value 0.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"LFPradialDistanceRangeFilter": {
"bEnable": false,
"ulDistMin": 0,
"ulDistMax": 200000
}
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader | ||||||
|---|---|---|---|---|---|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /LFPcubicareafilter¶
Returns/sets the cuboid area filter settings. The cuboid area filter limits the measurement data to a box defined by its extension in the x- and y-axis.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/LFPcubicareafilter"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
data |
|
POST /LFPcubicareafilter¶
Returns/sets the cuboid area filter settings. The cuboid area filter limits the measurement data to a box defined by its extension in the x- and y-axis.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"LFPcubicareafilter": {
"bEnable": false,
"lXMin": 0,
"lXMax": 5000,
"lYMin": -5000,
"lYMax": 5000,
"lZMin": -5,
"lZMax": 5
}
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
15 - Field Evaluation
GET /FieldEvaluationResult¶
Returns the state of all possible fields.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/FieldEvaluationResult"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /ActivateEvaluationGroup¶
Sets the activation condition for all existing evaluation groups (not configured, active, or inactive).
JSON example
{
"data": {
"List": []
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
dataListDefault:
[]Type: array · Minimum items: 0 · Maximum items: 48
Items:GroupIdType: integer · Format: uint16 · Default: 1 · Minimum: 1 · Maximum: 48
ActivateType: boolean · Default: false
Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /SetFieldEvaluationContour¶
Sets the contour of an existing field.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"EvaluationId": "<integer>",
"Points": [],
"LowerZLimit": "<integer>",
"UpperZLimit": "<integer>"
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
data |
|
Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /GetFieldEvaluationContour¶
Returns the contour of an existing field.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"EvaluationId": "<integer>"
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
data |
|
GET /EvaluationGroupType¶
Returns the evaluation group type, whether it is a field evaluation or a perpendicular distance field.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/EvaluationGroupType"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
GET /FieldEvaluationGroupState¶
Returns the activation condition for all existing evaluation groups (not configured, active, or inactive).
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/FieldEvaluationGroupState"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /StartTeachIn¶
Starts the teach in process.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
headerFields: PostBodyHeader
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
POST /StopTeachIn¶
Stops the teach in process.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
headerFields: PostBodyHeader
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
16 - Perpendicular Distance
GET /perpendicularDistanceResult¶
Returns the perpendicular distance within a field.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/perpendicularDistanceResult"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader | ||||
|---|---|---|---|---|---|
data |
|
17 - 3D scan recording
GET /ScanMergerEnabled¶
Enables/disables the 3D scan merger feature.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/ScanMergerEnabled"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /ScanMergerEnabled¶
Enables/disables the 3D scan merger feature.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"ScanMergerEnabled": false
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /ScanMergerSource¶
Returns/sets the data source for angle information used during scan merging (IMU or ENCODER).
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/ScanMergerSource"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /ScanMergerSource¶
Returns/sets the data source for angle information used during scan merging (IMU or ENCODER).
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"ScanMergerSource": 0
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /ScanMergeTrigger¶
Returns/sets how the scan merge is triggered (e.g. via method call).
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/ScanMergeTrigger"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /ScanMergeTrigger¶
Returns/sets how the scan merge is triggered (e.g. via method call).
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"ScanMergeTrigger": 0
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /RotationOffset¶
Returns/sets the rotation center offset (x, y, z in mm) relative to the scanner.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/RotationOffset"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader | ||||||
|---|---|---|---|---|---|---|---|
data |
|
POST /RotationOffset¶
Returns/sets the rotation center offset (x, y, z in mm) relative to the scanner.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"RotationOffset": {
"x": 0,
"y": 0,
"z": 0
}
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader | ||||||
|---|---|---|---|---|---|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /EncoderTransformationType¶
Returns/sets the encoder transformation type (ROTATION or DISPLACEMENT).
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/EncoderTransformationType"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /EncoderTransformationType¶
Returns/sets the encoder transformation type (ROTATION or DISPLACEMENT).
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"EncoderTransformationType": 0
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /EncoderRotation¶
Returns/sets the rotation center of the encoder in mm.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/EncoderRotation"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader | ||||||
|---|---|---|---|---|---|---|---|
data |
|
POST /EncoderRotation¶
Returns/sets the rotation center of the encoder in mm.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"EncoderRotation": {
"yaw": 0,
"pitch": 0.1,
"roll": 0
}
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader | ||||||
|---|---|---|---|---|---|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /EncoderTranslation¶
Returns/sets the translation of the encoder in mm.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/EncoderTranslation"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader | ||||||
|---|---|---|---|---|---|---|---|
data |
|
POST /EncoderTranslation¶
Returns/sets the translation of the encoder in mm.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"EncoderTranslation": {
"x": 0,
"y": 0,
"z": 1
}
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader | ||||||
|---|---|---|---|---|---|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
POST /StartScanMerge¶
Starts the 3D scan merge recording.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
headerFields: PostBodyHeader
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
POST /StopScanMerge¶
Stops the 3D scan merge recording.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
headerFields: PostBodyHeader
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
POST /ResetScanMergeView¶
Deletes the currently displayed point clouds.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
headerFields: PostBodyHeader
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /MergeSaving¶
Returns/sets the status for saving the merged scans. As soon as a scan merge is completed, the point cloud is available for download on port 80 (192.168.0.1/cloud.pcd). Curl: http:///cloud.pcd -o cloud.pcd. Only the most recently created point cloud is available for download. The point cloud is ready for download when MergeSaving changes from 1 (Saving in progress) to 0 (Saving not active).
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/MergeSaving"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
18 - Operating Data
GET /LastParaDate¶
Returns the last date (e.g. 12.11.2024) when a permanent parameter save was executed.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/LastParaDate"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
GET /LastParaTime¶
Returns the last time (e.g. 13:24) when a permanent parameter save was executed.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/LastParaTime"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
GET /PowerOnCnt¶
Returns the number of power on cycles.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/PowerOnCnt"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
GET /DailyOpHours¶
Returns the runtime duration since the last power on (non-persistent).
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/DailyOpHours"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
GET /OpHours¶
Returns the total number of operating hours during the lifetime of the device. The resolution is a 1/10 hour.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/OpHours"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
GET /CurrentTempDev¶
Returns the current device temperature.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/CurrentTempDev"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
19 - Diagnostics
GET /crown/file¶
Download files (e.g. OpenAPI description or diagnostic files) if one exists.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/crown/file?filePath=diagnosisDump.zip"Parameters
filePath
Location: query
Required: true
path
Type: string · Example: diagnosisDump.zip
Responses
Status 200
Media type: application/zip
Type: string · Format: binary
Status 400
bad operation
Status 404
file not found
Status 500
Server not found
POST /DoDiagnosisDump¶
Creates a diagnostic file (zip file) for further analysis.
This function requires at least user level: Service.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"DoRunlevelLoop": false,
"Output": " "
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader | ||||
|---|---|---|---|---|---|
data |
|
Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /GetDiagnosisDumpInfo¶
Returns additional meta-information about the diagnostic file.
Build the JSON body from the request schema below.
Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
Type: object · Nullable: true
Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader | ||||
|---|---|---|---|---|---|
data |
|
20 - Cybersecurity
GET /EtherAuxEnabled¶
Enables/disables the legacy interface CoLa A/B. If enabled CoLa A uses port 2111 and CoLa B uses 2112.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/EtherAuxEnabled"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /EtherAuxEnabled¶
Enables/disables the legacy interface CoLa A/B. If enabled CoLa A uses port 2111 and CoLa B uses 2112.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"EtherAuxEnabled": true
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /EtherCoLaScanMode¶
Configures the device search by SICK tools. If disabled, finding the device via device search and changing the IP address via SICK tools is not possible.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/EtherCoLaScanMode"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /EtherCoLaScanMode¶
Configures the device search by SICK tools. If disabled, finding the device via device search and changing the IP address via SICK tools is not possible.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"EtherCoLaScanMode": 3
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /httpsStatus¶
Returns the status of the HTTPS interface.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/httpsStatus"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader | ||||
|---|---|---|---|---|---|
data |
|
GET /certificateBundleInfo¶
Returns information about the uploaded certificate bundle.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/certificateBundleInfo"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
data |
|
POST /removeCertificateBundle¶
Removes the uploaded certificate bundle.
This function requires at least user level: Service.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
headerFields: PostBodyHeader
Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader | ||||
|---|---|---|---|---|---|
data |
|
POST /setCertificateBundle¶
Uploads a certificate bundle in the PEM format via JSON.
This function requires at least user level: Service.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"contentCertificateBundle": " ",
"contentPrivateKey": " "
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader | ||||
|---|---|---|---|---|---|
data |
|
Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader | ||||
|---|---|---|---|---|---|
data |
|
POST /SetWebserverEnabled¶
Sets availability of the webserver (reboot required). If disabled, the webserver-based GUI and the REST interface cannot be used anymore.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"Enable": true
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
POST /GetWebserverEnabled¶
Returns the availability of the web server.
Build the JSON body from the request schema below.
Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
Type: object · Nullable: true
Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
21 - Detection History
GET /EnableDetectionHistory¶
Enables/disables the detection history.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/EnableDetectionHistory"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /EnableDetectionHistory¶
Enables/disables the detection history.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"EnableDetectionHistory": true
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /EvaluationsToLog¶
Returns/sets the evaluations which are logged (if they are in use).
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/EvaluationsToLog"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /EvaluationsToLog¶
Returns/sets the evaluations which are logged (if they are in use).
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"EvaluationsToLog": [
true
]
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
POST /ResetDetectionHistory¶
Resets the detection history logs.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
headerFields: PostBodyHeader
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
Shared request and response fields
ResponseHeader
status | Allowed values: Type: integer · Format: uint16 · Default: 0 Mapping: * 0 - Ok * 1 - Parsing Failed * 2 - Invalid Data * 3 - Internal Server Error * 4 - Access Denied * 5 - Not Found * 6 - Out Of Range * 7 - Out Of Bounds * 8 - Read Only * 9 - Illegal Value * 10 - Invalid Challenge * 11 - Out Of Connections |
|---|---|
message | Type: string · Default: Ok |
PostBodyHeader
nonce | Type: string · Default: |
|---|---|
opaque | Type: string · Default: |
realm | Type: string · Default: SICK Sensor |
response | Type: string · Default: |
user | Fields: E_USER_LEVEL_TYPE |
E_USER_LEVEL_TYPE
Allowed values:
[
"Run",
"Operator",
"Maintenance",
"AuthorizedClient",
"Service"
]Type: string · Default: Run
DeviceStatus
Allowed values:
[
0,
1,
2,
3,
4,
5,
6,
7,
8
]Type: integer · Format: uint8 · Default: 0
Mapping: * 0 - DS_UnknownState * 1 - DS_Startup * 2 - DS_ServiceMode * 3 - DS_NormalOperation * 4 - DS_SuspendedOperation * 5 - DS_ServiceRecommended * 6 - DS_ServiceRequired * 7 - DS_RecoverableError * 8 - DS_FatalError
DateTime_t
uiYear | Type: integer · Format: uint16 · Default: 0 · Minimum: 0 · Maximum: 2105 |
|---|---|
usiMonth | Type: integer · Format: uint8 · Default: 1 · Minimum: 0 · Maximum: 12 |
usiDay | Type: integer · Format: uint8 · Default: 1 · Minimum: 0 · Maximum: 31 |
usiHour | Type: integer · Format: uint8 · Default: 0 · Minimum: 0 · Maximum: 23 |
usiMinute | Type: integer · Format: uint8 · Default: 0 · Minimum: 0 · Maximum: 59 |
usiSec | Type: integer · Format: uint8 · Default: 0 · Minimum: 0 · Maximum: 59 |
udiUSec | Type: integer · Format: uint32 · Default: 0 · Minimum: 0 · Maximum: 999999 |
httpsError_t
errorType: string · Default: · Maximum length: 100
RestoreBackupResult
Allowed values:
[
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
50
]Type: integer · Format: uint8 · Default: 0
Mapping: * 0 - Ok * 1 - ChecksumError * 2 - ParseError * 3 - DeviceIdentificationError * 4 - UpdateRepositoryError * 5 - UpdateSourceError * 6 - DecryptionError * 7 - DecryptionHeaderError * 8 - DecryptionLengthError * 9 - IoError * 10 - VersionConversionError * 50 - ComponentRegistryError
Logic_t
Allowed values:
[
0,
1
]Type: integer · Format: uint8 · Default: 0
Mapping: * 0 - ACTIVE_HIGH * 1 - ACTIVE_LOW
IOState_t
eIOStateAllowed values:
[ 0, 1, 2 ]Type: integer · Format: uint8 · Default: 2
Mapping: * 0 - IOS_LOW * 1 - IOS_HIGH * 2 - IOS_TRISTATE
PortStateAndCounter_t
ePortState | Allowed values: Type: integer · Format: uint8 · Default: 2 Mapping: * 0 - OUTPUT_NOT_ACTIVE * 1 - OUTPUT_ACTIVE * 2 - TRISTATE * 3 - INPUT_ACTIVE * 4 - INPUT_NOT_ACTIVE |
|---|---|
PortCounter | Type: integer · Format: uint32 |
LedStateType
Color | Allowed values: Type: integer · Format: uint8 · Default: 0 Mapping: * 0 - GREEN * 1 - YELLOW * 2 - RED * 3 - WHITE |
|---|---|
Function | Allowed values: Type: integer · Format: uint8 · Default: 0 Mapping: * 0 - ON * 1 - OFF * 2 - BLINKING * 3 - BLINKING_FAST * 4 - BLINKING_DELAYED * 5 - BLINKING_COLOR * 6 - BLINKING_YELLOW_RED |
Id | Type: string · Default: · Maximum length: 8 |
Point2d_t
x | Type: integer · Format: int32 · Default: 0 |
|---|---|
y | Type: integer · Format: int32 · Default: 0 |
EvaluationResult_t
State | Allowed values: Type: integer · Format: uint8 · Default: 0 Mapping: * 0 - NOT_CONFIGURED * 1 - INACTIVE * 2 - FREE * 3 - DETECTING_INFRINGED * 4 - INFRINGED * 5 - DETECTING_FREE |
|---|---|
Positions |
FieldEvaluationResult_t
Version | Type: integer · Format: uint16 · Default: 1 |
|---|---|
Timestamp | Type: integer · Format: uint64 |
EvaluationResultList |
Point3d_t
x | Type: integer · Format: int32 · Default: 0 · Minimum: -500000 · Maximum: 500000 |
|---|---|
y | Type: integer · Format: int32 · Default: 0 · Minimum: -500000 · Maximum: 500000 |
z | Type: integer · Format: int32 · Default: 0 · Minimum: -500000 · Maximum: 500000 |
PerformanceProfiles_t
Allowed values:
[
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11
]Type: integer · Format: uint8 · Default: 2
Mapping: * 1 - MODE_1 * 2 - MODE_2 * 3 - MODE_3 * 4 - MODE_4 * 5 - MODE_5 * 6 - MODE_6 * 7 - MODE_7 * 8 - MODE_8 * 9 - MODE_9 * 10 - MODE_10 * 11 - MODE_11
SessionToken
Type: string · Default: · Maximum length: 36
picoScan120 REST API¶
1 - General
POST /checkCredentials¶
Returns authentication success. For more details see https://github.com/SICKAG/sick_scan_rest_client.
Build the JSON body from the request schema below.
Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
Type: object · Nullable: true
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
PUT /update¶
Transfers a firmware file (.spk.signed) from the file location to the device. The maximum possible file size is 100 MB.
See Firmware Update for the firmware update workflow.
This operation uploads a file or uses a non-JSON body. Use the request media type and upload fields below.
Request body
Media type: application/octet-stream
dataTypeType: string
BinaryType: string
Responses
Status 200
GET /parameterbackup¶
Reads/transfers the backup file (JSON) from/to the device.
See Configuration Backup and Restore for the parameter backup workflow.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/parameterbackup"Responses
Status 200
Media type: application/json
version | Type: string | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
device identification | Type: string | ||||||||||
checksum | Type: string | ||||||||||
parameters | Type: array Items:
|
PUT /parameterbackup¶
Reads/transfers the backup file (JSON) from/to the device.
See Configuration Backup and Restore for the parameter backup workflow.
This operation uploads a file or uses a non-JSON body. Use the request media type and upload fields below.
Request body
Media type: multipart/form-data
dateiType: string · Format: binary
Json-File
Responses
Status 200
POST /SetPassword¶
Sets the password for the CoLa A/B interface only. In this example the password for user level: Service (4) is set to - test - (integer value of the password hash - test -). For more details see https://github.com/SICKAG/sick_scan_rest_client.
JSON example
{
"data": {
"siUserLevel": 4,
"udiNewPassword": 3410122659
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
dataExample:
{ "siUserLevel": 4, "udiNewPassword": 3410122659 }siUserLevelType: integer · Format: int8
udiNewPasswordType: integer · Format: uint32
Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /getChallenge¶
Returns a challenge for the challenge and response authentication method. For more details see https://github.com/SICKAG/sick_scan_rest_client
JSON example
{
"data": {
"user": "Run"
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
datauserFields: E_USER_LEVEL_TYPE
Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader | ||||||||
|---|---|---|---|---|---|---|---|---|---|
challenge |
|
POST /changePassword¶
Sets the password for the REST interface. For more details see https://github.com/SICKAG/sick_scan_rest_client.
JSON example
{
"data": {
"encryptedMessage": [],
"userLevel": "Run"
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
dataencryptedMessageDefault:
[]Type: array · Minimum items: 0 · Maximum items: 96
Items:Type: integer · Format: uint8
userLevelFields: E_USER_LEVEL_TYPE
Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /EnableUserLevel¶
Activates / deactivates a specific user level for the REST interface.
This function requires at least user level: Service.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"userLevel": "<integer>",
"isEnabled": false
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader | ||||
|---|---|---|---|---|---|
data |
|
Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /WriteEeprom¶
Saves all parameters permanently.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
headerFields: PostBodyHeader
Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /SoftReset¶
Reboots the device. All non-saved parameters are lost.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"ProcessorNbr": "<integer>"
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
POST /RebootDevice¶
Reboots the device. All parameters are saved.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
headerFields: PostBodyHeader
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
POST /LoadFactoryDefaults¶
Resets all parameters to default.
This function requires at least user level: Service.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
headerFields: PostBodyHeader
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
POST /LoadApplicationDefaults¶
Resets only the user parametrization of the fields, evaluation cases, and parameters under the section "Application". Other parameters like interface settings, echo filter, etc. remain unchanged. This function requires the user level: Service.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
headerFields: PostBodyHeader
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
POST /EnableLegacyUserLevel¶
Activates / deactivates a specific user level for the CoLa A/B interface.
This function requires at least user level: Service.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"userLevel": "<integer>",
"isEnabled": false
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader | ||||
|---|---|---|---|---|---|
data |
|
Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
GET /laserType¶
Returns the type of the sending unit.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/laserType"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
GET /sipmType¶
Returns the type of the receiving unit.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/sipmType"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /RunFirmwareUpdate¶
Starts the firmware update process.
This function requires at least user level: Service.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
headerFields: PostBodyHeader
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /UpdateState¶
Returns the state of the update process.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/UpdateState"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
GET /CreateParameterBackupResult¶
Returns the current status of the parameter backup process.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/CreateParameterBackupResult"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader | ||||
|---|---|---|---|---|---|
data |
|
GET /RestoreParameterBackupResult¶
Returns the current status of the parameter restoration process.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/RestoreParameterBackupResult"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader | ||||||
|---|---|---|---|---|---|---|---|
data |
|
POST /CreateParameterBackup¶
Creates a parameter backup file on the device.
This function requires at least user level: Service.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"Passphrase": " "
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /RestoreParameterBackup¶
Restores the backup file on the device. The restored parameters will then be applied.
This function requires at least user level: Service.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"Passphrase": " ",
"Filter": 0
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader | ||||
|---|---|---|---|---|---|
data |
|
Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
GET /LFTchecksum¶
Returns a checksum over all software parts and configurations.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/LFTchecksum"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
data |
|
POST /CreateSessionToken¶
A short-lived session token to pass to a HTTP request header.
Build the JSON body from the request schema below.
Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
Type: object · Nullable: true
Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader | ||||
|---|---|---|---|---|---|
data |
|
2 - Status
GET /DeviceStatus¶
Returns the device state (9 possible states).
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/DeviceStatus"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
GET /SCdevicestate¶
Returns the device state (busy, ready, or error).
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/SCdevicestate"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
3 - Device Information
GET /DeviceIdent¶
Returns the device name and the firmware version.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/DeviceIdent"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader | ||||
|---|---|---|---|---|---|
data |
|
GET /LocationName¶
Returns/sets the device name.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/LocationName"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /LocationName¶
Returns/sets the device name.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"LocationName": "not defined"
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /SerialNumber¶
Returns the serial number.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/SerialNumber"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
GET /FirmwareVersion¶
Returns the current firmware version.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/FirmwareVersion"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
GET /OrderNumber¶
Returns the order number (SICK part number).
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/OrderNumber"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
GET /DeviceType¶
Returns the device type.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/DeviceType"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /FindMe¶
Sets the device LEDs into blinking mode for better identification.
JSON example
{
"data": {
"uiDuration": 100
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
dataExample:
{ "uiDuration": 100 }uiDurationType: integer · Format: uint16 · Minimum: 1
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
4 - Basic Settings
GET /LEDState¶
Returns the LED status.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/LEDState"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
GET /LEDEnable¶
Returns/sets the LED mode (on/off).
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/LEDEnable"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /LEDEnable¶
Returns/sets the LED mode (on/off).
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"LEDEnable": true
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
POST /mStartMeasure¶
Starts motor and measurement.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
headerFields: PostBodyHeader
Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /mStandby¶
Enables/disables the laser (on/off).
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
headerFields: PostBodyHeader
Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /mStopMeasure¶
Stops motor and measurement.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
headerFields: PostBodyHeader
Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
GET /AutoStartMeasure¶
Returns/sets the mode for automatic start of measurement after boot-up.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/AutoStartMeasure"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /AutoStartMeasure¶
Returns/sets the mode for automatic start of measurement after boot-up.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"AutoStartMeasure": true
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /ScanConfig¶
Configuration of angular resolution, scanning frequency, start and stop angle.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/ScanConfig"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
data |
|
GET /operatingMode¶
Returns/sets the operating mode of the receiver unit.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/operatingMode"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /operatingMode¶
Returns/sets the operating mode of the receiver unit.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"operatingMode": 0
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
5 - Date and System Time
GET /TSCRole¶
Returns/sets the time synchronization role (none, NTP, or PTP).
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/TSCRole"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /TSCRole¶
Returns/sets the time synchronization role (none, NTP, or PTP).
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"TSCRole": 0
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /TSCTCSrvAddr¶
Returns/sets the IP address of the time server.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/TSCTCSrvAddr"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /TSCTCSrvAddr¶
Returns/sets the IP address of the time server.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"TSCTCSrvAddr": [
192,
168,
0,
11
]
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /TSCTCtimezone¶
Returns/sets the time zone of the client.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/TSCTCtimezone"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /TSCTCtimezone¶
Returns/sets the time zone of the client.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"TSCTCtimezone": 36
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /TSCTCupdatetime¶
Returns/sets the update time of the client.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/TSCTCupdatetime"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /TSCTCupdatetime¶
Returns/sets the update time of the client.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"TSCTCupdatetime": 600
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /LSPdatetime¶
Returns the current time of the device (years, months, days, hours, minutes, seconds, microseconds).
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/LSPdatetime"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /LSPsetdatetime¶
Sets the time of the device (years, months, days, hours, minutes, seconds, microseconds).
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"DateTime": {
"uiYear": 0,
"usiMonth": 1,
"usiDay": 1,
"usiHour": 0,
"usiMinute": 0,
"usiSec": 0,
"udiUSec": 0
}
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
6 - Filter
GET /LFPparticle¶
Returns/sets the particle filter settings. Filters out disturbances in the measurement data caused by particles such as dust, snowflakes, or similar. Configure the minimal threshold of the required distance step (mm) between the echo to be filtered and the echoes of surrounding beam angles.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/LFPparticle"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader | ||||
|---|---|---|---|---|---|
data |
|
POST /LFPparticle¶
Returns/sets the particle filter settings. Filters out disturbances in the measurement data caused by particles such as dust, snowflakes, or similar. Configure the minimal threshold of the required distance step (mm) between the echo to be filtered and the echoes of surrounding beam angles.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"LFPparticle": {
"bEnable": false,
"uiThreshold": 500
}
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader | ||||
|---|---|---|---|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
7 - Ethernet
GET /EtherIPAddress¶
Returns/sets the used static IP address.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/EtherIPAddress"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /EtherIPAddress¶
Returns/sets the used static IP address.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"EtherIPAddress": [
192,
168,
0,
1
]
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /EtherIPGateAddress¶
Returns/sets the default gateway address.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/EtherIPGateAddress"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /EtherIPGateAddress¶
Returns/sets the default gateway address.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"EtherIPGateAddress": [
0,
0,
0,
0
]
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /EtherIPMask¶
Returns/sets the subnet mask.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/EtherIPMask"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /EtherIPMask¶
Returns/sets the subnet mask.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"EtherIPMask": [
255,
255,
255,
0
]
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /EtherAddressingMode¶
Returns/sets the mode for the IP address assignment (static or DHCP).
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/EtherAddressingMode"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /EtherAddressingMode¶
Returns/sets the mode for the IP address assignment (static or DHCP).
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"EtherAddressingMode": 0
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /EtherDHCPFallback¶
Returns/sets the mode for the DHCP fallback (retry or static).
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/EtherDHCPFallback"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /EtherDHCPFallback¶
Returns/sets the mode for the DHCP fallback (retry or static).
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"EtherDHCPFallback": 0
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
POST /EthernetUpdate¶
Applies the Ethernet settings. This needs to be executed to actually change the Ethernet settings.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
headerFields: PostBodyHeader
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /EtherIPAddressDHCP¶
Returns the assigned DHCP IP address.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/EtherIPAddressDHCP"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
GET /EtherIPGateAddressDHCP¶
Returns the assigned DHCP default gateway address.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/EtherIPGateAddressDHCP"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
GET /EtherIPMaskDHCP¶
Returns the assigned DHCP subnet mask.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/EtherIPMaskDHCP"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
GET /EtherMACAddress¶
Returns the MAC address of the Ethernet interface.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/EtherMACAddress"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
8 - Inputs And Outputs
GET /OutputState¶
Returns the state of all outputs.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/OutputState"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
data |
|
GET /PortState¶
Returns the state of the ports. "PortState" is preferred over "OutputState".
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/PortState"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
data |
|
POST /mResetOutputCounter¶
Resets the counter for the outputs.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
headerFields: PostBodyHeader
Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
GET /PortConfiguration¶
Returns/sets the port configuration of all I/Os.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/PortConfiguration"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader | ||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
data |
|
POST /PortConfiguration¶
Returns/sets the port configuration of all I/Os.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"PortConfiguration": [
{
"PortType": 0,
"Name": "IOx",
"InputSettings": {
"Logic": 0,
"Debounce": 10,
"Sensitivity": 0,
"Reserved1": 0,
"Reserved2": 0
},
"OutputSettings": {
"Logic": 0,
"OutputMode": 0,
"RestartType": 0,
"RestartTime": 200,
"RestartInput": 1,
"Combination": 1,
"Reserved3": 0,
"Reserved4": 0,
"Sources": []
},
"EncoderPortType": 0,
"Reserved8": 0,
"Reserved9": 0,
"Reserved10": 0
}
]
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader | ||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
POST /SetOutput¶
Sets the output state for an individual output. Precondition is to set the output source to "SOPAS command".
Editable JSON template
{
"data": {
"Output": "<integer>",
"Value": "<integer>"
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
dataOutputType: integer · Format: uint8
ValueType: integer · Format: uint8
Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
9 - Measurement Data Output
GET /EtherHostIPPort¶
Returns/sets the port settings for the LMDscandata output (CoLa Binary TCP).
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/EtherHostIPPort"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /EtherHostIPPort¶
Returns/sets the port settings for the LMDscandata output (CoLa Binary TCP).
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"EtherHostIPPort": 2112
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /EtherAuxIPPort¶
Returns/sets the port settings for the LMDscandata output 2 (CoLa ASCII TCP).
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/EtherAuxIPPort"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /EtherAuxIPPort¶
Returns/sets the port settings for the LMDscandata output 2 (CoLa ASCII TCP).
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"EtherAuxIPPort": 2111
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /EtherSessionTimeout¶
Returns/sets the session timeout for the LMDscandata output. Be careful with low values as they might cause unexpected disconnections.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/EtherSessionTimeout"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /EtherSessionTimeout¶
Returns/sets the session timeout for the LMDscandata output. Be careful with low values as they might cause unexpected disconnections.
This function requires at least user level: Service.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"EtherSessionTimeout": 15000
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /ScanDataEthSettings¶
Returns/sets the destination IP address settings for measurement data streaming (UDP).
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/ScanDataEthSettings"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader | ||||||
|---|---|---|---|---|---|---|---|
data |
|
POST /ScanDataEthSettings¶
Returns/sets the destination IP address settings for measurement data streaming (UDP).
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"ScanDataEthSettings": {
"Protocol": 1,
"IPAddress": [
192,
168,
0,
100
],
"Port": 2115
}
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader | ||||||
|---|---|---|---|---|---|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /ScanDataEnable¶
Enables/disables the measurement data streaming. The measurement data itself is sent via a UDP-based SICK-specific format. A Python example can be found at https://github.com/SICKAG/ScanSegmentAPI.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/ScanDataEnable"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /ScanDataEnable¶
Enables/disables the measurement data streaming. The measurement data itself is sent via a UDP-based SICK-specific format. A Python example can be found at https://github.com/SICKAG/ScanSegmentAPI.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"ScanDataEnable": false
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /ScanDataFormat¶
Returns/sets the scan data format (e.g., Compact format).
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/ScanDataFormat"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /ScanDataFormat¶
Returns/sets the scan data format (e.g., Compact format).
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"ScanDataFormat": 2
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /rosFrameId¶
Returns/sets the frame ID of the published topics.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/rosFrameId"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /rosFrameId¶
Returns/sets the frame ID of the published topics.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"rosFrameId": "picoScan_"
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /rosParentFrameId¶
Returns/sets the parent frame ID of the published topics.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/rosParentFrameId"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /rosParentFrameId¶
Returns/sets the parent frame ID of the published topics.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"rosParentFrameId": "world"
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /rosNamespace¶
Returns/sets the namespace of the published topics.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/rosNamespace"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /rosNamespace¶
Returns/sets the namespace of the published topics.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"rosNamespace": " "
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /ScanDataConfig¶
Returns/sets the configuration of LMDscandata such as the content of the scan data (e.g., whether to include the RSSI values).
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/ScanDataConfig"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
data |
|
POST /ScanDataConfig¶
Returns/sets the configuration of LMDscandata such as the content of the scan data (e.g., whether to include the RSSI values).
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"ScanDataConfig": {
"reserved": "<integer>",
"RemDataConfig": {
"bEnable": true,
"reserved1": 0,
"reserved2": 0
},
"EnableEncoderBlock": false,
"reserved1": false,
"bEnableDeviceName": false,
"reserved2": false,
"bEnableTimeBlock": false,
"reserved3": 1
}
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /rosDomainId¶
Returns/sets the ROS domain ID used for the ROS 2 communication.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/rosDomainId"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /rosDomainId¶
Returns/sets the ROS domain ID used for the ROS 2 communication.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"rosDomainId": 0
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /compactTelegramType1Content¶
Returns/sets the content of the Compact telegram type 1 (e.g. whether to include the RSSI values).
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/compactTelegramType1Content"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader | ||||
|---|---|---|---|---|---|
data |
|
POST /compactTelegramType1Content¶
Returns/sets the content of the Compact telegram type 1 (e.g. whether to include the RSSI values).
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"compactTelegramType1Content": {
"includeRssi": true,
"includeProperties": true
}
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader | ||||
|---|---|---|---|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /SensorPosition¶
Returns/sets the mounting position in 1/10000 deg. This only affects the PointCloud2 format output by native ROS2.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/SensorPosition"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
data |
|
POST /SensorPosition¶
Returns/sets the mounting position in 1/10000 deg. This only affects the PointCloud2 format output by native ROS2.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"SensorPosition": {
"x": 0,
"y": 0,
"z": 0,
"yaw": 0,
"pitch": 0,
"roll": 0
}
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
10 - Operating Data
GET /LastParaDate¶
Returns the last date (e.g., 12.11.2024) when a permanent parameter save was executed.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/LastParaDate"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
GET /LastParaTime¶
Returns the last time (e.g., 13:24) when a permanent parameter save was executed.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/LastParaTime"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
GET /PowerOnCnt¶
Returns the number of power-on cycles.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/PowerOnCnt"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
GET /DailyOpHours¶
Returns the runtime duration since the last power-on (non-persistent).
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/DailyOpHours"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
GET /OpHours¶
Returns the total number of operating hours during the lifetime of the device. The resolution is 1/10 hour.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/OpHours"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
GET /CurrentTempDev¶
Returns the current device temperature.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/CurrentTempDev"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
11 - Diagnostics
POST /DoDiagnosisDump¶
Creates a diagnostic file (zip file) for further analysis.
This function requires at least user level: Service.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"DoRunlevelLoop": true,
"Output": "file"
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader | ||||
|---|---|---|---|---|---|
data | Example:
|
Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /GetDiagnosisDumpInfo¶
Returns additional meta-information about the diagnostic file.
Build the JSON body from the request schema below.
Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
Type: object · Nullable: true
Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader | ||||
|---|---|---|---|---|---|
data |
|
12 - Cybersecurity
GET /EtherAuxEnabled¶
Enables/disables the legacy interface CoLa A/B. If enabled, CoLa A uses port 2111 and CoLa B uses 2112.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/EtherAuxEnabled"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /EtherAuxEnabled¶
Enables/disables the legacy interface CoLa A/B. If enabled, CoLa A uses port 2111 and CoLa B uses 2112.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"EtherAuxEnabled": true
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /EtherCoLaScanMode¶
Configures the device search by SICK tools. If disabled, finding the device via device search and changing the IP address via SICK tools is not possible.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/EtherCoLaScanMode"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
POST /EtherCoLaScanMode¶
Configures the device search by SICK tools. If disabled, finding the device via device search and changing the IP address via SICK tools is not possible.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"EtherCoLaScanMode": 3
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
GET /httpsStatus¶
Returns the status of the HTTPS interface.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/httpsStatus"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader | ||||
|---|---|---|---|---|---|
data |
|
GET /certificateBundleInfo¶
Returns information about the uploaded certificate bundle.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/certificateBundleInfo"Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
data |
|
POST /removeCertificateBundle¶
Removes the uploaded certificate bundle.
This function requires at least user level: Service.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
headerFields: PostBodyHeader
Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader | ||||
|---|---|---|---|---|---|
data |
|
POST /setCertificateBundle¶
Uploads a certificate bundle in the PEM format via JSON.
This function requires at least user level: Service.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"contentCertificateBundle": " ",
"contentPrivateKey": " "
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader | ||||
|---|---|---|---|---|---|
data |
|
Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader | ||||
|---|---|---|---|---|---|
data |
|
POST /SetWebserverEnabled¶
Sets the availability of the web server (reboot required). If disabled, the web server-based GUI and the REST interface cannot be used anymore.
This function requires at least user level: Authorized Client.
Editable JSON template
{
"header": {
"nonce": "<nonce from authentication>",
"opaque": "<opaque from authentication>",
"realm": "SICK Sensor",
"response": "<response from authentication>",
"user": "Run"
},
"data": {
"Enable": true
}
}Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
header | Fields: PostBodyHeader |
|---|---|
data |
|
Responses
Status 200
Media type: application/json
headerFields: ResponseHeader
POST /GetWebserverEnabled¶
Returns the availability of the web server.
Build the JSON body from the request schema below.
Try the request
Protected requests need challenge-response authentication, so curl alone cannot send them; use the Python script on the REST Interface page.
Request body
Required: true
Media type: application/json
Type: object · Nullable: true
Responses
Status 200
Media type: application/json
header | Fields: ResponseHeader |
|---|---|
data |
|
19 - Diagnostics
GET /crown/file¶
Download files (e.g. OpenAPI description or diagnostic files) if one exists.
Try the request
Copy this command into a terminal. In Windows PowerShell, use curl.exe instead of curl.
curl --request GET "http://192.168.0.1/api/crown/file?filePath=diagnosisDump.zip"Parameters
filePath
Location: query
Required: true
path
Type: string · Example: diagnosisDump.zip
Responses
Status 200
Media type: application/zip
Type: string · Format: binary
Status 400
bad operation
Status 404
file not found
Status 500
Server not found
Shared request and response fields
ResponseHeader
status | Allowed values: Type: integer · Format: uint16 · Default: 0 Mapping: * 0 - Ok * 1 - Parsing Failed * 2 - Invalid Data * 3 - Internal Server Error * 4 - Access Denied * 5 - Not Found * 6 - Out Of Range * 7 - Out Of Bounds * 8 - Read Only * 9 - Illegal Value * 10 - Invalid Challenge * 11 - Out Of Connections |
|---|---|
message | Type: string · Default: Ok |
PostBodyHeader
nonce | Type: string · Default: |
|---|---|
opaque | Type: string · Default: |
realm | Type: string · Default: SICK Sensor |
response | Type: string · Default: |
user | Fields: E_USER_LEVEL_TYPE |
E_USER_LEVEL_TYPE
Allowed values:
[
"Run",
"Operator",
"Maintenance",
"AuthorizedClient",
"Service"
]Type: string · Default: Run
DeviceStatus
Allowed values:
[
0,
1,
2,
3,
4,
5,
6,
7,
8
]Type: integer · Format: uint8 · Default: 0
Mapping: * 0 - DS_UnknownState * 1 - DS_Startup * 2 - DS_ServiceMode * 3 - DS_NormalOperation * 4 - DS_SuspendedOperation * 5 - DS_ServiceRecommended * 6 - DS_ServiceRequired * 7 - DS_RecoverableError * 8 - DS_FatalError
DateTime_t
uiYear | Type: integer · Format: uint16 · Default: 0 · Minimum: 0 · Maximum: 2105 |
|---|---|
usiMonth | Type: integer · Format: uint8 · Default: 1 · Minimum: 0 · Maximum: 12 |
usiDay | Type: integer · Format: uint8 · Default: 1 · Minimum: 0 · Maximum: 31 |
usiHour | Type: integer · Format: uint8 · Default: 0 · Minimum: 0 · Maximum: 23 |
usiMinute | Type: integer · Format: uint8 · Default: 0 · Minimum: 0 · Maximum: 59 |
usiSec | Type: integer · Format: uint8 · Default: 0 · Minimum: 0 · Maximum: 59 |
udiUSec | Type: integer · Format: uint32 · Default: 0 · Minimum: 0 · Maximum: 999999 |
httpsError_t
errorType: string · Default: · Maximum length: 100
RestoreBackupResult
Allowed values:
[
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
50
]Type: integer · Format: uint8 · Default: 0
Mapping: * 0 - Ok * 1 - ChecksumError * 2 - ParseError * 3 - DeviceIdentificationError * 4 - UpdateRepositoryError * 5 - UpdateSourceError * 6 - DecryptionError * 7 - DecryptionHeaderError * 8 - DecryptionLengthError * 9 - IoError * 10 - VersionConversionError * 50 - ComponentRegistryError
Logic_t
Allowed values:
[
0,
1
]Type: integer · Format: uint8 · Default: 0
Mapping: * 0 - ACTIVE_HIGH * 1 - ACTIVE_LOW
IOState_t
eIOStateAllowed values:
[ 0, 1, 2 ]Type: integer · Format: uint8 · Default: 2
Mapping: * 0 - IOS_LOW * 1 - IOS_HIGH * 2 - IOS_TRISTATE
PortStateAndCounter_t
ePortState | Allowed values: Type: integer · Format: uint8 · Default: 2 Mapping: * 0 - OUTPUT_NOT_ACTIVE * 1 - OUTPUT_ACTIVE * 2 - TRISTATE * 3 - INPUT_ACTIVE * 4 - INPUT_NOT_ACTIVE |
|---|---|
PortCounter | Type: integer · Format: uint32 |
LedStateType
Color | Allowed values: Type: integer · Format: uint8 · Default: 0 Mapping: * 0 - GREEN * 1 - YELLOW * 2 - RED * 3 - WHITE |
|---|---|
Function | Allowed values: Type: integer · Format: uint8 · Default: 0 Mapping: * 0 - ON * 1 - OFF * 2 - BLINKING * 3 - BLINKING_FAST * 4 - BLINKING_DELAYED * 5 - BLINKING_COLOR * 6 - BLINKING_YELLOW_RED |
Id | Type: string · Default: · Maximum length: 8 |
SessionToken
Type: string · Default: · Maximum length: 36