FRA Group - Flexible Security Service API References (1.3.0)

Download OpenAPI specification:Download

The FRA group brings together the nodes of the FRA.

Authentication

X-Auth-Token

Security Scheme Type	API Key
Header parameter name:	{keystone_token}

fra-group

Get FRA Groups

Get FRA Group resources.

Authorizations:

X-Auth-Token

query Parameters

id	string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$ The ID of the resource.
name	string ^[a-zA-Z0-9-_]{1,255}$ A name of the resource.
osVersionId	string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$ ID of the os version to be applied to the resource.
tenantId	string ^[a-fA-F0-9]{32}$ ID of the tenant to which the resource belongs.
serviceGroupId	string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$ ID of the service group to which the resource belongs.
vpnGatewayQos	string Enum: "best-effort" "guarantee" VPN Gateway QoS option
vpnGatewayBandwidth	string Enum: "100M" "200M" "300M" "500M" "1G" "2G" "3G" "4G" "5G" VPN Gateway bandwidth option
internetGatewayQos	string Enum: "best-effort" "guarantee" Internet Gateway QoS option
internetGatewayBandwidth	string Enum: "100M" "200M" "300M" "500M" "1G" "2G" "3G" "4G" "5G" Internet Gateway Bandwidth option

Responses

200

400

Bad Request

401

Unauthorized

500

Internal Server Error

503

Service Unavailable

get/v1/fra-groups

https://api.ntt.com/fsec-ers/v1/fra-groups

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"fraGroups": 
[
{"id": "12345678-1234-1234-1234-1234567890a1",
"name": "fra-group-a",
"description": "fra-group-a",
"maxClients": 100,
"osVersionId": "12345678-1234-1234-1234-1234567890b1",
"defaultRoute": "fic",
"units": 
[
{"id": "12345678-1234-1234-1234-123456789021",
"areaId": "12345678-1234-1234-1234-1234567890c1",
"reservedIpv4Cidr": "10.0.1.0/27",
"ficConnectionIpv4Cidr": "10.0.2.0/27",
"fraPortalIpv4Cidr": "10.0.3.0/28",
"vpnPrivateIpv4Cidr": "10.0.4.0/27",
"inetPrivateIpv4Cidr": "10.0.5.0/27",
"clientIpv4CidrPools": 
["192.168.0.0/24",
"192.168.100.0/24"
],
"portalFqdn": "nttcom-0123456-portal.fra.ntt.com",
"serviceInterConnectId": null,
"vportFicConnectionId": null,
"operationStatus": "COMPLETE",
"updatedAt": "2022-06-01T06:00:00.000Z",
"createdAt": "2022-06-01T06:00:00.000Z",
"nodes": 
[
{"hostname": "fra123456700.ntt.com",
"fraPortalIp": "10.0.3.1",
"natIp": "203.0.113.3",
"gatewayFqdn": "nttcom-0123456-gw0.fra.ntt.com",
"appliedClientIpv4CidrPools": 
["192.168.0.0/25",
"192.168.100.0/25"
]
},
{"hostname": "fra123456701.ntt.com",
"fraPortalIp": "10.0.3.2",
"natIp": "203.0.113.4",
"gatewayFqdn": "nttcom-0123456-gw1.fra.ntt.com",
"appliedClientIpv4CidrPools": 
["192.168.0.128/25",
"192.168.100.128/25"
]
}
]
}
],
"domainName": "nttcom",
"recommendedSecurityProfile": true,
"overseasUse": 
{"status": false,
"salesEmailAddress": null
},
"gatewayOptions": 
{"vpnGatewayQos": "guarantee",
"vpnGatewayBandwidth": "500M",
"internetGatewayQos": "best-effort",
"internetGatewayBandwidth": "1G"
},
"ldapServiceRoute": "internet",
"crlServiceRoute": "internet",
"serviceGroupId": "12345678-1234-1234-1234-123456789011",
"operationStatus": "COMPLETE",
"tenantId": "1234567890abcdef1234567890abcdef",
"updatedAt": "2022-06-01T06:00:00.000Z",
"createdAt": "2022-06-01T00:00:00.000Z"
}
]
}

