Page optimized for desktop experience. Please use a desktop browser for best compatibility.

Extend User API Key Session

This endpoint is used to extend the current user API key session by preventing it from timing out. Successful completion will return a new expiration date and time which will then expire the session at that new date and time.

POST
/api/v2/auth/extend-session-timeout/{apiKey}

Request Body

application/json

{"apiKey": "xxxxx-xxx-x-xxxxxxx-xxxxxxxx" }

Parameter Type Validations
apiKey path, required api key of user trying to extend the session timeout

Response Messages

Successful response

{
"{
"expiration": "2020-08-12T17:55:27.009Z"
}
"
}

Unauthorized error

Internal server error