NSX-T Data Center REST API

Associated URIs:

API Description API Path

Delete tag attachments


Delete tag attachments
DELETE /policy/api/v1/infra/categories/{category-id}/tags/{tag-id}/attachments
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/categories/{category-id}/tags/{tag-id}/attachments

Get tag attachments


Get tag attachments
GET /policy/api/v1/infra/categories/{category-id}/tags/{tag-id}/attachments
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/categories/{category-id}/tags/{tag-id}/attachments

Create or update vm tag attachment


Create or update vm tag attachment
PATCH /policy/api/v1/infra/categories/{category-id}/tags/{tag-id}/attachments
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/categories/{category-id}/tags/{tag-id}/attachments

List all unique tags.


Returns paginated list of all unique tags. Supports filtering by scope, tag and
source from which tags are synced. Supports starts with, ends with, equals and
contains operators on scope and tag values.
To filter tags by starts with on scope or tag, use '*' as suffix after the value.
To filter tags by ends with on scope or tag, use '*' as prefix before the value.
To filter tags by contain on scope or tag, use '*' as prefix and suffix on the value.
Below special characters in the filter value needs to be escaped with hex values.
- Character '&' needs to be escaped as '%26'
- Character '[' needs to be escaped as '%5B'
- Character ']' needs to be escaped as '%5D'
- Character '+' needs to be escaped as '%2B'
- Character '#' needs to be escaped as '%23'
Sort option for list of unique tags is available only on tag and scope properties.
GET /policy/api/v1/infra/tags
GET /policy/api/v1/global-infra/tags
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tags

List all objects assigned with matching scope and tag values


Paginated list of all objects assigned with matching scope and tag values. Objects
are represented in form of resource reference. Sort option is available only on
target_type and target_display_name properties.
GET /policy/api/v1/infra/tags/effective-resources
GET /policy/api/v1/global-infra/tags/effective-resources
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tags/effective-resources

Get details of tag bulk operation request


Get details of tag bulk operation request with which tag is applied or removed
on virtual machines.
GET /policy/api/v1/infra/tags/tag-operations/{operation-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tags/tag-operations/{operation-id}

Assign or Unassign tag on multiple Virtual Machines.


Tag can be assigned or unassigned on multiple objects. Supported object type is
restricted to Virtual Machine for now and support for other objects will be added
later. Permissions for tag bulk operation would be similar to virtual machine
tag permissions.
PUT /policy/api/v1/infra/tags/tag-operations/{operation-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tags/tag-operations/{operation-id}

Get status of tag bulk operation


Get status of tag bulk operation with details of tag operation on each virtual machine.
GET /policy/api/v1/infra/tags/tag-operations/{operation-id}/status
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tags/tag-operations/{operation-id}/status

Delete tag attachments for a VPC


Delete tag attachments for a VPC
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/categories/{category-id}/tags/{tag-id}/attachments

Get tag attachments for VPC


Get tag attachments for VPC
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/categories/{category-id}/tags/{tag-id}/attachments

Create or update tag attachment for a VPC


Create or update tag attachment for a VPC
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/categories/{category-id}/tags/{tag-id}/attachments