Lifecycle
GET Lifecycles#
Get all bucket lifecycle configuration.
| GET | |
|---|---|
| Method | GET |
| URL or EndPoint | /api/v{version}/projects/{projectId}/buckets/{name}/lifecycle |
| Headers | Authorization |
| Parameters | version, projectId, name |
| Body | Not Applicable |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| v{version} | Yes | string | v1 | Shows the version of API |
| {projectId} | Yes | Guid | f5faa2e3-316b-4dd0-8f4d-ab41f6f71bd6 | Shows the id of project |
| {name} | Yes | string | string | Shows the name of bucket |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| Version | Yes | string($uuid) | v1 | Shows the version of API |
| Project Id | Yes | string($Guid) | f5faa2e3-316b-4dd0-8f4d-ab41f6f71bd6 | Shows the project id of API |
| Name | Yes | string | randomstring | Shows the bucket name |
Request body#
The request does not have a request body.
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{ "success": true, "errors": [ "string" ], "messages": [ "string" ], "result": [ { "id": "string", "status": "string", "expiration": { "dateUtc": "2022-03-31T14:27:14.768Z", "days": 0, "expiredObjectDeleteMarker": true } } ], "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}
| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will return false |
| errors | array [] | "string" | Indicate if there was an error |
| messages | array [] | "string" | Returns the response message from back-end |
| result | array [object] | Return a list of created buckets | |
| id | string | "string" | Returns the name of a bucket |
| status | long | 1234 | Returns the status of bucket lifecycle Disabled or Enabled |
| expiration | array [object] | Returns an expiration object of bucket lifecycle | |
| dateUtc | DateTime | "2022-03-31T14:27:14.768Z | Returns the date time of expiration of bucket lifecycle |
| days | int | 0 | Returns the number of days. |
| expiredObjectDeleteMarker | bool | true | Returns the delete marker of expired object |
| resultInfo | array [object] | Returns an object of behavior | |
| totalCount | integer($int32) | 0 | How many records of behavior entity are in database |
| pageIndex | integer($int32) | 0 | Returns how many pages of paganed data are |
| pageSize | integer($int32) | 0 | Returns paganed data |
| totalPages | integer($int32) | 0 | How many pages |
| hasNextPage | bool | true | Returns the next page of paganed data |
| hasPreviousPage | bool | true | Returns the previous page of paganed data |
Errors#
For information about the errors that are common to all actions, see Common Errors:
HTTP Status Code: 401 Unauthorized
HTTP Status Code: 403 Forbidden
HTTP Status Code: 404 If the service is down
POST Lifecycle#
Create a bucket lifecycle.
| POST | |
|---|---|
| Method | POST |
| URL or EndPoint | /api/v{version}/projects/{projectId}/buckets/{name}/lifecycle |
| Headers | Authorization |
| Parameters | projectId, version |
| Body | {id, lifecyclePrefixPredicate, lifecycleTagPredicate, expiration, status, abortIncompleteMultipartUpload, noncurrentVersionExpiration, noncurrentVersionTransitions, transitions} |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| v{version} | Yes | string | v1 | Shows the version of API |
| {projectId} | Yes | string | 2e21fae6-af4c-4a4a-e0fc-08d903f55711 | Shows the project Id |
| {name} | Yes | string | string | Shows the bucket name |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| version | Yes | string($uuid) | v1 | Shows the version of API |
| projectId | Yes | string | 2e21fae6-af4c-4a4a-e0fc-08d903f55711 | Id of the project |
| {name} | Yes | string | string | Shows the bucket name |
Request body#
{ "id": "string", "lifecyclePrefixPredicate": { "prefix": "string" }, "lifecycleTagPredicate": { "tag": { "key": "string", "value": "string" } }, "expiration": { "dateUtc": "2022-03-31T14:36:48.792Z", "days": 0, "expiredObjectDeleteMarker": true }, "status": "string", "abortIncompleteMultipartUpload": { "daysAfterInitiation": 0 }, "noncurrentVersionExpiration": { "newerNoncurrentVersions": 0, "noncurrentDays": 0 }, "noncurrentVersionTransitions": [ { "newerNoncurrentVersions": 0, "noncurrentDays": 0, "storageClass": {} } ], "transitions": [ { "dateUtc": "2022-03-31T14:36:48.792Z", "days": 0, "storageClass": {} } ]}The description of the parameters is as follows:
| Body Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| id | Yes | string | "string" | Sends the bucketName |
| lifecyclePrefixPredicate | Yes | array[object] | Sends the object of lifecycle prefix predicate | |
| prefix | Yes | bool | true | Sends the prefix |
| lifecycleTagPredicate | Yes | array[object] | Sends object of lifecycle tag predicate | |
| tag | Yes | array[object] | Sends object lock of the tag | |
| key | Yes | string | "string" | Sends the unique key of the tag |
| value | Yes | string | "string" | Sends the value of the tag |
| expiration | Yes | array[object] | Sends object of lifecycle expiration | |
| dateUtc | Yes | DateTime | "2022-03-31T14:36:48.792Z" | Sends the date time of lifecycle |
| days | Yes | int | 31 | Sends days of lifecycle expiration |
| expiredObjectDeleteMarker | Yes | bool | true | Sends the delete marker of expired object |
| status | Yes | "string" | string | Sends status of lifecycle Disabled or Enabled |
| abortIncompleteMultipartUpload | Yes | array[object] | Sends the object of abort incomplete multipart upload | |
| daysAfterInitiation | Yes | int | 0 | Sends number of days after initiation |
| noncurrentVersionExpiration | Yes | array[object] | Sends object of noncurrent version expiration | |
| newerNoncurrentVersions | Yes | int | 0 | Sends the newer noncurrent versions |
| noncurrentDays | Yes | int | 0 | Sends the noncurrent days |
| noncurrentVersionTransitions | Yes | array[object] | Sends the object of noncurrent version transitions | |
| newerNoncurrentVersions | Yes | int | 0 | Sends the newer noncurrent versions |
| noncurrentDays | Yes | int | 0 | Sends the noncurrent days |
| storageClass | No | array[object] | Sends the object of storage classes | |
| transitions | Yes | array[object] | Sends the object of transitions | |
| dateUtc | Yes | DateTime | "2022-03-31T14:36:48.792Z" | Sends the date time of lifecycle |
| days | Yes | int | 31 | Sends days of lifecycle expiration |
| storageClass | No | array[object] | Sends the object of storage classes |
Responses#
If the action is successful, the service sends back an HTTP 201 response.
The following data is returned in json format by the service.
{ "success": true, "errors": [ "string" ], "messages": [ "string" ], "result": { "id": "string", "abortIncompleteMultipartUpload": { "daysAfterInitiation": 0 }, "expiration": { "dateUtc": "2022-03-31T15:02:28.989Z", "days": 0, "expiredObjectDeleteMarker": true }, "noncurrentVersionExpiration": { "newerNoncurrentVersions": 0, "noncurrentDays": 0 }, "filter": { "lifecycleFilterPredicate": {} }, "prefixFilter": { "prefix": "string" }, "tagFilter": { "tag": { "key": "string", "value": "string" } }, "status": { "value": "string" }, "noncurrentVersionTransitions": [ { "newerNoncurrentVersions": 0, "noncurrentDays": 0, "storageClass": { "value": "string" } } ], "transitions": [ { "dateUtc": "2022-03-31T15:02:28.990Z", "days": 0, "storageClass": { "value": "string" } } ] }, "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0,}| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will return false |
| errors | array [] | "string" | Indicate if there was an error |
| messages | array [] | "string" | Returns the response message from back-end |
| result | array [object] | Returns the result of created bucket | |
| id | string | "string" | Sends the bucketName |
| abortIncompleteMultipartUpload | array[object] | Returns the object of abort incomplete multipart upload | |
| daysAfterInitiation | int | 0 | Returns number of days after initiation |
| expiration | array[object] | Returns object of lifecycle expiration | |
| dateUtc | DateTime | "2022-03-31T14:36:48.792Z" | Returns the date time of lifecycle |
| days | int | 31 | Returns days of lifecycle expiration |
| expiredObjectDeleteMarker | bool | true | Returns the delete marker of expired object |
| noncurrentVersionExpiration | array[object] | Returns object of noncurrent version expiration | |
| newerNoncurrentVersions | int | 0 | Returns the newer noncurrent versions |
| noncurrentDays | int | 0 | Returns the noncurrent days |
| filter | array[object] | Returns the object of lifecycle filer | |
| lifecycleFilterPredicate | array[object] | Returns the lifecycle filter predicate | |
| prefixFilter | array[object] | Returns the object of prefix filter | |
| prefix | "string" | string | Returns the prefix |
| tagFilter | array[object] | Returns the object of lifecycle tag filter | |
| tag | array[object] | Returns object of the tag | |
| key | string | "string" | Returns the unique key of the tag |
| value | string | "string" | Returns the value of the tag |
| status | "string" | string | Returns status of lifecycle Disabled or Enabled |
| noncurrentVersionTransitions | array[object] | Returns the object of noncurrent version transitions | |
| newerNoncurrentVersions | int | 0 | Returns the newer noncurrent versions |
| noncurrentDays | int | 0 | Returns the noncurrent days |
| storageClass | array[object] | Returns the object of storage classes | |
| transitions | array[object] | Returns the object of transitions | |
| dateUtc | DateTime | "2022-03-31T14:36:48.792Z" | Returns the date time of lifecycle |
| days | int | 31 | Returns days of lifecycle expiration |
| storageClass | array[object] | Returns the object of storage classes |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 400 Bad Request
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
- HTTP Status Code: 404 Not found
GET Lifecycle#
Get bucket lifecycle configuration.
| GET | |
|---|---|
| Method | GET |
| URL or EndPoint | /api/v{version}/projects/{projectId}/buckets/{name}/lifecycle/{id} |
| Headers | Authorization |
| Parameters | version, projectId,name |
| Body | Not Applicable |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| v{version} | Yes | string | v1 | Shows the version of API |
| {projectId} | Yes | Guid | f5faa2e3-316b-4dd0-8f4d-ab41f6f71bd6 | Shows the id of project |
| {name} | Yes | string | "string" | Shows the name of the bucket |
| {id} | Yes | string | "string" | Shows the lifecycle id |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| Version | Yes | string($uuid) | v1 | Shows the version of API |
| Project Id | Yes | string($Guid) | f5faa2e3-316b-4dd0-8f4d-ab41f6f71bd6 | Shows the project id of API |
| Name | Yes | string | "string" | Shows the name of the bucket |
| Id | Yes | string | "string" | Shows the lifecycle id |
Request body#
The request does not have a request body.
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{ "success": true, "errors": [ "string" ], "messages": [ "string" ], "result": { "id": "string", "abortIncompleteMultipartUpload": { "daysAfterInitiation": 0 }, "expiration": { "dateUtc": "2022-04-01T07:16:54.007Z", "days": 0, "expiredObjectDeleteMarker": true }, "noncurrentVersionExpiration": { "newerNoncurrentVersions": 0, "noncurrentDays": 0 }, "filter": { "lifecycleFilterPredicate": {} }, "prefixFilter": { "prefix": "string" }, "tagFilter": { "tag": { "key": "string", "value": "string" } }, "status": { "value": "string" }, "noncurrentVersionTransitions": [ { "newerNoncurrentVersions": 0, "noncurrentDays": 0, "storageClass": { "value": "string" } } ], "transitions": [ { "dateUtc": "2022-04-01T07:16:54.007Z", "days": 0, "storageClass": { "value": "string" } } ] }, "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}
| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will return false |
| errors | array [] | "string" | Indicate if there was an error |
| messages | array [] | "string" | Returns the response message from back-end |
| result | array [object] | Returns the result of created bucket | |
| id | string | "string" | Sends the bucketName |
| abortIncompleteMultipartUpload | array[object] | Returns the object of abort incomplete multipart upload | |
| daysAfterInitiation | int | 0 | Returns number of days after initiation |
| expiration | array[object] | Returns object of lifecycle expiration | |
| dateUtc | DateTime | "2022-03-31T14:36:48.792Z" | Returns the date time of lifecycle |
| days | int | 31 | Returns days of lifecycle expiration |
| expiredObjectDeleteMarker | bool | true | Returns the delete marker of expired object |
| noncurrentVersionExpiration | array[object] | Returns object of noncurrent version expiration | |
| newerNoncurrentVersions | int | 0 | Returns the newer noncurrent versions |
| noncurrentDays | int | 0 | Returns the noncurrent days |
| filter | array[object] | Returns the object of lifecycle filer | |
| lifecycleFilterPredicate | array[object] | Returns the lifecycle filter predicate | |
| prefixFilter | array[object] | Returns the object of prefix filter | |
| prefix | "string" | string | Returns the prefix |
| tagFilter | array[object] | Returns the object of lifecycle tag filter | |
| tag | array[object] | Returns object of the tag | |
| key | string | "string" | Returns the unique key of the tag |
| value | string | "string" | Returns the value of the tag |
| status | "string" | string | Returns status of lifecycle Disabled or Enabled |
| noncurrentVersionTransitions | array[object] | Returns the object of noncurrent version transitions | |
| newerNoncurrentVersions | int | 0 | Returns the newer noncurrent versions |
| noncurrentDays | int | 0 | Returns the noncurrent days |
| storageClass | array[object] | Returns the object of storage classes | |
| transitions | array[object] | Returns the object of transitions | |
| dateUtc | DateTime | "2022-03-31T14:36:48.792Z" | Returns the date time of lifecycle |
| days | int | 31 | Returns days of lifecycle expiration |
| storageClass | array[object] | Returns the object of storage classes |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
- HTTP Status Code: 404 Not found
PUT Lifecycle#
Update bucket lifecycle configuration
| PUT | |
|---|---|
| Method | PUT |
| URL or EndPoint | /api/v{version}/projects/{projectId}/buckets/{name}/lifecycle/{id} |
| Headers | Authorization |
| Parameters | projectId, version, name, id |
| Body | {id, lifecyclePrefixPredicate, lifecycleTagPredicate, expiration, status, abortIncompleteMultipartUpload, noncurrentVersionExpiration, noncurrentVersionTransitions, transitions} |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| v{version} | Yes | string | v1 | Shows the version of API |
| {projectId} | Yes | string | 2e21fae6-af4c-4a4a-e0fc-08d903f55711 | Shows the project Id |
| name | Yes | string | "string" | Shows the bucket name |
| id | Yes | string | "string" | Shows the id of lifecycle |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| version | Yes | string($uuid) | v1 | Shows the version of API |
| projectId | Yes | string | 2e21fae6-af4c-4a4a-e0fc-08d903f55711 | Put the id of project |
| name | Yes | string | "string" | Put the bucket name |
| id | Yes | string | "string" | Shows the id of lifecycle |
Request body#
{ "id": "string", "lifecyclePrefixPredicate": { "prefix": "string" }, "lifecycleTagPredicate": { "tag": { "key": "string", "value": "string" } }, "expiration": { "dateUtc": "2022-03-31T14:36:48.792Z", "days": 0, "expiredObjectDeleteMarker": true }, "status": "string", "abortIncompleteMultipartUpload": { "daysAfterInitiation": 0 }, "noncurrentVersionExpiration": { "newerNoncurrentVersions": 0, "noncurrentDays": 0 }, "noncurrentVersionTransitions": [ { "newerNoncurrentVersions": 0, "noncurrentDays": 0, "storageClass": {} } ], "transitions": [ { "dateUtc": "2022-03-31T14:36:48.792Z", "days": 0, "storageClass": {} } ]}The description of the parameters is as follows:
| Body Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| id | Yes | string | "string" | Sends the bucketName |
| lifecyclePrefixPredicate | Yes | array[object] | Sends the object of lifecycle prefix predicate | |
| prefix | Yes | bool | true | Sends the prefix |
| lifecycleTagPredicate | Yes | array[object] | Sends object of lifecycle tag predicate | |
| tag | Yes | array[object] | Sends object lock of the tag | |
| key | Yes | string | "string" | Sends the unique key of the tag |
| value | Yes | string | "string" | Sends the value of the tag |
| expiration | Yes | array[object] | Sends object of lifecycle expiration | |
| dateUtc | Yes | DateTime | "2022-03-31T14:36:48.792Z" | Sends the date time of lifecycle |
| days | Yes | int | 31 | Sends days of lifecycle expiration |
| expiredObjectDeleteMarker | Yes | bool | true | Sends the delete marker of expired object |
| status | Yes | "string" | string | Sends status of lifecycle Disabled or Enabled |
| abortIncompleteMultipartUpload | Yes | array[object] | Sends the object of abort incomplete multipart upload | |
| daysAfterInitiation | Yes | int | 0 | Sends number of days after initiation |
| noncurrentVersionExpiration | Yes | array[object] | Sends object of noncurrent version expiration | |
| newerNoncurrentVersions | Yes | int | 0 | Sends the newer noncurrent versions |
| noncurrentDays | Yes | int | 0 | Sends the noncurrent days |
| noncurrentVersionTransitions | Yes | array[object] | Sends the object of noncurrent version transitions | |
| newerNoncurrentVersions | Yes | int | 0 | Sends the newer noncurrent versions |
| noncurrentDays | Yes | int | 0 | Sends the noncurrent days |
| storageClass | No | array[object] | Sends the object of storage classes | |
| transitions | Yes | array[object] | Sends the object of transitions | |
| dateUtc | Yes | DateTime | "2022-03-31T14:36:48.792Z" | Sends the date time of lifecycle |
| days | Yes | int | 31 | Sends days of lifecycle expiration |
| storageClass | No | array[object] | Sends the object of storage classes |
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{ "success": true, "errors": [ "string" ], "messages": [ "string" ], "result": { "abortIncompleteMultipartUpload": { "daysAfterInitiation": 0 }, "expiration": { "dateUtc": "2022-03-31T15:45:49.470Z", "days": 0, "expiredObjectDeleteMarker": true }, "id": "string", "noncurrentVersionExpiration": { "newerNoncurrentVersions": 0, "noncurrentDays": 0 }, "lifecyclePrefixPredicate": { "prefix": "string" }, "lifecycleTagPredicate": { "tag": { "key": "string", "value": "string" } }, "status": { "value": "string" }, "noncurrentVersionTransitions": [ { "newerNoncurrentVersions": 0, "noncurrentDays": 0, "storageClass": { "value": "string" } } ], "transitions": [ { "dateUtc": "2022-03-31T15:45:49.470Z", "days": 0, "storageClass": { "value": "string" } } ] }, "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will return false |
| errors | array [] | "string" | Indicate if there was an error |
| messages | array [] | "string" | Returns the response message from back-end |
| result | array [object] | Returns the result of created bucket | |
| id | string | "string" | Sends the bucketName |
| abortIncompleteMultipartUpload | array[object] | Returns the object of abort incomplete multipart upload | |
| daysAfterInitiation | int | 0 | Returns number of days after initiation |
| expiration | array[object] | Returns object of lifecycle expiration | |
| dateUtc | DateTime | "2022-03-31T14:36:48.792Z" | Returns the date time of lifecycle |
| days | int | 31 | Returns days of lifecycle expiration |
| expiredObjectDeleteMarker | bool | true | Returns the delete marker of expired object |
| noncurrentVersionExpiration | array[object] | Returns object of noncurrent version expiration | |
| newerNoncurrentVersions | int | 0 | Returns the newer noncurrent versions |
| noncurrentDays | int | 0 | Returns the noncurrent days |
| lifecycleFilterPredicate | array[object] | Returns the lifecycle filter predicate | |
| prefix | "string" | string | Returns the prefix |
| lifecycleTagPredicate | array[object] | Returns the object of lifecycle tag filter | |
| tag | array[object] | Returns object of the tag | |
| key | string | "string" | Returns the unique key of the tag |
| value | string | "string" | Returns the value of the tag |
| status | "string" | string | Returns status of lifecycle Disabled or Enabled |
| noncurrentVersionTransitions | array[object] | Returns the object of noncurrent version transitions | |
| newerNoncurrentVersions | int | 0 | Returns the newer noncurrent versions |
| noncurrentDays | int | 0 | Returns the noncurrent days |
| storageClass | array[object] | Returns the object of storage classes | |
| transitions | array[object] | Returns the object of transitions | |
| dateUtc | DateTime | "2022-03-31T14:36:48.792Z" | Returns the date time of lifecycle |
| days | int | 31 | Returns days of lifecycle expiration |
| storageClass | array[object] | Returns the object of storage classes |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 400 Bad Request
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
- HTTP Status Code: 404 Not found
DELETE Lifecycle#
Delete bucket lifecycle configuration
| DELETE | |
|---|---|
| Method | DELETE |
| URL or EndPoint | /api/v{version}/projects/{projectId}/buckets/{name}/lifecycle/{id} |
| Headers | Authorization |
| Parameters | name, projectId, version, id |
| Body | Not Applicable |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| v{version} | Yes | string | v1 | Shows the version of API |
| {projectId} | Yes | string | 2e21fae6-af4c-4a4a-e0fc-08d903f55711 | Shows the project Id |
| name | Yes | string | "string" | Shows the bucket name |
| id | Yes | string | "string" | Shows the id of lifecycle |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| v{version} | Yes | string | v1 | Shows the version of API |
| {projectId} | Yes | string | 2e21fae6-af4c-4a4a-e0fc-08d903f55711 | Shows the project Id |
| name | Yes | string | "string" | Shows the bucket name |
| id | Yes | string | "string" | Shows the id of lifecycle |
Request Body#
The request does not have a request body.
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{ "success": true, "errors": [ "string" ], "messages": [ "string" ], "result": true, "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will return false |
| errors | array [] | "string" | Indicate if there was an error |
| messages | array [] | "string" | Returns the response message from back-end |
| result | string | "string" | Return the result of updated bucket |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
- HTTP Status Code: 404 Not found