# Update settings

API call format

PUT /images/settings              //Use token autorization
{
  "rekognition": {
    "faceDetection": true,
    "celebrities": true,
    "text": true,
    "isActive": true,
    "labels": true,
    "faceSearch": true
  }
}
PUT /images/private/settings      //Use Api Key
{
  "rekognition": {
    "faceDetection": true,
    "celebrities": true,
    "text": true,
    "isActive": true,
    "labels": true,
    "faceSearch": true
  }
}

Description

Update settings

Precondition:

Authorization token/Api key is needed.

Postcondition

On success response code should be 200
On success message for successful settings update is returned.
On failure an error will be returned with the right error code and description.

Example:

[Request] PUT https://<base_api_url>/images/settings         
[Request] PUT https://<base_api_url>/private/settings  
{
  "rekognition": {
    "faceDetection": true,
    "celebrities": true,
    "text": true,
    "isActive": true,
    "labels": true,
    "faceSearch": true
  }
}      
[Request Headers] {"Content-Type":"application/json","Accept":"application/json","Authorization":"<IdToken>"} //Use token autorization
[Request Headers] {"Content-Type":"application/json","Accept":"application/json","X-Api-Key":"<api_key>"}     //Use Api Key

[Response] 200
[Response Headers] {"Content-Type":["application/json"],"Content-Length":["..."],"Connection":["keep-alive"],"Date":["..... GMT"],"x-amzn-RequestId":["....."],....]}
[Response] 
{
	"status": true,
	"data": "Item was updated successfully"
}

← Get Settings List All Pools →