NSX-T Data Center REST API

Associated URIs:

API Description	API Path
List IDS cluster configs List intrusion detection system cluster configs.	GET /policy/api/v1/infra/settings/firewall/security/intrusion-services/cluster-configs
Read IDS cluster config. Read intrusion detection system cluster config	GET /policy/api/v1/infra/settings/firewall/security/intrusion-services/cluster-configs/{cluster-config-id}
Patch IDS config on cluster level Patch intrusion detection system on cluster level.	PATCH /policy/api/v1/infra/settings/firewall/security/intrusion-services/cluster-configs/{cluster-config-id}
create or update IDS config on cluster level Update intrusion detection system on cluster level.	PUT /policy/api/v1/infra/settings/firewall/security/intrusion-services/cluster-configs/{cluster-config-id}
List IDS Custom Signature Versions List IDS Custom Signature Versions.	GET /policy/api/v1/infra/settings/firewall/security/intrusion-services/custom-signature-versions GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/settings/firewall/security/intrusion-services/custom-signature-versions
Get IDS Custom Signature Version Get IDS Custom Signature Version.	GET /policy/api/v1/infra/settings/firewall/security/intrusion-services/custom-signature-versions/{version-id} GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/settings/firewall/security/intrusion-services/custom-signature-versions/{version-id}
Add IDS custom signatures Add IDS custom signatures	POST /policy/api/v1/infra/settings/firewall/security/intrusion-services/custom-signature-versions/{version-id}
List IDS Custom Signatures List IDS Custom Signatures.	GET /policy/api/v1/infra/settings/firewall/security/intrusion-services/custom-signature-versions/{version-id}/custom-signatures GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/settings/firewall/security/intrusion-services/custom-signature-versions/{version-id}/custom-signatures
Publish/Cancel/Validate the custom signatures Publish/Cancel/Validate the customer signatures. CANCEL: Revert to earlier published state i.e. cancel/remove all the unpublished custom signatures. VALIDATE: Trigger the validation of the custom signatures. PUBLISH: Publish the custom signatures. This action will push all the valid custom signatures to datapath.	POST /policy/api/v1/infra/settings/firewall/security/intrusion-services/custom-signature-versions/{version-id}/custom-signatures
Get IDS Custom Signature difference Get published and unpublished custom signatures difference.	GET /policy/api/v1/infra/settings/firewall/security/intrusion-services/custom-signature-versions/{version-id}/custom-signatures-diff GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/settings/firewall/security/intrusion-services/custom-signature-versions/{version-id}/custom-signatures-diff
Get IDS Custom Signature Get IDS Custom Signature.	GET /policy/api/v1/infra/settings/firewall/security/intrusion-services/custom-signature-versions/{version-id}/custom-signatures/{sig-id} GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/settings/firewall/security/intrusion-services/custom-signature-versions/{version-id}/custom-signatures/{sig-id}
Export Custom signatures into a file. API can be used for user to export the existing custom signatures. Accept application/json, text/plain, */* Accept-Encoding gzip, deflate, br	GET /policy/api/v1/infra/settings/firewall/security/intrusion-services/custom-signature-versions/{version-id}/custom-signatures/export GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/settings/firewall/security/intrusion-services/custom-signature-versions/{version-id}/custom-signatures/export
Upload IDS custom signature bundle Upload IDS custom signature bundle.	POST /policy/api/v1/infra/settings/firewall/security/intrusion-services/custom-signature-versions/{version-id}/custom-signatures/upload-custom-signatures
List Global IDS signatures List global intrusion detection signatures.	GET /policy/api/v1/infra/settings/firewall/security/intrusion-services/global-signatures
Delete Global IDS signature Delete global intrusion detection signature.	DELETE /policy/api/v1/infra/settings/firewall/security/intrusion-services/global-signatures/{signature-id}
Get Global IDS signature. Read global intrusion detection signature	GET /policy/api/v1/infra/settings/firewall/security/intrusion-services/global-signatures/{signature-id}
Patch Global IDS Signature Patch global intrusion detection system signature.	PATCH /policy/api/v1/infra/settings/firewall/security/intrusion-services/global-signatures/{signature-id}
create or update Global IDS Signature Update global intrusion detection signature.	PUT /policy/api/v1/infra/settings/firewall/security/intrusion-services/global-signatures/{signature-id}
List all threshold configurations for IDS system signature List all threshold configurations for IDS signatures. This API is applicable only for 'System' signatures.	GET /policy/api/v1/infra/settings/firewall/security/intrusion-services/global-signatures/threshold-configs
Delete threshold configuration for IDS system signature Resets threshold configuration for IDS system signature to default values. This API is applicable only for 'System' signatures.	DELETE /policy/api/v1/infra/settings/firewall/security/intrusion-services/global-signatures/threshold-configs/{signature-id}
Get threshold configuration for IDS system signature Retrieve threshold and rate filter configuration for IDS signature. This API is applicable only for 'System' signatures.	GET /policy/api/v1/infra/settings/firewall/security/intrusion-services/global-signatures/threshold-configs/{signature-id}
Patch threshold configuration for IDS system signature Patch threshold and rate filter configuration for IDS signature globally. This API is applicable only for 'System' signatures. Either or both of threshold and rate filter configuration can be provided.	PATCH /policy/api/v1/infra/settings/firewall/security/intrusion-services/global-signatures/threshold-configs/{signature-id}
Update threshold configuration for IDS system signature Update threshold and rate filter configuration for IDS signature globally. This API is applicable only for 'System' signatures. Either or both of threshold and rate filter configuration can be provided.	PUT /policy/api/v1/infra/settings/firewall/security/intrusion-services/global-signatures/threshold-configs/{signature-id}
List Global IDS signatures List global intrusion detection signatures.	GET /policy/api/v1/infra/settings/firewall/security/intrusion-services/gsm/global-signatures
Read IDS config Read intrusion detection system config of standalone hosts.	GET /policy/api/v1/infra/settings/firewall/security/intrusion-services/ids-standalone-host-config
Patch IDS configuration Patch intrusion detection system configuration on standalone hosts.	PATCH /policy/api/v1/infra/settings/firewall/security/intrusion-services/ids-standalone-host-config
Create or update IDS configuration Update intrusion detection system configuration on standalone hosts.	PUT /policy/api/v1/infra/settings/firewall/security/intrusion-services/ids-standalone-host-config
Get IDS signature versions Intrusion detection system signature versions.	GET /policy/api/v1/infra/settings/firewall/security/intrusion-services/signature-versions
Change the state of IDS Signature Version Make this IDS Signature version as ACTIVE version and other versions as NOTACTIVE.	POST /policy/api/v1/infra/settings/firewall/security/intrusion-services/signature-versions?action=make_active_version
List IDS signatures List intrusion detection system signatures.	GET /policy/api/v1/infra/settings/firewall/security/intrusion-services/signature-versions/{version-id}/signatures
Upload IDS signatures bundle Upload IDS signatures bundle	POST /policy/api/v1/infra/settings/firewall/security/intrusion-services/signatures?action=upload_signatures
Download and update IDS signatures Trigger the process to Download and update the IDS signatures manually.	POST /policy/api/v1/infra/settings/firewall/security/intrusion-services/signatures?action=update_signatures
Get IDS signature status Intrusion detection system signatures status.	GET /policy/api/v1/infra/settings/firewall/security/intrusion-services/signatures/status