NSX-T Data Center REST API

Returns information about a particular AWS security group

Returns information about AWS security group like inbound rules,
outbound rules and cloud_tags.

Request:

Method:

GET

URI Path(s):

/api/v1/csm/aws/vpcs/{vpc-id}/security-groups/{security-group-id}

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

n/a

Example Request:

GET https://<nsx-csm>/api/v1/csm/aws/vpcs//security-groups/

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

AwsSecurityGroup+

AwsSecurityGroup (schema)

Name	Description	Type	Notes
_last_sync_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_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
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cloud_tags	Cloud Tags Array of tags associated to a cloud security group.	array of CloudTag	Readonly
description	Security Group Description Description of AWS security group.	string	Readonly
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
inbound_rules	Inbound Rules Array of inbound rules of the AWS security group.	array of AwsSecurityGroupRule	Readonly
instances_count	Count Of Instances Number of instances associated to cloud security group.	integer	Readonly
is_managed_by_nsx	Is Managed By NSX If the flag is true, the cloud security group is managed by NSX.	boolean	Readonly
nsx_security_group	NSX Security Group Stores information about the NSX security group corresponding to the AWS security group.	SecurityGroup	Readonly
outbound_rules	Outbound Rules Array of outbound rules of the AWS security group.	array of AwsSecurityGroupRule	Readonly
region_id	Region ID ID of the cloud region.	string	Readonly
resource_type	Must be set to the value AwsSecurityGroup	string	Required
scope	List of scopes for discovered resource Specifies list of scope of discovered resource. e.g. if VHC path is associated with principal identity, who owns the discovered resource, then scope id will be VHC path and scope type will be VHC.	array of DiscoveredResourceScope
security_group_id	Security Group ID ID of the cloud security group.	string	Readonly
security_group_name	Security Group Name Name of the cloud security group.	string	Readonly
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Required Permissions:

read

Feature:

cloud_resources

Additional Errors:

• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable