Tags
GET Tags#
Get all bucket tags.
| GET ALL | |
|---|---|
| Method | GET ALL |
| URL or EndPoint | /api/v{version}/projects/{projectId}/buckets/{name}/tags |
| Headers | Authorization |
| Parameters | name, version, projectId |
| 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 |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| 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 |
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": [ { "key": "string", "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] | Return the result of bucket tags | |
| key | string | "string" | Returns the unique key of the tag |
| value | string | "string" | Returns the value of the tag |
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
POST Tag#
Create a bucket tag.
| POST | |
|---|---|
| Method | POST |
| URL or EndPoint | /api/v{version}/projects/{projectId}/buckets/{name}/tags |
| Headers | Authorization |
| Parameters | projectId, version, name |
| Body | {tags, key, value } |
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#
{ "tags": [ { "key": "string", "value": "string" } ]}The description of the parameters is as follows:
| Body Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| tags | Yes | string | "string" | Sends bucket tags |
| key | Yes | string | "string" | Sends the unique key of the tag |
| value | Yes | string | "string" | Sends the value of the tag |
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": [ { "key": "string", "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 | |
| tags | string | "string" | Returns bucket tags |
| key | string | "string" | Returns the unique key of the tag |
| value | string | "string" | Returns the value of the tag |
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
PUT Tag#
Updates a bucket file listing.
| PUT | |
|---|---|
| Method | PUT |
| URL or EndPoint | /api/v{version}/projects/{projectId}/buckets/{name}/tags |
| Headers | Authorization |
| Parameters | projectId, version, name |
| Body | {tags, key, value } |
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#
{ "tags": [ { "key": "string", "value": "string" } ]}The description of the parameters is as follows:
| Body Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| tags | Yes | string | "string" | Sends bucket tags |
| key | Yes | string | "string" | Sends the unique key of the tag |
| value | Yes | string | "string" | Sends the value of the tag |
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": [ { "key": "string", "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 | |
| tags | string | "string" | Returns bucket tags |
| key | string | "string" | Returns the unique key of the tag |
| value | string | "string" | Returns the value of the tag |
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 Tag#
Delete or Empty a bucket.
| DELETE | |
|---|---|
| Method | DELETE |
| URL or EndPoint | /api/v{version}/projects/{projectId}/buckets/{name}/tags/{key} |
| Headers | Authorization |
| Parameters | name, projectId, version, key, deleteAll |
| 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 |
| tags | Yes | string | "string" | Shows the bucket tag |
| {key} | Yes | string | "string" | Shows the bucket tag key |
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 |
| key | Yes | string | "string" | Enter the bucket tag key if you want to delete a specific tag |
| deleteAll | Yes | bool | true | Select the deleteAll, if you want to delete all bucket tags select true, if you want to delete a specific bucket tag select false |
Request Body#
"string"
The description of the parameters is as follows:
| Body Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| key | No | bool | "string" | Sends bucket tags key if you want to delete a specific tag |
Responses#
If the action is successful, the service sends back an HTTP 200 response.
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