# Update Existing Pool

API call format

PUT images/pools/{guid}         //Use token authorization
{
  "name": "<pool_name>",
  "bucket": "<pool_bucket>",
  "patterns": [
    "<pool_pattern_1>",
    "<pool_pattern_2>",
  ]
}
PUT images/private/pools/{guid} //Use Api key
{
  "name": "<pool_name>",
  "bucket": "<pool_bucket>",
  "patterns": [
    "<pool_pattern_1>",
    "<pool_pattern_2>",
  ]
}

Description

Update existing pool

Precondition:

Authorization token/Api key is needed.
Mandatory elements:
- <pool_guid> - valid pool guid. Take a specific pool guid by using Pools list API call.
- name - pool name
- bucket - pool bucket
- patterns - regex patterns for filtering. Should be a valid regular expression

Postcondition:

On success response code should be 200.
On success JSON formatted details for all pools are returned.
On failure an error will be returned with the right error code and description.

Example:

[Request] PUT https://<base_api_url>/images/pools/{guid}
{
  "name": "<pool_name>",
  "bucket": "<pool_bucket>",
  "patterns": [
    "<pool_pattern_1>",
    "<pool_pattern_2>",
    ...
  ]
}
[Request] PUT https://<base_api_url>/images/private/pools/{guid}
{
  "name": "<pool_name>",
  "bucket": "<pool_bucket>",
  "patterns": [
    "<pool_pattern_1>",
    "<pool_pattern_2>",
  ]
}
[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":["....."],....]}
[Responce]
{
  "status": true,
  "data": "Item was updated successfully"
}

← Store New Pool Delete Existing Pool →