FRA Group - Flexible Security Service API References (1.0.0)
Download OpenAPI specification:Download
The FRA group brings together the nodes of the FRA.
Get FRA Groups
Get FRA Group resources.
Authorizations:
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
OK
Bad Request
Unauthorized
Internal Server Error
Service Unavailable
Response samples
- 200
- 400
- 401
- 500
- 503
{- "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",
- "internetGatewayIpv4Cidr": "172.16.0.0/16",
- "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",
- "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:
Request Body schema: application/json
fraGroup required | object (FraGroupCreateRequest) |
Responses
OK
Bad Request
Unauthorized
Internal Server Error
Service Unavailable
Request samples
- Payload
{- "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",
- "internetGatewayIpv4Cidr": "172.16.0.0/16",
- "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"
}
}
Response samples
- 202
- 400
- 401
- 500
- 503
{- "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",
- "internetGatewayIpv4Cidr": "172.16.0.0/16",
- "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",
- "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:
path Parameters
fra_group_id required | string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$ |
Responses
OK
Bad Request
Unauthorized
Not Found
Internal Server Error
Service Unavailable
Response samples
- 200
- 400
- 401
- 404
- 500
- 503
{- "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",
- "internetGatewayIpv4Cidr": "172.16.0.0/16",
- "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",
- "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:
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
OK
Bad Request
Unauthorized
Internal Server Error
Service Unavailable
Request samples
- Payload
{- "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
}
}
}
Response samples
- 202
- 400
- 401
- 500
- 503
{- "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",
- "internetGatewayIpv4Cidr": "172.16.0.0/16"