Area - Flexible Security Service API References (1.0.0)
Download OpenAPI specification:Download
Area are the resource accommodation units.
Get Area
Get Area 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
500
Internal Server Error
503
Service Unavailable
get/v1/areas
https://api.ntt.com/fsec-ers/v1/areas
Response samples
- 200
- 400
- 401
- 500
- 503
Content type
application/json
Copy
Expand all Collapse all {- "areas": [
- {
- "id": "12345678-1234-1234-1234-1234567890a1",
- "name": "JPEAST",
- "description": "japan-east",
- "status": "ACTIVE"
}, - {
- "id": "12345678-1234-1234-1234-1234567890a2",
- "name": "JPWEST",
- "description": "japan-west",
- "status": "ACTIVE"
}
]
}Get Area Details
Get a Area resource.
Authorizations:
path Parameters
| area_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/areas/{area_id}
https://api.ntt.com/fsec-ers/v1/areas/{area_id}
Response samples
- 200
- 400
- 401
- 404
- 500
- 503
Content type
application/json
Copy
Expand all Collapse all {- "area": {
- "id": "12345678-1234-1234-1234-1234567890a1",
- "name": "JPEAST",
- "description": "japan-east",
- "status": "ACTIVE"
}
}