Documentation Index

Fetch the complete documentation index at: https://support.keypro.fi/llms.txt

Use this file to discover all available pages before exploring further.

2025-11-06 14.00 UTC - There are currently no active events. All systems operational.

Create new streetlight

Prev Next
Post
/el_streetlights/

Operation is used to create new streetlight. Available from product version 3.2.2.

Security
API Key: Token
Header parameter nameAuthorization

Token issued for API consumer.

Body parameters

Streetlight to be created

Expand All
object
additional_information
string

Additional information about warranty fix details. Available from product version 2025.3.

group_change_date
string (date-time)

Streetlight group change date

group_cleaning_date
string (date-time)

Streetlight group cleaning date

installation_date
string (date)

Installation date

installation_height
number (float)

Installation height

installation_year
integer

Installation year

lamp_change_date
string (date-time)

Streetlight lamp change date

lamp_dimmer_change_date
string (date-time)

Streetlight lamp dimmer change date. Deprecated since product version 2026.2 — use dimming_profile instead.

lamp_position
string

Lamp position

lamp_warranty_exp_date
string (date-time)

Streetlight lamp warranty expiration date

lamp_warranty_period
integer

Lamp warranty period length

latest_warranty_fix_date
string (date)

Streetlight latest warranty fix date. Available from product version 2025.3.

light_change_date
string (date-time)

Streetlight change date

light_checkout_date
string (date-time)

Streetlight checkout date

light_connection_change_date
string (date-time)

Streetlight connection change date

light_warranty_exp_date
string (date-time)

Streetlight warranty expiration date

light_warranty_period
integer

Streetlight warranty period length

location
string (ewkt)

Geographical location

luminaire_angle
integer

Luminaire angle. Available from product version 3.2.22

luminaire_product_code
string

Luminaire product code. Available from product version 2026.2.

luminous_flux
integer

Luminous flux

mapper
string

mapper name

mapping_date
string (date)

mapping date

phase_values
Array of object (ElPhaseConnection)

List of phase connection values

object

Connection

purlin_angle
number (float)

purlin angle

purlin_diameter
number (float)

Purlin diameter

reflector_position
string

Reflector position

remarks
string

Remarks. Available from product version 3.2.14.

riser_change_date
string (date-time)

Streetlight riser change date

survey_amount
integer

unknown

choker
integer

Streetlight choker type id

color_rendering_index
integer

Streetlight color rendering index. Available from product version 3.2.20.

color_temperature
integer

Streetlight color temperature type id

contractor
integer

Streetlight contractor id

control_device
integer

Streetlight control device type id. Available from product version 3.2.20.

control_interface
integer

Luminaire-level control interface type id. Available from product version 2026.2.

control_profile
integer

Streetlight control profile type id. Available from product version 3.2.20.

dimming_profile
integer

Configured dimming profile type id. Available from product version 2026.2.

downstream_device
object

Downstream device attached to a streetlight (write/input format). Available from product version 2026.2.

identification
string

Device identification string

Max length250
install_date
string (date)

Device installation date

warranty_period
integer

Warranty period in months

color
integer

Device color id (TxtConstant with groupname COLOR)

downstream_device
integer

Downstream device type id (TxtConstant with groupname EL_LIGHT_DOWNSTREAM_DEVICE)

height_accuracy
integer

Height accuracy id

ik_class
integer

Streetlight IK class type id. Available from product version 3.2.20.

installation_type
integer

Streetlight installation type id

ip_class
integer

Streetlight IP class type id. Available from product version 3.2.20.

lamp_dimmer
integer

Streetlight lamp dimmer type id. Deprecated since product version 2026.2 — use dimming_profile instead.

lamp_dimming_class
integer

Streetlight lamp dimming class id. Deprecated since product version 2026.2 — use dimming_profile instead.

lamp_manufacturer
integer

Streetlight lamp manufacturer id (field hidden in UI but kept for compatibility). Deprecated since product version 2026.2.

lamp_model
integer

