NSX-T Data Center REST API

Associated URIs:

API Description	API Path
Get list of entities in exclude list.	GET /api/v1/firewall/excludelist (Deprecated)
Check if the object a member of the exclude list	POST /api/v1/firewall/excludelist?action=check_if_exists (Deprecated)
Remove an existing object from the exclude list.	POST /api/v1/firewall/excludelist?action=remove_member (Deprecated)
Add a new object in the exclude list.	POST /api/v1/firewall/excludelist?action=add_member (Deprecated)
Modify exclude list.	PUT /api/v1/firewall/excludelist (Deprecated)
Get firewall profiles available. List all the firewall profiles available by requested resource_type.	GET /api/v1/firewall/profiles (Deprecated)
Create a firewall profile. Create a firewall profile with values provided. It creates profile based resource_type in the payload.	POST /api/v1/firewall/profiles (Deprecated)
Delete a firewall profile. Deletes a firewall profile.	DELETE /api/v1/firewall/profiles/{profile-id} (Deprecated)
Get all firewall session timer profiles. Return firewall session timer profile.	GET /api/v1/firewall/profiles/{profile-id} (Deprecated)
Update a firewall profile. Update user configurable properties of firewall profile.	PUT /api/v1/firewall/profiles/{profile-id} (Deprecated)
Read an Existing Rule Return existing firewall rule information.	GET /api/v1/firewall/rules/{rule-id} (Deprecated)
Get the Realized State of a Firewall Rule Return realized state information of a firewall rule. Returned response is same as rule's section realization state response.	GET /api/v1/firewall/rules/{rule-id}/state (Deprecated)
List All Firewall Sections List all firewall section in paginated form. A default page size is limited to 1000 firewall sections. By default list of section is filtered by LAYER3 type.	GET /api/v1/firewall/sections (Deprecated)
Create a Section with Rules. Creates a new firewall section with rules. The limit on the number of rules is defined by maxItems in collection types for FirewallRule (FirewallRuleXXXList types). When invoked on a section with a large number of rules, this API is supported only at low rates of invocation (not more than 4-5 times per minute). The typical latency of this API with about 1024 rules is about 4-5 seconds. This API should not be invoked with large payloads at automation speeds. More than 50 rules with a large number of rule references is not supported. Instead, to create sections, use: POST /api/v1/firewall/sections To create rules, use: POST /api/v1/firewall/sections/<section-id>/rules	POST /api/v1/firewall/sections?action=create_with_rules (Deprecated)
Create a New Empty Section Creates new empty firewall section in the system.	POST /api/v1/firewall/sections (Deprecated)
Delete an Existing Section and Its Associated Rules Removes firewall section from the system. Firewall section with rules can only be deleted by passing "cascade=true" parameter.	DELETE /api/v1/firewall/sections/{section-id} (Deprecated)
Get an Existing Section Returns information about firewall section for the identifier.	GET /api/v1/firewall/sections/{section-id} (Deprecated)
Unlock a section Unlock a section.	POST /api/v1/firewall/sections/{section-id}?action=unlock (Deprecated)
Get an Existing Section, Including Rules Returns firewall section information with rules for a section identifier. When invoked on a section with a large number of rules, this API is supported only at low rates of invocation (not more than 4-5 times per minute). The typical latency of this API with about 1024 rules is about 4-5 seconds. This API should not be invoked with large payloads at automation speeds. More than 50 rules with a large number rule references is not supported. Instead, to read firewall rules, use: GET /api/v1/firewall/sections/<section-id>/rules with the appropriate page_size.	POST /api/v1/firewall/sections/{section-id}?action=list_with_rules (Deprecated)
Lock a section Lock a section.	POST /api/v1/firewall/sections/{section-id}?action=lock (Deprecated)
Update an Existing Section, Including Its Rules Modifies existing firewall section along with its association with rules. When invoked on a large number of rules, this API is supported only at low rates of invocation (not more than 2 times per minute). The typical latency of this API with about 1024 rules is about 15 seconds in a cluster setup. This API should not be invoked with large payloads at automation speeds. Instead, to update rule content, use: PUT /api/v1/firewall/sections/<section-id>/rules/<rule-id> Simultaneous update (modify) operations on same section are not allowed to prevent overwriting stale contents to firewall section. If a concurrent update is performed, HTTP response code 409 will be returned to the client operating on stale data. That client should retrieve the firewall section again and re-apply its update.	POST /api/v1/firewall/sections/{section-id}?action=update_with_rules (Deprecated)
Update an Existing Section, Including Its Position Modifies an existing firewall section along with its relative position among other firewall sections in the system. Simultaneous update (modify) operations on same section are not allowed to prevent overwriting stale contents to firewall section. If a concurrent update is performed, HTTP response code 409 will be returned to the client operating on stale data. That client should retrieve the firewall section again and re-apply its update.	POST /api/v1/firewall/sections/{section-id}?action=revise (Deprecated)
Update an Existing Section with Rules Modifies an existing firewall section along with its relative position among other firewall sections with rules. When invoked on a large number of rules, this API is supported only at low rates of invocation (not more than 2 times per minute). The typical latency of this API with about 1024 rules is about 15 seconds in a cluster setup. This API should not be invoked with large payloads at automation speeds. Instead, to move a section above or below another section, use: POST /api/v1/firewall/sections/<section-id>?action=revise To modify rules, use: PUT /api/v1/firewall/sections/<section-id>/rules/<rule-id> Simultaneous update (modify) operations on same section are not allowed to prevent overwriting stale contents to firewall section. If a concurrent update is performed, HTTP response code 409 will be returned to the client operating on stale data. That client should retrieve the firewall section again and re-apply its update.	POST /api/v1/firewall/sections/{section-id}?action=revise_with_rules (Deprecated)
Update an Existing Section Modifies the specified section, but does not modify the section's associated rules. Simultaneous update (modify) operations on same section are not allowed to prevent overwriting stale contents to firewall section. If a concurrent update is performed, HTTP response code 409 will be returned to the client operating on stale data. That client should retrieve the firewall section again and re-apply its update.	PUT /api/v1/firewall/sections/{section-id} (Deprecated)
Get All the Rules for a Section Return all firewall rule(s) information for a given firewall section.	GET /api/v1/firewall/sections/{section-id}/rules (Deprecated)
Add Multiple Rules in a Section Create multiple firewall rules in existing firewall section bounded by limit of 1000 firewall rules per section. Adding multiple firewall rules in a section modifies parent section entity and simultaneous update (modify) operations on same section are not allowed to prevent overwriting stale contents to firewall section. If a concurrent update is performed, HTTP response code 409 will be returned to the client operating on stale data. That client should retrieve the firewall section again and re-apply its update.	POST /api/v1/firewall/sections/{section-id}/rules?action=create_multiple (Deprecated)
Add a Single Rule in a Section Adds a new firewall rule in existing firewall section. Adding firewall rule to a section modifies parent section entity and simultaneous update (modify) operations on same section are not allowed to prevent overwriting stale content to firewall section. If a concurrent update is performed, HTTP response code 409 will be returned to the client operating on stale data. That client should retrieve the firewall section again and re-apply its update.	POST /api/v1/firewall/sections/{section-id}/rules (Deprecated)
Delete an Existing Rule Delete existing firewall rule in a firewall section. Deleting firewall rule in a section modifies parent section and simultaneous update (modify) operations on same section are not allowed to prevent overwriting stale contents to firewall section. If a concurrent update is performed, HTTP response code 409 will be returned to the client operating on stale data. That client should retrieve the firewall section again and re-apply its update.	DELETE /api/v1/firewall/sections/{section-id}/rules/{rule-id} (Deprecated)
Read an Existing Rule Return existing firewall rule information in a firewall section.	GET /api/v1/firewall/sections/{section-id}/rules/{rule-id} (Deprecated)
Update an Existing Rule and Reorder the Rule Modifies existing firewall rule along with relative position among other firewall rules inside a firewall section. Revising firewall rule in a section modifies parent section entity and simultaneous update (modify) operations on same section are not allowed to prevent overwriting stale contents to firewall section. If a concurrent update is performed, HTTP response code 409 will be returned to the client operating on stale data. That client should retrieve the firewall section again and re-apply its update.	POST /api/v1/firewall/sections/{section-id}/rules/{rule-id}?action=revise (Deprecated)
Update an Existing Rule Modifies existing firewall rule in a firewall section. Updating firewall rule in a section modifies parent section entity and simultaneous update (modify) operations on same section are not allowed to prevent overwriting stale contents to firewall section. If a concurrent update is performed, HTTP response code 409 will be returned to the client operating on stale data. That client should retrieve the firewall section again and re-apply its update.	PUT /api/v1/firewall/sections/{section-id}/rules/{rule-id} (Deprecated)
Get Firewall rule level statistics Get aggregated statistics for a rule for given firewall section. The API only supports access to cached (source=cached) statistical data collected offline in the system. Data includes total number of packets, bytes, sessions counters and popularity index for a firewall rule and overall session count, max session count and max popularity index for all firewall rules on transport nodes or edge nodes. Aggregated statistics like maximum popularity index, maximum session count and total session count are computed with lower frequency compared to individual generic rule statistics, hence they may have a computation delay up to 15 minutes to reflect in response to this API.	GET /api/v1/firewall/sections/{section-id}/rules/{rule-id}/stats (Deprecated)
Get Firewall section level statistics section Get aggregated statistics for all rules for a given firewall section. The API only supports access to cached (source=cached) statistical data collected offline in the system. Data includes total number of packets, bytes, sessions counters and popularity index for a firewall rule and overall session count, max session count and max popularity index for all firewall rules on transport nodes or edge nodes. Aggregated statistics like maximum popularity index, maximum session count and total session count are computed with lower frequency compared to individual generic rule statistics, hence they may have a computation delay up to 15 minutes to reflect in response to this API.	GET /api/v1/firewall/sections/{section-id}/rules/stats (Deprecated)
Get the Realized State of a Firewall Section Return realized state information of a firewall section.	GET /api/v1/firewall/sections/{section-id}/state (Deprecated)
Get the summary of sections in the firewall configuration. List the summary of number of sections and number of rules for each firewall category (L2DFW, L3DFW).	GET /api/v1/firewall/sections/summary (Deprecated)
Reset firewall rule statistics Sets firewall rule statistics counter to zero. This operation is supported for given category, for example: L3DFW i.e. for all layer3 firewall (transport nodes only) rules or L3EDGE i.e. for all layer3 edge firewall (edge nodes only) rules or L3BRIDGEPORT i.e. for all layer3 bridge port firewall (bridge ports only) rules.	POST /api/v1/firewall/stats?action=reset (Deprecated)
List all firewall status for supported contexts	GET /api/v1/firewall/status (Deprecated)
Get firewall global status for dfw context	GET /api/v1/firewall/status/{context-type} (Deprecated)
Update global firewall status for dfw context	PUT /api/v1/firewall/status/{context-type} (Deprecated)
Get firewall status for target resource in dfw context	GET /api/v1/firewall/status/{context-type}/{id} (Deprecated)
Enable firewall on target resource in dfw context	POST /api/v1/firewall/status/{context-type}/{id}?action=enable_firewall (Deprecated)
Disable firewall on target resource in dfw context	POST /api/v1/firewall/status/{context-type}/{id}?action=disable_firewall (Deprecated)
List all transport node and statuses based on idfw enabled ComputeCollection ID. Retrieve all the transport node and status by idfw enabled ComputeCollection ID in the request.	GET /api/v1/idfw/compute-collections/{cc-ext-id}/transport-nodes/status (Deprecated)
Get list of compute collections and status. Retrieve the compute collection status by ID.	GET /api/v1/idfw/compute-collections/{compute-collection-ext-id}/status (Deprecated)
List all IDFW enabled ComputeCollection statuses. Retrieve all the Compute collection status.	GET /api/v1/idfw/compute-collections/status (Deprecated)
List all Identity firewall compute collections List all Identity firewall compute collections.	GET /api/v1/idfw/idfw-compute-collections (Deprecated)
Delete IDFW compute collection. Delete individual compute collections for IDFW.	DELETE /api/v1/idfw/idfw-compute-collections/{cc-ext-id} (Deprecated)
Get IDFW compute collection. Get enable/disable status of individual compute collections for IDFW.	GET /api/v1/idfw/idfw-compute-collections/{cc-ext-id} (Deprecated)
Update IDFW compute collection Enable/disable individual compute collections for IDFW.	PUT /api/v1/idfw/idfw-compute-collections/{cc-ext-id} (Deprecated)
Get Identity Firewall master switch enabled/disabled Fetches IDFW master switch setting to check whether master switch is enabled or disabled	GET /api/v1/idfw/master-switch-setting (Deprecated)
Update IDFW master switch setting enabled/disabled Update Identity Firewall master switch setting (true=enabled / false=disabled). Identity Firewall master switch setting enables or disables Identity Firewall feature across the system. It affects compute collections, hypervisor and virtual machines. This operation is expensive and also has big impact and implication on system perforamce.	PUT /api/v1/idfw/master-switch-setting (Deprecated)
Get all IDFW NSGroup VM details for a given NSGroup Get all Identity Firewall NSGroup VM details for a given NSGroup.	GET /api/v1/idfw/nsgroup-vm-details/{group-id} (Deprecated)
Get Standalone hosts switch enabled/disabled Fetches IDFW standalone hosts switch setting to check whether standalone hosts is enabled or disabled	GET /api/v1/idfw/standalone-host-switch-setting (Deprecated)
Update IDFW master switch setting enabled/disabled Update Identity Firewall standalone hosts switch setting (true=enabled / false=disabled).	PUT /api/v1/idfw/standalone-host-switch-setting (Deprecated)
Get IDFW system statistics data Get IDFW system statistics data.	GET /api/v1/idfw/system-stats (Deprecated)
List all VM and statuses based on transport node ID of idfw enabled compute collection. Retrieve all the VM and status by transport node ID of idfw enabled compute collection in the request.	GET /api/v1/idfw/transport-nodes/{transport-node-id}/vms/status (Deprecated)
Get user session data Get user session data.	GET /api/v1/idfw/user-session-data (Deprecated)
Get IDFW user login events for a given user Get IDFW user login events for a given user (all active plus up to 5 most recent archived entries).	GET /api/v1/idfw/user-stats/{user-id} (Deprecated)
Get IDFW user login events for a given VM Get IDFW user login events for a given VM (all active plus up to 5 most recent archived entries).	GET /api/v1/idfw/vm-stats/{vm-ext-id} (Deprecated)
Get status for MPS Compute collection. Returns current status of the deployment of MPS Service on a given cluster.	GET /api/v1/malware-prevention/compute-collection/{compute-collection-id}/status
Remove service deployment Remove the service deployment. This will remove all the Service VMs that were created as part of this deployment on the specified cluster. User can optionally set force delete option which will force remove the deployment, but should be used only when the regular delete is not working. Regular delete will ensure proper cleanup of Service VMs and related objects. Directly calling this API without trying regular undeploy will result in unexpected results, and orphan objects.	DELETE /api/v1/malware-prevention/compute-collection/{compute-collection-id}/svm-deployment
Get the Malware Prevention Service deployment on the specified compute-collection Returns detail of the Malware Prevention Service deployment.	GET /api/v1/malware-prevention/compute-collection/{compute-collection-id}/svm-deployment
Deploys a the Malware Prevention Service on the specified compute-collection This will deploy the Malware Prevention Service on a given cluster. Internally OVF will be deployed on each host that is part of the cluster. If there are no issues in the parameters, the call returns immediately, and the service VMs will be deployed asynchronously. To get the overall status of the deployment or to get the status of individual service vm, please use the MPS deployment status APIs.	POST /api/v1/malware-prevention/compute-collection/{compute-collection-id}/svm-deployment
Upgrade all VMs part of this service deployment to new OVF specification on the given datastore. If new deployment specification is provided, the deployment will be moved to the provided specification provided that current deployment state is either UPGRADE_FAILED or DEPLOYMENT_SUCCESSFUL If same deployment specification is provided, upgrade will be done only if current deployment state is UPGRADE_FAILED If the existing data store is upgraded or changed, there is an optional parameter to supply the new storage Id during upgrade which would perform the deployment upgrade on the new data store	POST /api/v1/malware-prevention/compute-collection/{compute-collection-id}/svm-deployment/action/change-appliance
List OVF specifications List OVF specifications	GET /api/v1/malware-prevention/ovf-spec
List available regions List available regions.	GET /api/v1/malware-prevention/teaser/regions
Registration URL Registration URL.	POST /api/v1/malware-prevention/teaser/registration_url
Registration status Registration status.	GET /api/v1/malware-prevention/teaser/status
Get status for MPS Transport Node. Returns current status of the deployment of MPS Service on a transport node.	GET /api/v1/malware-prevention/transport-node/{transport-node-id}/status
List service configs List of all service configs.	GET /api/v1/service-configs (Deprecated)
Create service config Creates a new service config that can group profiles and configs	POST /api/v1/service-configs (Deprecated)
Delete Service Config Deletes the specified service config	DELETE /api/v1/service-configs/{config-set-id} (Deprecated)
Read Service Config Returns information about the specified Service Config.	GET /api/v1/service-configs/{config-set-id} (Deprecated)
Update service config Updates the specified ServiceConfig.	PUT /api/v1/service-configs/{config-set-id} (Deprecated)
Creates/Updates service configs sent in batch request Creates/Updates new service configs sent in batch request. This API returns ALL the service configs that are created/updated.	POST /api/v1/service-configs/batch (Deprecated)
Get Effective Profiles for an Entity Returns the effective profiles applied to the specified Resource.	GET /api/v1/service-configs/effective-profiles (Deprecated)
Get all service attachments. Returns all Service-Attachement(s) present in the system.	GET /api/v1/serviceinsertion/service-attachments (Deprecated)
Add a Service Attachment. Adds a new Service attachment. A service attachment represents a point on NSX entity (Example: Logical Router) to which service instance can be connected through an InstanceEndpoint.	POST /api/v1/serviceinsertion/service-attachments (Deprecated)
Delete an existing service attachment Delete existing service attachment from system. Before deletion, please make sure that, no instance endpoints are connected to this attachment. In turn no appliance should be connected to this attachment.	DELETE /api/v1/serviceinsertion/service-attachments/{service-attachment-id} (Deprecated)
Get a particular service attachment. Returns detailed Attachment information for a given service attachment.	GET /api/v1/serviceinsertion/service-attachments/{service-attachment-id} (Deprecated)
Update an existing service attachment. Modifies an existing service attachment. Updates to name, description and Logical Router list only supported.	PUT /api/v1/serviceinsertion/service-attachments/{service-attachment-id} (Deprecated)
List all ServiceChains. List all service chains in the system.	GET /api/v1/serviceinsertion/service-chains (Deprecated)
Add Service Chain Adds a new service chain. Service Chains is can contain profile belonging to same or different Service(s). It represents a redirection target for a Rule.	POST /api/v1/serviceinsertion/service-chains (Deprecated)
Delete a Service Chain. Delete a particular service chain.	DELETE /api/v1/serviceinsertion/service-chains/{service-chain-id} (Deprecated)
Get a particular service chain. Returns detailed service chain information.	GET /api/v1/serviceinsertion/service-chains/{service-chain-id} (Deprecated)
List all service paths List all service paths for the given service chain for the given service chain id	GET /api/v1/serviceinsertion/service-chains/{service-chain-id}/service-paths (Deprecated)
Get all Service-Instances present in system Returns all Service-Instance(s) of all Services present in system. When request parameter (deployed_to or service_deployment_id) is provided as a part of request, it will filter out Service-Instances accordingly.	GET /api/v1/serviceinsertion/service-instances
List service managers List all service managers.	GET /api/v1/serviceinsertion/service-managers
Register service manager Register service-manager with NSX with basic details like name, username, password.	POST /api/v1/serviceinsertion/service-managers
Delete service manager Delete service-manager which is registered with NSX with basic details like name, username, password.	DELETE /api/v1/serviceinsertion/service-managers/{service-manager-id}
Get service manager Retrieve service-manager details like name, username, password, vendor ID, thumbprint for a given ID.	GET /api/v1/serviceinsertion/service-managers/{service-manager-id}
Update service manager Update service-manager which is registered with NSX with basic details like name, username, password.	PUT /api/v1/serviceinsertion/service-managers/{service-manager-id}
List all Service-Insertion Services. List all Service-Insertion Service Definitions.	GET /api/v1/serviceinsertion/services
Create a Service-Insertion Service Creates new Service-Insertion Service in the system.	POST /api/v1/serviceinsertion/services
Delete an existing Service and the Service-Instance associated with it. Removes Service-Insertion Service from the system. A Service with Service-Instances can only be deleted by passing "cascade=true" parameter.	DELETE /api/v1/serviceinsertion/services/{service-id}
Get an existing Service Returns information about Service-Insertion Service with the given identifier.	GET /api/v1/serviceinsertion/services/{service-id}
Update an existing Service Modifies the specified Service.	PUT /api/v1/serviceinsertion/services/{service-id}
Get all service deployments for the given service id Returns the list of deployments for the given service	GET /api/v1/serviceinsertion/services/{service-id}/service-deployments
Deploys a particular service This will deploy a particular service on a given cluster / host. Internally multiple service instance can be created during the deployment. If there are no issues in the parameters, the call returns immediately, and the service VMs will be deployed asynchronously. To get the overall status of the deployment or to get the status of individual service vm, please use the deployment status APIs.	POST /api/v1/serviceinsertion/services/{service-id}/service-deployments
Remove service deployment Remove the service deployment. Will remove all the Service VMs that were created as part of this deployment. User can send optional force delete option which will force remove the deployment, but should be used only when the regular delete is not working. Regular delete will ensure proper cleanup of Service VMs and related objects. Directly calling this API without trying regular undeploy will result in unexpected results, and orphan objects.	DELETE /api/v1/serviceinsertion/services/{service-id}/service-deployments/{service-deployment-id}
Get a particular service deployment. Returns detail of service deployment.	GET /api/v1/serviceinsertion/services/{service-id}/service-deployments/{service-deployment-id}
Upgrade all VMs part of this service deployment to new Spec OVF. If new deployment spec is provided, the deployment will be moved to the provided spec provided that current deployment state is either UPGRADE_FAILED or DEPLOYMENT_SUCCESSFUL If same deployment spec is provided, upgrade will be done only if current deployment state is UPGRADE_FAILED If the exisiting data store is upgraded or changed, there is an optional parameter to supply the new storage Id during upgrade which would perform the deployment upgrade on the new data store	POST /api/v1/serviceinsertion/services/{service-id}/service-deployments/{service-deployment-id}?action=upgrade
Update an existing Service Deployment Update an existing Service Deployment.	PUT /api/v1/serviceinsertion/services/{service-id}/service-deployments/{service-deployment-id} (Deprecated)
Get Service-Deployment state for Service. Returns configuration state of deployed partner service using service insertion framework.	GET /api/v1/serviceinsertion/services/{service-id}/service-deployments/{service-deployment-id}/state
Get a particular service deployment status. Returns current status of the deployment of partner service. Available only for EPP Services. By default this API would return cached status. Caching happens every 3 minutes. For realtime status, query parameter "source=realtime" needs to be passed.	GET /api/v1/serviceinsertion/services/{service-id}/service-deployments/{service-deployment-id}/status
Get all Service-Instances for Service. Returns all Service-Instance(s) for a given Service-Insertion Service.	GET /api/v1/serviceinsertion/services/{service-id}/service-instances
Add a Service Instance for a specified Service. Adds a new Service-Instance under the specified Service.	POST /api/v1/serviceinsertion/services/{service-id}/service-instances
Delete an existing Service-Instance Delete existing Service-Instance for a given Service-Insertion Service.	DELETE /api/v1/serviceinsertion/services/{service-id}/service-instances/{service-instance-id} (Deprecated)
Get Service-Instance for Service. Returns Service-Instance information for a given Service-Insertion Service.	GET /api/v1/serviceinsertion/services/{service-id}/service-instances/{service-instance-id}
Update an existing Service-Instance. Modifies an existing Service-Instance for a given Service-Insertion Service.	PUT /api/v1/serviceinsertion/services/{service-id}/service-instances/{service-instance-id} (Deprecated)
Get NSgroups for a given ServiceInstance. Returns list of NSGroups used in Service Insertion North-South rules for a given Service Instance.	GET /api/v1/serviceinsertion/services/{service-id}/service-instances/{service-instance-id}/group-associations
List all InstanceEndpoints of a Service Instance. List all InstanceEndpoints of a service instance.	GET /api/v1/serviceinsertion/services/{service-id}/service-instances/{service-instance-id}/instance-endpoints
Add an InstanceEndpoint for a Service Instance Adds a new instance endpoint. It belongs to one service instance and is attached to one service attachment. It represents a redirection target for a Rule.	POST /api/v1/serviceinsertion/services/{service-id}/service-instances/{service-instance-id}/instance-endpoints (Deprecated)
Delete a particular InstanceEndpoint. Delete instance endpoint information for a given instace endpoint. Please make sure to delete all the Service Insertion Rules, which refer to this Endpoint as 'redirect_tos' target.	DELETE /api/v1/serviceinsertion/services/{service-id}/service-instances/{service-instance-id}/instance-endpoints/{instance-endpoint-id} (Deprecated)
Get a particular instance endpoint for a service instance. Returns detailed Endpoint information for a given InstanceEndpoint.	GET /api/v1/serviceinsertion/services/{service-id}/service-instances/{service-instance-id}/instance-endpoints/{instance-endpoint-id} (Deprecated)
Returns list of instance runtimes of service VM being deployed Returns list of instance runtimes of service VMs being deployed for a given service instance id	GET /api/v1/serviceinsertion/services/{service-id}/service-instances/{service-instance-id}/instance-runtimes
Deploy and set up service VMs either as standalone or HA Deploys one service VM as standalone, or two service VMs as HA where one VM is active and another one is standby. During the deployment of service VMs, service will be set up based on deployment events using callbacks.	POST /api/v1/serviceinsertion/services/{service-id}/service-instances/{service-instance-id}/instance-runtimes?action=deploy (Deprecated)
Remove service VMs either as standalone or HA Undeploy one service VM as standalone or two service VMs as HA. Associated deployment information and instance runtime will also be deleted once service VMs have been un-deployed successfully.	POST /api/v1/serviceinsertion/services/{service-id}/service-instances/{service-instance-id}/instance-runtimes?action=delete (Deprecated)
Upgrade service VMs using newer version of OVF Upgrade service VMs using newer version of OVF. Upgrade is a 2 step process. Update the 'deployment_spec_name' in the ServiceInstance to the new DeploymentSpec to which the service VMs will be upgraded, folowed by this 'upgrade' api. In case of HA, the stand-by service VM will be upgrade first. Once it has been upgraded, it switches to be the Active one and then the other VM will be upgrade.	POST /api/v1/serviceinsertion/services/{service-id}/service-instances/{service-instance-id}/instance-runtimes?action=upgrade (Deprecated)
Update maintenance mode or runtime state of a service VM Set service VM either in or out of maintenance mode for maintenance mode, or in service or out of service for runtime state. Only one value can be set at one time.	POST /api/v1/serviceinsertion/services/{service-id}/service-instances/{service-instance-id}/instance-runtimes/{instance-runtime-id}
Get statistics for a given interface identified by the interface index Returns statistics of a specified interface via associated logical port. If the logical port is attached to a logical router port, query parameter "source=realtime" is not supported.	GET /api/v1/serviceinsertion/services/{service-id}/service-instances/{service-instance-id}/instance-runtimes/{instance-runtime-id}/interfaces/{interface_index}/statistics (Deprecated)
Get operational status for an interface Returns operational status of a specified interface	GET /api/v1/serviceinsertion/services/{service-id}/service-instances/{service-instance-id}/instance-runtimes/{instance-runtime-id}/interfaces/{interface_index}/status
Get Service-Instance state for Service. Returns configuration state of one instance of a deployed partner service using service insertion framework.	GET /api/v1/serviceinsertion/services/{service-id}/service-instances/{service-instance-id}/state
Get Service-Instance status for Service. Returns status of one instance of a deployed partner service using service insertion framework. By default this API would return cached status. Caching happens every 3 minutes. For realtime status, query parameter "source=realtime" needs to be passed.	GET /api/v1/serviceinsertion/services/{service-id}/service-instances/{service-instance-id}/status
List all Service Profiles of a Service. List all service profiles of a service.	GET /api/v1/serviceinsertion/services/{service-id}/service-profiles (Deprecated)
Add ServiceProfile for a given Service. Adds a new service profile.	POST /api/v1/serviceinsertion/services/{service-id}/service-profiles (Deprecated)
Delete a particular ServiceProfile. Delete service profile for a given service.	DELETE /api/v1/serviceinsertion/services/{service-id}/service-profiles/{service-profile-id} (Deprecated)
Get a particular ServiceProfile for a Service. Returns detailed service profile information for a given Service.	GET /api/v1/serviceinsertion/services/{service-id}/service-profiles/{service-profile-id} (Deprecated)
Get NSgroups for a given ServiceProfile. Returns list of NSGroups used in Service Insertion rules for a given Service Profile.	GET /api/v1/serviceinsertion/services/{service-id}/service-profiles/{service-profile-id}/nsgroups (Deprecated)
List all ServiceChainMappings. List all service chain mappings in the system for the given service profile.	GET /api/v1/serviceinsertion/services/{service-id}/service-profiles/{service-profile-id}/service-chain-mappings (Deprecated)
Get Solution Config Information associated with a given service. Returns Solution Config information for a given service.	GET /api/v1/serviceinsertion/services/{service-id}/solution-configs
Add Solution Config for a given Service Adds a solution config. Solution Config are service level objects, required for configuring the NXGI partner Service after deployment.	POST /api/v1/serviceinsertion/services/{service-id}/solution-configs
Deletes solution config information. Deletes solution config information for a given service.	DELETE /api/v1/serviceinsertion/services/{service-id}/solution-configs/{solution-config-id}
Get Solution Config Information for a given solution config id. Returns Solution Config information for a given solution config id.	GET /api/v1/serviceinsertion/services/{service-id}/solution-configs/{solution-config-id}
Updates Solution Config for a given Service Updates a solution config. Solution Config are service level objects, required for configuring the NXGI partner Service after deployment.	PUT /api/v1/serviceinsertion/services/{service-id}/solution-configs/{solution-config-id}
Deletes extended solution config information. Deletes extended solution config information for a given solution config id.	DELETE /api/v1/serviceinsertion/services/{service-id}/solution-configs/{solution-config-id}/extended-solution-config
Get extended solution Config Information for a given solution config id. Returns extended solution config information for a given solution config id.	GET /api/v1/serviceinsertion/services/{service-id}/solution-configs/{solution-config-id}/extended-solution-config
Add Extended solution Config for a given Service Adds a extended solution config. Extended Solution Config are service level objects, used by the NXGI partner Service inside the SVM.	POST /api/v1/serviceinsertion/services/{service-id}/solution-configs/{solution-config-id}/extended-solution-config
Updates extended solution Config for a given Service Updates a extended solution config. Extended Solution Config are service level objects, used by the NXGI partner Service inside the SVM.	PUT /api/v1/serviceinsertion/services/{service-id}/solution-configs/{solution-config-id}/extended-solution-config
List all VendorTemplates of a Service. List all vendor templates of a service.	GET /api/v1/serviceinsertion/services/{service-id}/vendor-templates
Add Vendor Template for a given Service Adds a new vendor template. Vendor templates are service level objects, registered to be used in Service Profiles.	POST /api/v1/serviceinsertion/services/{service-id}/vendor-templates
Delete a particular vendor tempalte. Delete vendor template information for a given service. Please make sure to delete all the Service Profile(s), which refer to this vendor tempalte before deleting the template itself.	DELETE /api/v1/serviceinsertion/services/{service-id}/vendor-templates/{vendor-template-id}
Get a particular vendor template for a given service. Returns detailed vendor template information for a given service.	GET /api/v1/serviceinsertion/services/{service-id}/vendor-templates/{vendor-template-id}
Resolve 'source node id' value to source entities. Service insertion data path inserts unique 'source node id' value into each packet. This API can be used to identify the source of the packet using this value. It can be resolved to multiple source entities.	GET /api/v1/serviceinsertion/source-entities