Tags
GET Distribution Tags#
Get all distribution tags.
| GET ALL | |
|---|---|
| Method | GET ALL |
| URL or EndPoint | /api/v{version}/projects/{projectId}/distributions/{distributionId}/tags |
| Headers | Authorization |
| Parameters | distributionId, 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 |
| {distributionId} | Yes | string | "string" | Shows the distribution id |
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 |
| distributionId | Yes | string | "string" | Shows the distribution 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.
[ { "id": 0, "distributionId": "string", "key": "string", "value": "string" }]
| Field Name | Type | Example | Description |
|---|---|---|---|
| id | int | 0 | Returns the tag id |
| distributionId | string | "string" | Return the distribution id |
| 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 Distribution Tag#
Create a distribution tag.
| POST | |
|---|---|
| Method | POST |
| URL or EndPoint | /api/v{version}/projects/{projectId}/distributions/{distributionId}/tags |
| Headers | Authorization |
| Parameters | projectId, version, distributionId |
| Body | {id, distributionId, 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 |
| {distributionId} | Yes | string | "string" | Shows the distribution 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 |
| projectId | Yes | string | 2e21fae6-af4c-4a4a-e0fc-08d903f55711 | Id of the project |
| distributionId | Yes | string | "string" | Shows the distribution id |
Request body#
[ { "id": 0, "distributionId": "string", "key": "string", "value": "string" }]The description of the parameters is as follows:
| Body Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| id | Yes | int | 0 | |
| distributionId | Yes | string | "string" | |
| 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.
[ { "id": 0, "distributionId": "string", "key": "string", "value": "string" }]
| Field Name | Type | Example | Description |
|---|---|---|---|
| id | int | 0 | Returns the tag id |
| distributionId | string | "string" | Return the distribution id |
| 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
Get Distribution Tag#
Get a distribution tag.
| GET | |
|---|---|
| Method | GET |
| URL or EndPoint | /api/v{version}/projects/{projectId}/distributions/{distributionId}/tags/{id} |
| Headers | Authorization |
| Parameters | id, distributionId, projectId, version |
| 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 |
| {distributionId} | Yes | string | "string" | Shows the distribution id |
| {id} | Yes | int | 0 | Shows the tag 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 |
| projectId | Yes | string | 2e21fae6-af4c-4a4a-e0fc-08d903f55711 | Id of the project |
| distributionId | Yes | string | "string" | Shows the distribution id |
| id | Yes | int | 0 | Shows the tag id |
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.
[ { "id": 0, "distributionId": "string", "key": "string", "value": "string" }]
| Field Name | Type | Example | Description |
|---|---|---|---|
| id | int | 0 | Returns the tag id |
| distributionId | string | "string" | Return the distribution id |
| 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
PUT Distribution Tag#
Updates a distribution tag.
| PUT | |
|---|---|
| Method | PUT |
| URL or EndPoint | /api/v{version}/projects/{projectId}/distributions/{distributionId}/tags/{id} |
| Headers | Authorization |
| Parameters | projectId, version, name |
| Body | {id, distributionId, 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 |
| {distributionId} | Yes | string | "string" | Shows the distribution id |
| {id} | Yes | int | 0 | Shows the tag 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 |
| projectId | Yes | string | 2e21fae6-af4c-4a4a-e0fc-08d903f55711 | Id of the project |
| distributionId | Yes | string | "string" | Shows the distribution id |
| id | Yes | int | 0 | Shows the tag id |
Request body#
[ { "id": 0, "distributionId": "string", "key": "string", "value": "string" }]The description of the parameters is as follows:
| Body Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| id | Yes | int | 0 | |
| distributionId | Yes | string | "string" | |
| 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.
[ { "id": 0, "distributionId": "string", "key": "string", "value": "string" }]
| Field Name | Type | Example | Description |
|---|---|---|---|
| id | int | 0 | Returns the tag id |
| distributionId | string | "string" | Return the distribution id |
| 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 Distribution Tag#
Delete a distribution tag.
| DELETE | |
|---|---|
| Method | DELETE |
| URL or EndPoint | /api/v{version}/projects/{projectId}/distributions/{distributionId}/tags/{id} |
| Headers | Authorization |
| Parameters | id, distributionId, projectId, version |
| 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 |
| {distributionId} | Yes | string | "string" | Shows the distribution id |
| {id} | Yes | int | 0 | Shows the tag 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 |
| projectId | Yes | string | 2e21fae6-af4c-4a4a-e0fc-08d903f55711 | Id of the project |
| distributionId | Yes | string | "string" | Shows the distribution id |
| id | Yes | int | 0 | Shows the tag id |
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.
[ { "id": 0, "distributionId": "string", "key": "string", "value": "string" }]
| Field Name | Type | Example | Description |
|---|---|---|---|
| id | int | 0 | Returns the tag id |
| distributionId | string | "string" | Return the distribution id |
| 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