Streetlight lamp model id

lamp_power
integer

Light power type id (legacy field name, maps to same field as light_power). Deprecated since product version 2026.2.

lamp_shade
integer

Streetlight lamp shade type id

lamp_socket
integer

Streetlight lamp socket type id

lamp_type
integer

Light source type id (legacy field name, maps to same field as light_source_type). Deprecated since product version 2026.2.

lamp_usage_class
integer

Streetlight lamp usage class id

light_condition
integer

Streetlight condition id

light_connection
integer

Streetlight connection type id

light_distribution
integer

Streetlight distribution type id

light_manufacturer
integer

Streetlight manufacturer id

light_power
integer Required

Light power type id - primary field name since product version 2026.2

light_source_type
integer Required

Light source type id - primary field name since product version 2026.2

light_specifier
integer

Streetlight specifier type id

lightning_class
integer

Streetlight lightning class id

location_accuracy
integer

Location accuracy id

mapping_method
integer

Mapping method id

network_area
integer

Network area id

owner
integer

Owner id

plan
integer

Plan id

pole
integer

Streetlight pole id

protection
integer

Streetlight protection type id. Available from product version 3.2.20.

purlin_holder
integer

Streetlight purlin holder type id

purlin_phase
integer

Streetlight connection phase type id

riser
integer

Streetlight riser cable type id

side_device
object

Side device attached to a streetlight (write/input format). Available from product version 2026.2.

identification
string

Device identification string

Max length250
install_date
string (date)

Device installation date

warranty_period
integer

Warranty period in months

color
integer

Device color id (TxtConstant with groupname COLOR)

side_device
integer

Side device type id (TxtConstant with groupname EL_LIGHT_SIDE_DEVICE)

upstream_device
object

Upstream device attached to a streetlight (write/input format). Available from product version 2026.2.

identification
string

Device identification string

Max length250
install_date
string (date)

Device installation date

warranty_period
integer

Warranty period in months

color
integer

Device color id (TxtConstant with groupname COLOR)

upstream_device
integer

Upstream device type id (TxtConstant with groupname EL_LIGHT_UPSTREAM_DEVICE)

usage_state
integer Required

Usage state id

warranty_fix_type
integer

Warranty fix type id. Available from product version 2025.3.

Responses
201

A created Streetlight

{
  "additional_information": null,
  "choker": null,
  "color_rendering_index": null,
  "color_temperature": null,
  "contractor": null,
  "control_device": null,
  "control_interface": null,
  "control_profile": null,
  "creation_date": "2019-05-03T15:28:22.508Z",
  "creator": "api@keypro.fi",
  "dimming_profile": null,
  "downstream_device": {
    "color": 500020,
    "downstream_device": 500030,
    "identification": "DN-001",
    "install_date": "2026-01-15",
    "warranty_period": 12
  },
  "group_change_date": null,
  "group_cleaning_date": null,
  "height_accuracy": null,
  "id": 1989,
  "ik_class": null,
  "installation_date": null,
  "installation_height": null,
  "installation_type": null,
  "installation_year": null,
  "ip_class": null,
  "lamp_change_date": null,
  "lamp_dimmer": null,
  "lamp_dimmer_change_date": null,
  "lamp_dimming_class": null,
  "lamp_manufacturer": null,
  "lamp_model": null,
  "lamp_position": null,
  "lamp_power": 300270,
  "lamp_shade": null,
  "lamp_socket": null,
  "lamp_type": 300750,
  "lamp_usage_class": null,
  "lamp_warranty_exp_date": null,
  "lamp_warranty_period": null,
  "latest_warranty_fix_date": null,
  "light_change_date": null,
  "light_checkout_date": null,
  "light_condition": null,
  "light_connection": null,
  "light_connection_change_date": null,
  "light_distribution": null,
  "light_manufacturer": null,
  "light_power": 300270,
  "light_source_type": 300750,
  "light_specifier": null,
  "light_warranty_exp_date": null,
  "light_warranty_period": null,
  "lightning_class": null,
  "location": null,
  "location_accuracy": null,
  "luminaire_angle": null,
  "luminaire_product_code": null,
  "luminous_flux": null,
  "mapper": null,
  "mapping_date": null,
  "mapping_method": null,
  "network_area": null,
  "owner": null,
  "phase_values": [
    {
      "phase_1": 0,
      "phase_1_saving": 0,
      "phase_2": 0,
      "phase_2_saving": 0,
      "phase_3": 0,
      "phase_3_saving": 0
    }
  ],
  "plan": null,
  "pole": null,
  "protection": null,
  "purlin_angle": null,
  "purlin_diameter": null,
  "purlin_holder": null,
  "purlin_phase": null,
  "reflector_position": null,
  "remarks": "",
  "riser": null,
  "riser_change_date": null,
  "side_device": null,
  "survey_amount": null,
  "update_date": "2019-05-03T15:28:22.508Z",
  "updated_by": "api@keypro.fi",
  "upstream_device": {
    "color": 500020,
    "identification": "UP-001",
    "install_date": "2026-01-15",
    "upstream_device": 500010,
    "warranty_period": 24
  },
  "usage_state": 303330,
  "warranty_fix_type": null
}
Expand All
object
additional_information
string

