Tier - Flexible Security Service API References (1.0.0)
Download OpenAPI specification:Download
Tier are the resource accommodation units.
Get Tiers
Get Tier 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. |
| status | string Enum: "ACTIVE" "INACTIVE" "DEPRECATED" A status of the resource. |
Responses
200
OK
400
Bad Request
401
Unauthorized
403
Forbidden
500
Internal Server Error
503
Service Unavailable
get/v1/tiers
https://api.ntt.com/fsec-ers/v1/tiers
Response samples
- 200
- 400
- 401
- 403
- 500
- 503
Content type
application/json
Copy
Expand all Collapse all {- "tiers": [
- {
- "id": "12345678-1234-1234-1234-1234567890a1",
- "name": "Tier1",
- "description": "Tier1",
- "clientsLowerLimit": 100,
- "clientsUpperLimit": 490,
- "candidateGatewayBandwidth": [
- "100M"
], - "bestEffortBandwidth": "100M",
- "status": "ACTIVE"
}, - {
- "id": "12345678-1234-1234-1234-1234567890a2",
- "name": "Tier1",
- "description": "Tier1",
- "clientsLowerLimit": 500,
- "clientsUpperLimit": 990,
- "candidateGatewayBandwidth": [
- "100M",
- "200M",
- "300M",
- "500M",
- "1G"
], - "bestEffortBandwidth": "1G",
- "status": "ACTIVE"
}
]
}Get Tier
Get Tier resource.
Authorizations:
path Parameters
| tier_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
403
Forbidden
404
Not Found
500
Internal Server Error
503
Service Unavailable
get/v1/tiers/{tier_id}
https://api.ntt.com/fsec-ers/v1/tiers/{tier_id}
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
- 503
Content type
application/json
Copy
Expand all Collapse all {- "tier": {
- "id": "12345678-1234-1234-1234-1234567890a1",
- "name": "Tier1",
- "description": "Tier1",
- "clientsLowerLimit": 100,
- "clientsUpperLimit": 490,
- "candidateGatewayBandwidth": [
- "100M"
], - "bestEffortBandwidth": "100M",
- "status": "ACTIVE"
}
}