Create FRA Groups

Create FRA Group resources.

Authorizations:

X-Auth-Token

Request Body schema: application/json

fraGroup

required

object (FraGroupCreateRequest)

Responses

202

400

Bad Request

401

Unauthorized

500

Internal Server Error

503

Service Unavailable

post/v1/fra-groups

https://api.ntt.com/fsec-ers/v1/fra-groups

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"fraGroup": 
{"name": "fra-group-a",
"description": "fra-group-a",
"maxClients": 100,
"osVersionId": "12345678-1234-1234-1234-1234567890b1",
"defaultRoute": "fic",
"units": 
[
{"areaId": "12345678-1234-1234-1234-1234567890c1",
"reservedIpv4Cidr": "10.0.1.0/27",
"ficConnectionIpv4Cidr": "10.0.2.0/27",
"fraPortalIpv4Cidr": "10.0.3.0/28",
"vpnPrivateIpv4Cidr": "10.0.4.0/27",
"inetPrivateIpv4Cidr": "10.0.5.0/27",
"clientIpv4CidrPools": 
["192.168.0.0/24",
"192.168.100.0/24"
],
"vpnDnsPrimary": "172.16.53.1",
"vpnDnsSecondary": "172.16.53.2"
}
],
"domainName": "nttcom",
"recommendedSecurityProfile": true,
"overseasUse": 
{"status": true,
"salesEmailAddress": "example@ntt.com"
},
"gatewayOptions": 
{"vpnGatewayQos": "guarantee",
"vpnGatewayBandwidth": "2G",
"internetGatewayQos": "guarantee",
"internetGatewayBandwidth": "1G"
},
"serviceGroupId": "12345678-1234-1234-1234-123456789011",
"ldapServiceRoute": "internet",
"crlServiceRoute": "internet"
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"fraGroup": 
{"id": "12345678-1234-1234-1234-1234567890a1",
"name": "fra-group-a",
"description": "fra-group-a",
"maxClients": 100,
"osVersionId": "12345678-1234-1234-1234-1234567890b1",
"defaultRoute": "fic",
"units": 
[
{"id": "12345678-1234-1234-1234-123456789021",
"areaId": "12345678-1234-1234-1234-1234567890c1",
"reservedIpv4Cidr": "10.0.1.0/27",
"ficConnectionIpv4Cidr": "10.0.2.0/27",
"fraPortalIpv4Cidr": "10.0.3.0/28",
"vpnPrivateIpv4Cidr": "10.0.4.0/27",
"inetPrivateIpv4Cidr": "10.0.5.0/27",
"clientIpv4CidrPools": 
["192.168.0.0/24",
"192.168.100.0/24"
],
"vpnDnsPrimary": "172.16.53.1",
"vpnDnsSecondary": "172.16.53.2",
"portalFqdn": "nttcom-0123456-portal.fra.ntt.com",
"serviceInterConnectId": null,
"vportFicConnectionId": null,
"operationStatus": "COMPLETE",
"updatedAt": "2022-06-01T06:00:00.000Z",
"createdAt": "2022-06-01T06:00:00.000Z",
"nodes": 
[
{"hostname": "fra123456700.ntt.com",
"fraPortalIp": "10.0.3.1",
"natIp": "203.0.113.3",
"gatewayFqdn": "nttcom-0123456-gw0.fra.ntt.com",
"appliedClientIpv4CidrPools": 
["192.168.0.0/25",
"192.168.100.0/25"
]
},
{"hostname": "fra123456701.ntt.com",
"fraPortalIp": "10.0.3.2",
"natIp": "203.0.113.4",
"gatewayFqdn": "nttcom-0123456-gw1.fra.ntt.com",
"appliedClientIpv4CidrPools": 
["192.168.0.128/25",
"192.168.100.128/25"
]
}
]
}
],
"domainName": "nttcom",
"recommendedSecurityProfile": true,
"overseasUse": 
{"status": true,
"salesEmailAddress": "example@ntt.com"
},
"gatewayOptions": 
{"vpnGatewayQos": "guarantee",
"vpnGatewayBandwidth": "500M",
"internetGatewayQos": "best-effort",
"internetGatewayBandwidth": "1G"
},
"ldapServiceRoute": "internet",
"crlServiceRoute": "internet",
"serviceGroupId": "12345678-1234-1234-1234-123456789011",
"operationStatus": "COMPLETE",
"operationId": "12345678-1234-1234-1234-123456789012",
"tenantId": "1234567890abcdef1234567890abcdef",
"updatedAt": "2022-06-01T06:00:00.000Z",
"createdAt": "2022-06-01T00:00:00.000Z"
}
}

