POST /v2/inventory/cmc/tags/

Use this API to rename the tag. You can rename only one tag at a time.

Resource Information

Response formats	JSON
Requires authentication?	Yes
Rate limited?	All API calls are automatically rate limited to a maximum of 10 calls per second.

Request Syntax

POST /api/public/v2/inventory/cmc/tags/Test 3 HTTP/1.1
Host: xxxxxxxxxxxx.powercmc.com
x-cmc-client-id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
x-cmc-client-secret: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Content-Type: application/json

[

    {

        "Name": "string"

    }

]

URI Request Parameters

The request uses the following URI parameters:

Parameter	Required?	Description
tag_name	Yes	The name of the tag that you want to rename.

Request Headers

Authenticate the API by completing the following steps:

1. Set your client ID value in the X-CMC-Client-Id header in every request.
2. Set the client secret value in the X-CMC-Client-Secret header in every request.

To form the CMC API full URL, append the relative path of the endpoint you want to use to the Base URL. 

Example: https://<portal-url>/api/public/v2/ inventory/cmc/tags/{tag_name}

Request Body

The request accepts the following data:

• Name
  The new name for the tag.
  • Type: String
  • Required: Yes

Errors

The following errors are the common errors for this API:

BadRequestException
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
HTTP Status Code: 400

UnauthorizedException
The request is denied because the caller has insufficient permissions.
HTTP Status Code: 401

NotFoundException
The requested resource is not found. Make sure that the request URI is correct.
HTTP Status Code: 404

TooManyRequestsException
The request has reached its throttling limit. Retry after the specified time.
HTTP Status Code: 429

Sample Requests

Review the following examples to understand how the API request and response work.

Sample request to rename the Test 3 tag to Test 4

POST /api/public/v2/inventory/cmc/tags/Test 3 HTTP/1.1
Host: xxxxxxxxxxxx.powercmc.com
x-cmc-client-id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
x-cmc-client-secret: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Content-Type: application/json

[

    {

        "Name": "Test 4"

    }

]

Sample Response

If the action is successful, an HTTP 200 response is received from the service:

I

    "message": "Tag(s) renamed successfully"

}