List Security Devices¶

Overview¶

Listing security devices associated with specific tenant.

Synchronous / Asynchronous¶

Synchronous

Request¶

HTTP Request Method¶

HTTP Request Path¶

{endpoint}/ecl-api/devices?tenantid={tenantid}&usertoken={x-subject-token}

HTTP Request Header¶

X-Auth-Token: <token_id>

Request Parameter¶

Request Parameters¶
Parameter	Type	Format	Description	Required
tenantid	String	UUID	Tenant ID of the owner (UUID)	Yes
usertoken	String	UUID	User Token (UUID)	Yes

Sample Request Body¶

This API does not require Request Body.

Response¶

HTTP Response Code¶

Response Codes¶
Response Code	Description
200	OK
400	Request format is invalid
401	Unauthorized
500	Internal Server Error

Response Parameter¶

Response Parameters¶
Parameter	Type	Format	Description
devices	Array	-	Array listing security devices associated with specific tenant
msa_device_id	String	-	MSA Device External reference. Devices upgraded from Version 1 to Version 2 will be changed to the value NCSxxxx instead of CES xxxx.
msa_device_type	String	-	MSA Device Type
os_server_id	String	UUID	Server id of Network-based Security devices
os_server_name	String	-	Server name on Openstack
os_availability_zone	String	-	Availability zone information
os_admin_username	String	-	Name of admin
os_server_status	String	-	Server Status

Sample Response Body¶

Normal Response¶

{
    "devices": [{
         "msa_device_id": "NCS4507",
         "msa_device_type": "UTM",
         "os_server_id": "4615fc66-6454-42d9-a73e-33f18246706c",
         "os_server_name": "UTM-second_unit-NCS4507",
         "os_availability_zone": "nova",
         "os_admin_username": "ntt-utm",
         "os_server_status": "ACTIVE"
    }]
}

Error Response¶

{
    "error": {
         "message": "error message"
    }
}

Network-based Security Portal API List for Version 2

List Security Device Interfaces