Get FRA Group

Get FRA Group resource.

Authorizations:

X-Auth-Token

path Parameters

fra_group_id

required

string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$

Responses

200

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

503

Service Unavailable

get/v1/fra-groups/{fra_group_id}

https://api.ntt.com/fsec-ers/v1/fra-groups/{fra_group_id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"fraGroup": 
{"id": "12345678-1234-1234-1234-1234567890a1",
"name": "fra-group-a",
"description": "fra-group-a",
"maxClients": 100,
"osVersionId": "12345678-1234-1234-1234-1234567890b1",
"defaultRoute": "fic",
"units": 
[
{"id": "12345678-1234-1234-1234-123456789021",
"areaId": "12345678-1234-1234-1234-1234567890c1",
"reservedIpv4Cidr": "10.0.1.0/27",
"ficConnectionIpv4Cidr": "10.0.2.0/27",
"fraPortalIpv4Cidr": "10.0.3.0/28",
"vpnPrivateIpv4Cidr": "10.0.4.0/27",
"inetPrivateIpv4Cidr": "10.0.5.0/27",
"clientIpv4CidrPools": 
["192.168.0.0/24",
"192.168.100.0/24"
],
"portalFqdn": "nttcom-0123456-portal.fra.ntt.com",
"serviceInterConnectId": null,
"vportFicConnectionId": null,
"operationStatus": "COMPLETE",
"updatedAt": "2022-06-01T06:00:00.000Z",
"createdAt": "2022-06-01T06:00:00.000Z",
"nodes": 
[
{"hostname": "fra123456700.ntt.com",
"fraPortalIp": "10.0.3.1",
"natIp": "203.0.113.3",
"gatewayFqdn": "nttcom-0123456-gw0.fra.ntt.com",
"appliedClientIpv4CidrPools": 
["192.168.0.0/25",
"192.168.100.0/25"
]
},
{"hostname": "fra123456701.ntt.com",
"fraPortalIp": "10.0.3.2",
"natIp": "203.0.113.4",
"gatewayFqdn": "nttcom-0123456-gw1.fra.ntt.com",
"appliedClientIpv4CidrPools": 
["192.168.0.128/25",
"192.168.100.128/25"
]
}
]
}
],
"domainName": "nttcom",
"recommendedSecurityProfile": true,
"overseasUse": 
{"status": true,
"salesEmailAddress": "example@ntt.com"
},
"gatewayOptions": 
{"vpnGatewayQos": "guarantee",
"vpnGatewayBandwidth": "500M",
"internetGatewayQos": "best-effort",
"internetGatewayBandwidth": "1G"
},
"ldapServiceRoute": "fic",
"crlServiceRoute": "fic",
"serviceGroupId": "12345678-1234-1234-1234-123456789011",
"operationStatus": "COMPLETE",
"tenantId": "1234567890abcdef1234567890abcdef",
"updatedAt": "2022-06-01T06:00:00.000Z",
"createdAt": "2022-06-01T00:00:00.000Z"
}
}

Update FRA Groups

Update FRA Group resources.

Authorizations:

X-Auth-Token

path Parameters

fra_group_id

required

string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$

Request Body schema: application/json

fraGroup

required

object (FraGroupUpdateRequest)

Responses

202

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

503

Service Unavailable

patch/v1/fra-groups/{fra_group_id}

