NSX-T Data Center REST API

Associated URIs:

API Description API Path

Get PolicyContextProfiles


Get all PolicyContextProfiles
GET /policy/api/v1/infra/context-profiles
GET /policy/api/v1/global-infra/context-profiles
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/context-profiles

Delete Policy Context Profile


Deletes the specified Policy Context Profile. If the Policy Context
Profile is consumed in a firewall rule, it won't get deleted.
DELETE /policy/api/v1/infra/context-profiles/{context-profile-id}
DELETE /policy/api/v1/global-infra/context-profiles/{context-profile-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/context-profiles/{context-profile-id}

Get PolicyContextProfile


Get a single PolicyContextProfile by id
GET /policy/api/v1/infra/context-profiles/{context-profile-id}
GET /policy/api/v1/global-infra/context-profiles/{context-profile-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/context-profiles/{context-profile-id}

Create or partially update a Policy Context Profile


Creates a new Policy Context Profile or selectively updates the fields
provided in the request body of an existing one.
Rules for using attributes and sub-attributes in a single PolicyContextProfile:
1. Each attribute key may appear only once per profile. (e.g. APP_ID
can be specified at most once.)
2. Multiple values for an attribute must be supplied as an array.
3. When sub-attributes are provided for an attribute, that attribute
must have exactly one value.
4. The reserved id "custom_attributes" must not be used as a profile id.
PATCH /policy/api/v1/infra/context-profiles/{context-profile-id}
PATCH /policy/api/v1/global-infra/context-profiles/{context-profile-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/context-profiles/{context-profile-id}

Create or replace a Policy Context Profile


Creates a new Policy Context Profile or fully replaces an existing one.
The entire profile is replaced with the contents of the request body;
any fields not included in the request will be reset to their defaults.
Rules for using attributes and sub-attributes in a single PolicyContextProfile:
1. Each attribute key may appear only once per profile. (e.g. APP_ID
can be specified at most once.)
2. Multiple values for an attribute must be supplied as an array.
3. When sub-attributes are provided for an attribute, that attribute
must have exactly one value.
4. The reserved id "custom_attributes" must not be used as a profile id.
PUT /policy/api/v1/infra/context-profiles/{context-profile-id}
PUT /policy/api/v1/global-infra/context-profiles/{context-profile-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/context-profiles/{context-profile-id}

List Context Profile supported attribute types


Returns supported attribute type strings for Context Profile.
GET /policy/api/v1/infra/context-profiles/attribute-types

List Policy Context Profile supported attributes and sub-attributes


Returns supported attributes and sub-attributes along with their allowed
values. When an attribute_key query parameter is supplied, only the
matching attribute and its sub-attributes are returned. When omitted,
all supported attribute keys and their corresponding values are returned.
GET /policy/api/v1/infra/context-profiles/attributes
GET /policy/api/v1/global-infra/context-profiles/attributes
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/context-profiles/attributes

Update custom object attribute value list for given attribute key


This API updates custom attribute value list for given key.
PATCH /policy/api/v1/infra/context-profiles/custom-attributes (Deprecated)
PATCH /policy/api/v1/global-infra/context-profiles/custom-attributes (Deprecated)
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/context-profiles/custom-attributes (Deprecated)

Adds/Removes custom attribute values from list


This API adds/removes custom attribute values from list for a given attribute key.
POST /policy/api/v1/infra/context-profiles/custom-attributes (Deprecated)
POST /policy/api/v1/global-infra/context-profiles/custom-attributes (Deprecated)
POST /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/context-profiles/custom-attributes (Deprecated)

Retrieves custom attribute values for given attribute key


This API lists all the custom attribute values defined in the system for the attribute_key
mentioned as part of the url.
GET /policy/api/v1/infra/context-profiles/custom-attributes/default
GET /policy/api/v1/global-infra/context-profiles/custom-attributes/default
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/context-profiles/custom-attributes/default

Update custom attribute value list for given attribute key.


This API updates custom attribute value list for given key in the request. This replaces the
existing list with the list provided in the request
PATCH /policy/api/v1/infra/context-profiles/custom-attributes/default
PATCH /policy/api/v1/global-infra/context-profiles/custom-attributes/default
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/context-profiles/custom-attributes/default

Adds/Removes custom attribute values from list


This API adds/removes custom attribute values from list for a given attribute key. The values in the
request will be added or removed from the existing list.
POST /policy/api/v1/infra/context-profiles/custom-attributes/default
POST /policy/api/v1/global-infra/context-profiles/custom-attributes/default
POST /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/context-profiles/custom-attributes/default

List l7 access Profiles


API will list all l7 access Profiles
GET /policy/api/v1/infra/l7-access-profiles
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/l7-access-profiles

Delete L7 Access Profile


API will delete L7 Access Profile
DELETE /policy/api/v1/infra/l7-access-profiles/{l7-access-profile-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/l7-access-profiles/{l7-access-profile-id}

Get L7 Access Profile


API will get L7 Access Profile
GET /policy/api/v1/infra/l7-access-profiles/{l7-access-profile-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/l7-access-profiles/{l7-access-profile-id}

Create or update L7 Access Profile


API will create/update L7 Access Profile
PATCH /policy/api/v1/infra/l7-access-profiles/{l7-access-profile-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/l7-access-profiles/{l7-access-profile-id}

Update L7 Access Profile


API will update L7 Access Profile
PUT /policy/api/v1/infra/l7-access-profiles/{l7-access-profile-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/l7-access-profiles/{l7-access-profile-id}

List l7 access profile entries


API will list all l7 access profiles entries
GET /policy/api/v1/infra/l7-access-profiles/{l7-access-profile-id}/entries
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/l7-access-profiles/{l7-access-profile-id}/entries

Delete L7 Access Profile entry


API will delete L7 Access Profile entry
DELETE /policy/api/v1/infra/l7-access-profiles/{l7-access-profile-id}/entries/{l7-access-entry-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/l7-access-profiles/{l7-access-profile-id}/entries/{l7-access-entry-id}

Read L7 Access Profile entry


Read Friewall L7 Access Profile entry
GET /policy/api/v1/infra/l7-access-profiles/{l7-access-profile-id}/entries/{l7-access-entry-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/l7-access-profiles/{l7-access-profile-id}/entries/{l7-access-entry-id}

Create or update L7 Access Profile entry


API will create/update L7 Access Profile entry
PATCH /policy/api/v1/infra/l7-access-profiles/{l7-access-profile-id}/entries/{l7-access-entry-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/l7-access-profiles/{l7-access-profile-id}/entries/{l7-access-entry-id}

Create L7 Access Profile entry


API will create L7 Access Profile entry
PUT /policy/api/v1/infra/l7-access-profiles/{l7-access-profile-id}/entries/{l7-access-entry-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/l7-access-profiles/{l7-access-profile-id}/entries/{l7-access-entry-id}

List Policy L7 access profile supported attributes and sub-attributes


Returns supported attribute and sub-attributes for specified
attribute key with their supported values, if provided in query/request
parameter, else will fetch all supported attributes and sub-attributes for
all supported attribute keys.
GET /policy/api/v1/infra/l7-access-profiles/attributes
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/l7-access-profiles/attributes

List static mime contents


API will list all static mime contents
GET /policy/api/v1/infra/static-mime-contents

Delete static Mime content


API will delete static mime content
DELETE /policy/api/v1/infra/static-mime-contents/{static-mime-content-id}

Get Static Mime content


API will get static mime content
GET /policy/api/v1/infra/static-mime-contents/{static-mime-content-id}

Create or update static mime content id


API will create/update static mime content id
PATCH /policy/api/v1/infra/static-mime-contents/{static-mime-content-id}

Update static mime content id


API will create/update static mime content id
PUT /policy/api/v1/infra/static-mime-contents/{static-mime-content-id}