Set Robot Lease Period


  • This API is used to modify the lease of a robot.
  • When the set lease is in the past, the robot will be locked after restarting.
  • When the set lease is in the future, a locked robot will be unlocked after restarting.

Authorization Method

Data Dimension Authorization Enterprise-level Authorization This API requires enterprise-level authorization. Both enterprise-level and agent-level authorization accounts can call this API. Please refer to Authorization Methods.
Interface Dimension Authorization Special Authorization This API requires special authorization. You need to apply for interface dimension authorization separately for your authorization account in order to call it. Please refer to Authorization Methods.


Request Entry Point

HTTP URL Path /v1/robot/set_robot_expires_time
Content-Type application/x-www-form-urlencoded
Parameter Type Required Description
Authorization string Yes
  • Access token
  • Format: Bearer access_token
  • Example: Bearer T.WcnhSdYj-kwVBpP27LRQrw.OBt95zE4TH-OPzIX6OkEWPo4rbR6s.ori-67facfd90b2744220a5eae850e51
  • Please refer to: Authentication Methods
Parameter Type Required Description
robot_sn string Yes Robot SN
robot_expires_time int Yes

The end time of the lease. Format is: YYYY-MM-DD +(-)HH:II, +(-)HH:II is the time zone, for example: 2024-04-02 +08:00.

  • Other examples:
    • 2024-04-02 +08:00 (means April 2, 2024, with time zone +08:00)
    • 2024-04-02 -08:00 (means April 2, 2024, with time zone -08:00)
    • 2024-04-02 -08:30 (means April 2, 2024, with time zone -08:30)
    • 2024-04-02 +00:00 (means April 2, 2024, with time zone 0)
# Please replace the entry point with yours according to your region
curl --location 'https://global-openapi.orionstar.com/v1/robot/set_robot_expires_time' \
     --header 'Authorization: Bearer YOUR-ACCESS-TOKEN' \
     --header 'Content-Type: application/x-www-form-urlencoded' \
     --data-urlencode 'robot_sn=test_sn' \
     --data-urlencode 'robot_expires_time=2024-04-02 +08:00'


Parameter Type Description
code int Error code. 0 means success, non-zero means failure, Please refer to Error Codes.
msg string Error description. When there is a failure, a specific error description will be provided.
req_id string Log tracking ID. When encountering problems that require assistance from OrionStar, please provide this tracking ID value.
data object Business data object, see below for details Response Body Data Object.
  • None
    "code": 0,
    "msg": "",
    "data" : {
  • Last modified: 2024-04-09 20:56 +0800