NSX-T Data Center REST API

Create or update PROJECT

If a Project with the project-id is not already present, create a new Project.
If it already exists, update the Project.

Request:

Method:

PATCH

URI Path(s):

/policy/api/v1/orgs/{org-id}/projects/{project-id}

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

Project+

Project (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
activate_default_dfw_rules	Activate the default DFW rules for the Project By default, Project is created with default distributed firewall rules, this flag allows to deactivate those default rules . If not set, the default rules are enabled. The system will expect the API user to pass this flag as "false" when the system is not entitled to distributed firewall.	boolean
children	Subtree for this type within policy tree Subtree for this type within policy tree containing nested elements. Note that this type is applicable to be used in Hierarchical API only.	array of ChildPolicyConfigResource (Abstract type: pass one of the following concrete types) ChildProjectIpAddressAllocation ChildSecurityProfileAttachment ChildSecurityStrategy ChildTransitGateway ChildVpc ChildVpcConnectivityProfile ChildVpcSecurityProfile ChildVpcServiceProfile
dedicated_resources		DedicatedResources	Deprecated
default	Flag to indicate that the project is a default project true - the project is a default project. Default projects are non-editable, system create ones.	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
external_ipv4_blocks	PolicyPath of public ip block IP block used for allocating CIDR blocks for public subnets. IP block can be consumed by all the VPCs under this project. CIDR that must be unique across Org/provider and will be auto advertised up to Org/Provider Tier0 gateway.	array of string
id	Unique identifier of this resource	string	Sortable
id_suffix	ID suffix to make project's default children path unique. This is optional attribute, if provided will be used to suffix the project's default objects ID to make the policy path with this ID suffix.	string	Maximum length: 246
limits	PolicyPath of limits applied on the project Limits are used to add constraints within a project. This field lists the limits that are applied to a particular project by the enterprise admin.	array of string
log_labeled_external_resources		DedicatedResources
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object get deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
origin_site_id	A unique identifier assigned by the system for knowing which site owns an object This is a UUID generated by the system for knowing which site owns an object. This is used in NSX+.	string	Readonly
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified locally by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
owner_id	A unique identifier assigned by the system for the ownership of an object This is a UUID generated by the system for knowing who owns this object. This is used in NSX+.	string	Readonly
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
realization_id	A unique identifier assigned by the system for realizing intent This is a UUID generated by the system for realizing the entity object. In most cases this should be same as 'unique_id' of the entity. However, in some cases this can be different because of entities have migrated their unique identifier to NSX Policy intent objects later in the timeline and did not use unique_id for realization. Realization id is helpful for users to debug data path to correlate the configuration with corresponding intent.	string	Readonly
relative_path	Relative path of this object Path relative from its parent	string	Readonly
remote_path	Path of the object on the remote end. This path is populated only in case of multi-site scenario. Currently it is supported only for LM objects. When LM is onboarded to multi-site platform like NAPP or GM, remote_path will be set to the globally unique path across multi-site topology . It is generated based on local site-name and uses /org tree namespace. Note: It is populated only for LM objects. Not supported on the GM.	string	Readonly
resource_type	Must be set to the value Project	string
short_id	Identifier to use when displaying project context in logs Defaults to id if id is less than equal to 8 characters or defaults to random generated id if not set.	string	Maximum length: 8
site_infos	Collection of Site information Information related to sites applicable for given Project. For on-prem deployment, only 1 is allowed.	array of SiteInfo	Maximum items: 16
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
tgw_external_connections	PolicyPaths of transit gateway connections. This represents the available transit gateway connection objects. Gateway connection and distributed VLAN connection object path will be allowed.	array of string
tier_0s	Array of Tier0s path associated with this Project. The tier0 path of type Tier0 has to be pre-created before Project is created. The tier0 typically provides connectivity to external world. List of sites for Project has to be subset of sites where the tier0 spans.	array of string
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entities in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly
vc_folder	Flag to specify whether the DVPGs created for project segments are grouped under a folder on the VC.	boolean
vpc_deployment_scope	Project Vpc network Deployment Scope. This contains the Cluster based and zone based span configurations which basically defines the collection of vSphere clusters where project VPC networks will be deployed. Enterprise admin defines all the the available cluster based NetworkSpans or vCenter zones for project admin to define span of VPC by applying at corresponding TGW level. This provides the span configuration for all the VPCs inside the project either based on clusters or zones. Tgw span can be based on vSphere clusters or vCenter Zones. Project can be configured with either cluster based or zone based span.	VpcDeploymentScope

Example Request:

PATCH https://<policy-mgr>/policy/api/v1/orgs/default/projects/project-1 { "site_infos": [ { "edge_cluster_paths": [ "/infra/sites/default/enforcement-points/default/edge-clusters/80788b6c-e834-42ae-aabb-3e49cff56e5c" ], "site_path": "/infra/sites/default" } ], "tier_0s": [ "/infra/tier-0s/pepsi", "/infra/tier-0s/pepsi_remote" ], "external_ipv4_blocks":["/infra/ip-blocks/public"] } // project - tgw cluster based span payload. { "site_infos": [ { "edge_cluster_paths": [ "/infra/sites/default/enforcement-points/default/edge-clusters/80788b6c-e834-42ae-aabb-3e49cff56e5c" ], "site_path": "/infra/sites/default" } ], "tier_0s": [ "/infra/tier-0s/pepsi", "/infra/tier-0s/pepsi_remote" ], "external_ipv4_blocks":["/infra/ip-blocks/public"], "vpc_deployment_scope": { "span_references" : [ { "span_path": "/infra/network-spans/span1", "is_default" : true }, { "span_path": "/infra/network-spans/span2", } ] } } // project - tgw zone based span payload. { "site_infos": [ { "edge_cluster_paths": [ "/infra/sites/default/enforcement-points/default/edge-clusters/80788b6c-e834-42ae-aabb-3e49cff56e5c" ], "site_path": "/infra/sites/default" } ], "tier_0s": [ "/infra/tier-0s/pepsi", "/infra/tier-0s/pepsi_remote" ], "external_ipv4_blocks":["/infra/ip-blocks/public"], "vpc_deployment_scope": { "zone_external_ids": [ "33dbf426-c282-42a0-9ae2-5e924b8a78b4:zone-c38", "33dbf426-c282-42a0-9ae2-5e924b8a78b4:zone-c39" ] } }

Successful Response:

Response Code:

200 OK

Response Headers:

n/a

Response Body:

n/a

Example Response:

200 OK

Required Permissions:

crud

Feature:

policy_project

NSX-T Data Center REST API

Create or update PROJECT

Request:

Project (schema)

Example Request:

Successful Response:

Example Response:

Required Permissions:

Feature:

Additional Errors: