POST /v2/inventory/cmc/tags/detach

Use this API to remove the tag from the systems and partitions.

Note: The /inventory/cmc/tags API does not support the modification of the reserved tags. To manage the resource association for reserved tags, use the /ep/inventory/tags/attach API.

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/ep/inventory/tags/detach 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",

        "Systems": [

            {

                "UUID": "string"

            }

        ],

        "Partitions": [

            {

                "UUID": "string"

            }

        ]

    }

]

URI Request Parameters

This request does not have any parameters.

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/detach

Request Body

The request accepts the following data:

• Name
  The name of the tag that you want to create.
  • Type: String
  • Required: Yes

• Systems
  The systems that you want to tag by using this new tag.
  • Type: Array of objects
  • Required: No

• Partitions
  The partitions that you want to tag by using this new tag.
  • Type: Array of objects
  • Required: No 

• UUID
  The unique identifier of the resource.
  • 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 detach the Test Tag from a partition

POST /api/public/v2/ep/inventory/tags/detach 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 Tag",

        "Partitions": [

            {

                "UUID": "XXXXXXX-XXXXXXXX-XXXXXXX"

            }

        ]

    }

]

Sample Response

After the tag is successfully detached from the partition, the following message is displayed:

{

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

}