https://api.ntt.com/fsec-ers/v1/fra-groups/{fra_group_id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"fraGroup": 
{"name": "fra-group-a",
"description": "fra-group-a",
"maxClients": 100,
"osVersionId": "12345678-1234-1234-1234-1234567890b1",
"gatewayOptions": 
{"vpnGatewayQos": "guarantee",
"vpnGatewayBandwidth": "100M",
"vpnGatewayPublicIpChange": true,
"internetGatewayQos": "best-effort",
"internetGatewayBandwidth": "100M",
"internetGatewayPublicIpChange": false
},
"units": 
[
{"id": "12345678-1234-1234-1234-123456789021",
"vpnPrivateIpv4Cidr": "10.0.4.0/27",
"inetPrivateIpv4Cidr": "10.0.5.0/27"
}
]
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"fraGroup": 
{"id": "12345678-1234-1234-1234-1234567890a1",
"name": "fra-group-a",
"description": "fra-group-a",
"maxClients": 100,
"osVersionId": "12345678-1234-1234-1234-1234567890b1",
"defaultRoute": "fic",
"units": 
[
{"id": "12345678-1234-1234-1234-123456789021",
"areaId": "12345678-1234-1234-1234-1234567890c1",
"reservedIpv4Cidr": "10.0.1.0/27",
"ficConnectionIpv4Cidr": "10.0.2.0/27",
"fraPortalIpv4Cidr": "10.0.3.0/28",
"vpnPrivateIpv4Cidr": "10.0.4.0/27",
"inetPrivateIpv4Cidr": "10.0.5.0/27",
"clientIpv4CidrPools": 
["192.168.0.0/24",
"192.168.100.0/24"
],
"portalFqdn": "nttcom-0123456-portal.fra.ntt.com",
"serviceInterConnectId": null,
"vportFicConnectionId": null,
"operationStatus": "PROCESSING",
"updatedAt": "2022-06-01T06:00:00.000Z",
"createdAt": "2022-06-01T06:00:00.000Z",
"nodes": 
[
{"hostname": "fra123456700.ntt.com",
"fraPortalIp": "10.0.3.1",
"natIp": "203.0.113.3",
"gatewayFqdn": "nttcom-0123456-gw0.fra.ntt.com",
"appliedClientIpv4CidrPools": 
["192.168.0.0/25",
"192.168.100.0/25"
]
},
{"hostname": "fra123456701.ntt.com",
"fraPortalIp": "10.0.3.2",
"natIp": "203.0.113.4",
"gatewayFqdn": "nttcom-0123456-gw1.fra.ntt.com",
"appliedClientIpv4CidrPools": 
["192.168.0.128/25",
"192.168.100.128/25"
]
}
]
}
],
"domainName": "nttcom",
"recommendedSecurityProfile": true,
"overseasUse": 
{"status": true,
"salesEmailAddress": "example@ntt.com"
},
"gatewayOptions": 
{"vpnGatewayQos": "guarantee",
"vpnGatewayBandwidth": "100M",
"internetGatewayQos": "best-effort",
"internetGatewayBandwidth": "100M"
},
"ldapServiceRoute": "internet",
"crlServiceRoute": "internet",
"serviceGroupId": "12345678-1234-1234-1234-123456789011",
"operationId": "12345678-1234-1234-1234-1234567890a0",
"operationStatus": "PROCESSING",
"tenantId": "1234567890abcdef1234567890abcdef",
"updatedAt": "2022-06-01T06:00:00.000Z",
"createdAt": "2022-06-01T00:00:00.000Z"
}
}

Delete FRA Group

Delete FRA Group resource.

Authorizations:

X-Auth-Token

path Parameters

fra_group_id

required

string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$

Responses

202

400

Bad Request

401

Unauthorized

404

Not Found

409

Conflict

500

Internal Server Error

503

Service Unavailable

delete/v1/fra-groups/{fra_group_id}