Additional information about warranty fix details. Available from product version 2025.3.

creation_date
string (date-time)

creation date and time

creator
string

object creator

group_change_date
string (date-time)

Streetlight group change date

group_cleaning_date
string (date-time)

Streetlight group cleaning date

id
integer

Primary key

installation_date
string (date)

Installation date

installation_height
number (float)

Installation height

installation_year
integer

Installation year

lamp_change_date
string (date-time)

Streetlight lamp change date

lamp_dimmer_change_date
string (date-time)

Streetlight lamp dimmer change date. Deprecated since product version 2026.2 — use dimming_profile instead.

lamp_position
string

Lamp position

lamp_warranty_exp_date
string (date-time)

Streetlight lamp warranty expiration date

lamp_warranty_period
integer

Lamp warranty period length

latest_warranty_fix_date
string (date)

Streetlight latest warranty fix date. Available from product version 2025.3.

light_change_date
string (date-time)

Streetlight change date

light_checkout_date
string (date-time)

Streetlight checkout date

light_connection_change_date
string (date-time)

Streetlight connection change date

light_warranty_exp_date
string (date-time)

Streetlight warranty expiration date

light_warranty_period
integer

Streetlight warranty period length

location
string (ewkt)

Geographical location

luminaire_angle
integer

Luminaire angle. Available from product version 3.2.22

luminaire_product_code
string

Luminaire product code. Available from product version 2026.2.

luminous_flux
integer

Luminous flux

mapper
string

mapper name

mapping_date
string (date)

mapping date

phase_values
Array of object (ElPhaseConnection)

List of phase connection values

object

Connection

phase_1
integer

Streetlight cable connection phase 1

phase_1_saving
integer

Streetlight cable connection phase 1 saving

phase_2
integer

Streetlight cable connection phase 2

phase_2_saving
integer

Streetlight cable connection phase 2 saving

phase_3
integer

Streetlight cable connection phase 3

phase_3_saving
integer

Streetlight cable connection phase 3 saving

purlin_angle
number (float)

purlin angle

purlin_diameter
number (float)

Purlin diameter

reflector_position
string

Reflector position

remarks
string

Remarks. Available from product version 3.2.14.

riser_change_date
string (date-time)

Streetlight riser change date

survey_amount
integer

unknown

update_date
string (date-time)

last update date time

updated_by
string

object last updater

choker
integer

Streetlight choker type id

color_rendering_index
integer

Streetlight color rendering index. Available from product version 3.2.20.

color_temperature
integer

Streetlight color temperature type id

contractor
integer

Streetlight contractor id

control_device
integer

Streetlight control device type id. Available from product version 3.2.20.

control_interface
integer

