FRA Group - Flexible Security Service API References (1.0.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:
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

OK

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":
    [
    ]
}

Create FRA Groups

Create FRA Group resources.

Authorizations:
Request Body schema: application/json
fraGroup
required
object (FraGroupCreateRequest)

Responses

202

OK

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

Content type
application/json
Copy
Expand all Collapse all
{
  • "fraGroup":
    {
    }
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "fraGroup":
    {
    }
}

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

200

OK

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":
    {
    }
}

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

202

OK

400

Bad Request

401

Unauthorized

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

Content type
application/json
Copy
Expand all Collapse all
{
  • "fraGroup":
    {
    }
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "fraGroup":
    {