https://api.ntt.com/fsec-ers/v1/fra-groups/{fra_group_id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"fraGroup": 
{"id": "12345678-1234-1234-1234-1234567890a1",
"name": "fra-group-a",
"description": "fra-group-a",
"maxClients": 100,
"osVersionId": "12345678-1234-1234-1234-1234567890b1",
"defaultRoute": "fic",
"units": 
[
{"id": "12345678-1234-1234-1234-123456789021",
"areaId": "12345678-1234-1234-1234-1234567890c1",
"reservedIpv4Cidr": "10.0.1.0/27",
"ficConnectionIpv4Cidr": "10.0.2.0/27",
"fraPortalIpv4Cidr": "10.0.3.0/28",
"vpnPrivateIpv4Cidr": "10.0.4.0/27",
"inetPrivateIpv4Cidr": "10.0.5.0/27",
"clientIpv4CidrPools": 
["192.168.0.0/24",
"192.168.100.0/24"
],
"portalFqdn": "nttcom-0123456-portal.fra.ntt.com",
"serviceInterConnectId": null,
"vportFicConnectionId": null,
"operationStatus": "PROCESSING",
"updatedAt": "2022-06-01T06:00:00.000Z",
"createdAt": "2022-06-01T06:00:00.000Z",
"nodes": 
[
{"hostname": "fra123456700.ntt.com",
"fraPortalIp": "10.0.3.1",
"natIp": "203.0.113.3",
"gatewayFqdn": "nttcom-0123456-gw0.fra.ntt.com",
"appliedClientIpv4CidrPools": 
["192.168.0.0/25",
"192.168.100.0/25"
]
},
{"hostname": "fra123456701.ntt.com",
"fraPortalIp": "10.0.3.2",
"natIp": "203.0.113.4",
"gatewayFqdn": "nttcom-0123456-gw1.fra.ntt.com",
"appliedClientIpv4CidrPools": 
["192.168.0.128/25",
"192.168.100.128/25"
]
}
]
}
],
"domainName": "nttcom",
"recommendedSecurityProfile": true,
"overseasUse": 
{"status": true,
"salesEmailAddress": "example@ntt.com"
},
"gatewayOptions": 
{"vpnGatewayQos": "guarantee",
"vpnGatewayBandwidth": "100M",
"internetGatewayQos": "best-effort",
"internetGatewayBandwidth": "100M"
},
"ldapServiceRoute": "internet",
"crlServiceRoute": "internet",
"serviceGroupId": "12345678-1234-1234-1234-123456789011",
"operationId": "12345678-1234-1234-1234-1234567890a0",
"operationStatus": "PROCESSING",
"tenantId": "1234567890abcdef1234567890abcdef",
"updatedAt": "2022-06-01T06:00:00.000Z",
"createdAt": "2022-06-01T00:00:00.000Z"
}
}

Create FRA Units

Create FRA Unit resources.

Authorizations:

X-Auth-Token

path Parameters

fra_group_id

required

string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$

Request Body schema: application/json

unit

required

object (FraUnitCreateRequest)

Responses

202

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

503

Service Unavailable

post/v1/fra-groups/{fra_group_id}/units