Luminaire-level control interface type id. Available from product version 2026.2.

control_profile
integer

Streetlight control profile type id. Available from product version 3.2.20.

dimming_profile
integer

Configured dimming profile type id. Available from product version 2026.2.

downstream_device
object

Downstream device attached to a streetlight (write/input format). Available from product version 2026.2.

identification
string

Device identification string

Max length250
install_date
string (date)

Device installation date

warranty_period
integer

Warranty period in months

color
integer

Device color id (TxtConstant with groupname COLOR)

downstream_device
integer

Downstream device type id (TxtConstant with groupname EL_LIGHT_DOWNSTREAM_DEVICE)

height_accuracy
integer

Height accuracy id

ik_class
integer

Streetlight IK class type id. Available from product version 3.2.20.

installation_type
integer

Streetlight installation type id

ip_class
integer

Streetlight IP class type id. Available from product version 3.2.20.

lamp_dimmer
integer

Streetlight lamp dimmer type id. Deprecated since product version 2026.2 — use dimming_profile instead.

lamp_dimming_class
integer

Streetlight lamp dimming class id. Deprecated since product version 2026.2 — use dimming_profile instead.

lamp_manufacturer
integer

Streetlight lamp manufacturer id (field hidden in UI but kept for compatibility). Deprecated since product version 2026.2.

lamp_model
integer

Streetlight lamp model id

lamp_power
integer

Light power type id (legacy field name, maps to same field as light_power). Deprecated since product version 2026.2.

lamp_shade
integer

Streetlight lamp shade type id

lamp_socket
integer

Streetlight lamp socket type id

lamp_type
integer

Light source type id (legacy field name, maps to same field as light_source_type). Deprecated since product version 2026.2.

lamp_usage_class
integer

Streetlight lamp usage class id

light_condition
integer

Streetlight condition id

light_connection
integer

Streetlight connection type id

light_distribution
integer

Streetlight distribution type id

light_manufacturer
integer

Streetlight manufacturer id

light_power
integer

Light power type id - primary field name since product version 2026.2

light_source_type
integer

Light source type id - primary field name since product version 2026.2

light_specifier
integer

Streetlight specifier type id

lightning_class
integer

Streetlight lightning class id

location_accuracy
integer

Location accuracy id

mapping_method
integer

Mapping method id

network_area
integer

Network area id

owner
integer

Owner id

plan
integer

Plan id

pole
integer

Streetlight pole id

protection
integer

Streetlight protection type id. Available from product version 3.2.20.

purlin_holder
integer

Streetlight purlin holder type id

purlin_phase
integer

Streetlight connection phase type id

riser
integer

Streetlight riser cable type id

side_device
object

Side device attached to a streetlight (write/input format). Available from product version 2026.2.

identification
string

Device identification string

Max length250
install_date
string (date)

Device installation date

warranty_period
integer

Warranty period in months

color
integer

Device color id (TxtConstant with groupname COLOR)

side_device
integer

Side device type id (TxtConstant with groupname EL_LIGHT_SIDE_DEVICE)

upstream_device
object

Upstream device attached to a streetlight (write/input format). Available from product version 2026.2.

identification
string

Device identification string

Max length250
install_date
string (date)

Device installation date

warranty_period
integer

Warranty period in months

color
integer

Device color id (TxtConstant with groupname COLOR)

upstream_device
integer

Upstream device type id (TxtConstant with groupname EL_LIGHT_UPSTREAM_DEVICE)

usage_state
integer

Usage state id

warranty_fix_type
integer

Warranty fix type id. Available from product version 2025.3.

400

There was an error in request. Usually field validation failed.

{
  "type": [
    "This field is required."
  ],
  "usage_state": [
    "This field is required."
  ]
}
object

Fields which failed validation

property*
Array of string additionalProperties

List of validation errors for this fieldname

string

Validation error

401

Authentication credentials are missing or invalid

{
  "details": "Authentication credentials were not provided"
}
object

Standard error response payload

details
string

Detailed description of error