https://api.ntt.com/fsec-ers/v1/fra-groups/{fra_group_id}/units

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"unit": 
{"areaId": "12345678-1234-1234-1234-1234567890c1",
"reservedIpv4Cidr": "10.0.1.0/27",
"ficConnectionIpv4Cidr": "10.0.2.0/27",
"fraPortalIpv4Cidr": "10.0.3.0/28",
"vpnPrivateIpv4Cidr": "10.0.4.0/27",
"inetPrivateIpv4Cidr": "10.0.5.0/27",
"clientIpv4CidrPools": 
["192.168.0.0/24",
"192.168.100.0/24"
],
"vpnDnsPrimary": "172.16.53.1",
"vpnDnsSecondary": "172.16.53.2"
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"unit": 
{"id": "12345678-1234-1234-1234-123456789021",
"areaId": "12345678-1234-1234-1234-1234567890c1",
"reservedIpv4Cidr": "10.0.1.0/27",
"ficConnectionIpv4Cidr": "10.0.2.0/27",
"fraPortalIpv4Cidr": "10.0.3.0/28",
"vpnPrivateIpv4Cidr": "10.0.4.0/27",
"inetPrivateIpv4Cidr": "10.0.5.0/27",
"clientIpv4CidrPools": 
["192.168.0.0/24",
"192.168.100.0/24"
],
"vpnDnsPrimary": "172.16.53.1",
"vpnDnsSecondary": "172.16.53.2",
"portalFqdn": "nttcom-0123456-portal.fra.ntt.com",
"serviceInterConnectId": null,
"vportFicConnectionId": null,
"operationStatus": "PROCESSING",
"operationId": "12345678-1234-1234-1234-123456789012",
"nodes": 
[
{"hostname": "fra123456700.ntt.com",
"fraPortalIp": "10.0.3.1",
"natIp": "203.0.113.4",
"gatewayFqdn": "nttcom-0123456-gw0.fra.ntt.com",
"appliedClientIpv4CidrPools": 
["192.168.0.0/25",
"192.168.100.0/25"
]
},
{"hostname": "fra123456701.ntt.com",
"fraPortalIp": "10.0.3.2",
"natIp": "203.0.113.4",
"gatewayFqdn": "nttcom-0123456-gw1.fra.ntt.com",
"appliedClientIpv4CidrPools": 
["192.168.0.128/25",
"192.168.100.128/25"
]
}
],
"updatedAt": "2022-06-01T06:00:00.000Z",
"createdAt": "2022-06-01T06:00:00.000Z"
}
}

Create FRA Units

Create FRA Unit resources.

Authorizations:

X-Auth-Token

path Parameters

fra_group_id required	string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$
fra_unit_id required	string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$

Request Body schema: application/json

unit

required

object (FraUnitUpdateRequest)

Responses

202

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

503

Service Unavailable

patch/v1/fra-groups/{fra_group_id}/units/{fra_unit_id}

https://api.ntt.com/fsec-ers/v1/fra-groups/{fra_group_id}/units/{fra_unit_id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"unit": 
{"clientIpv4CidrPools": 
["192.168.0.0/24",
"192.168.100.0/24"
],
"vpnPrivateIpv4Cidr": "10.0.4.0/27",
"inetPrivateIpv4Cidr": "10.0.5.0/27"
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"unit": 
{"id": "12345678-1234-1234-1234-123456789021",
"areaId": "12345678-1234-1234-1234-1234567890c1",
"reservedIpv4Cidr": "10.0.1.0/27",
"ficConnectionIpv4Cidr": "10.0.2.0/27",
"fraPortalIpv4Cidr": "10.0.3.0/28",
"vpnPrivateIpv4Cidr": "10.0.4.0/27",
"inetPrivateIpv4Cidr": "10.0.5.0/27",
"clientIpv4CidrPools": 
["192.168.0.0/24",
"192.168.100.0/24"
],
"portalFqdn": "nttcom-0123456-portal.fra.ntt.com",
"serviceInterConnectId": null,
"vportFicConnectionId": null,
"operationStatus": "PROCESSING",
"operationId": "12345678-1234-1234-1234-123456789012",
"nodes": 
[
{"hostname": "fra123456700.ntt.com",
"fraPortalIp": "10.0.3.1",
"natIp": "203.0.113.3",
"gatewayFqdn": "nttcom-0123456-gw0.fra.ntt.com",
"appliedClientIpv4CidrPools": 
["192.168.0.0/25",
"192.168.100.0/25"
]
},
{"hostname": "fra123456701.ntt.com",
"fraPortalIp": "10.0.3.2",
"natIp": "203.0.113.4",
"gatewayFqdn": "nttcom-0123456-gw1.fra.ntt.com",
"appliedClientIpv4CidrPools": 
["192.168.0.128/25",
"192.168.100.128/25"
]
}
],
"updatedAt": "2022-06-01T06:00:00.000Z",
"createdAt": "2022-06-01T06:00:00.000Z"
}
}

Copy Configs

Copy Configs.

Authorizations:

X-Auth-Token

path Parameters

fra_group_id required	string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$
fra_unit_id required	string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$

Request Body schema: application/json

targetConfigs

required

object (FraUnitCopyConfigsRequest)

Responses

202

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

503

Service Unavailable

post/v1/fra-groups/{fra_group_id}/units/{fra_unit_id}/copy-configs

https://api.ntt.com/fsec-ers/v1/fra-groups/{fra_group_id}/units/{fra_unit_id}/copy-configs

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"targetConfigs": 
{"securityPolicy": null
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"targetConfigs": 
{"operationId": "12345678-1234-1234-1234-123456789021"
}
}

Get Incoming Traffic metrics

Get incoming traffic metrics.

Authorizations:

X-Auth-Token

path Parameters

fra_group_id required	string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$
fra_unit_id required	string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$
gateway required	string Enum: "fic" "vpn" "internet" fic: GW connected to FIC. vpn: GW used when connecting via VPN. internet: GW used when VPN-connected users access the internet.

query Parameters

from

string ^[0-9]{4}-(0[1-9]{1}|1[0-2]{1})-(0[1-9]|[1-2][0-9]|3[0-1])T(0[0-9]|1[0-9]|2[0-3]):(0[0-9]|[1-5][0-9]):(0[0-9]|[1-5][0-9])Z$

The start time for search. (If only the 'from' parameter is specified, 24 hours of data are retrieved starting from that time. If only the 'to' parameter is specified, 24 hours of data leading up to that time are retrieved. When both 'from' and 'to' are provided together, you can retrieve up to seven days of data in total.)

string ^[0-9]{4}-(0[1-9]{1}|1[0-2]{1})-(0[1-9]|[1-2][0-9]|3[0-1])T(0[0-9]|1[0-9]|2[0-3]):(0[0-9]|[1-5][0-9]):(0[0-9]|[1-5][0-9])Z$

(If only the 'from' parameter is specified, 24 hours of data are retrieved starting from that time. If only the 'to' parameter is specified, 24 hours of data leading up to that time are retrieved. When both 'from' and 'to' are provided together, you can retrieve up to seven days of data in total.)

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/v1/fra-groups/{fra_group_id}/units/{fra_unit_id}/traffic-in/{gateway}

https://api.ntt.com/fsec-ers/v1/fra-groups/{fra_group_id}/units/{fra_unit_id}/traffic-in/{gateway}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"results": 
[
{"trafficIn": 123,
"timestamp": "2025-04-24T12:15:00Z"
},
{"trafficIn": 456,
"timestamp": "2025-04-24T12:20:00Z"
}
]
}

Get Outgoing Traffic metrics

Get Outgoing traffic metrics.

Authorizations:

X-Auth-Token

path Parameters

fra_group_id required	string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$
fra_unit_id required	string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$
gateway required	string Enum: "fic" "vpn" "internet" fic: GW connected to FIC. vpn: GW used when connecting via VPN. internet: GW used when VPN-connected users access the internet.

query Parameters

from

string ^[0-9]{4}-(0[1-9]{1}|1[0-2]{1})-(0[1-9]|[1-2][0-9]|3[0-1])T(0[0-9]|1[0-9]|2[0-3]):(0[0-9]|[1-5][0-9]):(0[0-9]|[1-5][0-9])Z$

The end time for search. (If only the 'from' parameter is specified, 24 hours of data are retrieved starting from that time. If only the 'to' parameter is specified, 24 hours of data leading up to that time are retrieved. When both 'from' and 'to' are provided together, you can retrieve up to seven days of data in total.)

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/v1/fra-groups/{fra_group_id}/units/{fra_unit_id}/traffic-out/{gateway}

https://api.ntt.com/fsec-ers/v1/fra-groups/{fra_group_id}/units/{fra_unit_id}/traffic-out/{gateway}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"results": 
[
{"trafficOut": 123,
"timestamp": "2025-04-24T12:15:00Z"
},
{"trafficOut": 456,
"timestamp": "2025-04-24T12:20:00Z"
}
]
}