Advertise-Route-Prefixes - Flexible Secure Gateway API References (1.13.0)
Download OpenAPI specification:Download
Advertise-Route-Prefixes resource for BGP configuration.
Get Advertise-Route-Prefixes
Get Advertise route prefix 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. |
| cellGroupId | string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$ The Cell-Group ID which the resource belongs. |
| _limit | integer >= 1 The maximum number of items to return. |
| _offset | integer >= 0 The number of items to skip before starting to return results. |
| _order_by | Array of strings Items Enum: "id" "prefix" "cellGroupId" "tenantId" "createdAt" "updatedAt" Sort keys. |
header Parameters
| X-Auth-Token required | string The keystone token. |
Responses
200
OK
400
Bad Request
401
Unauthorized
500
Internal Server Error
get/v1/advertise-route-prefixes
https://api.ntt.com/dsigw-erg/v1/advertise-route-prefixes
Response samples
- 200
- 400
- 401
- 500
Content type
application/json
Copy
Expand all Collapse all {- "advertiseRoutePrefixes": [
- {
- "id": "12345678-1234-1234-1234-1234567890a1",
- "prefix": "192.168.1.0/24",
- "description": "prefix_1_description",
- "cellIds": [
- "12345678-1234-1234-1234-1234567890a1",
- "12345678-1234-1234-1234-1234567890a2"
], - "cellGroupId": "047ae2a5-c763-4bea-9171-e178d08951ca",
- "tenantId": "12345678abcdabcdabcd1234567890ab",
- "updatedAt": "2026-02-01T06:00:00Z",
- "createdAt": "2026-02-01T00:00:00Z"
}
]
}Create Advertise-Route-Prefix
Create an Advertise route prefix resource.
Authorizations:
header Parameters
| X-Auth-Token required | string The keystone token. |
Request Body schema: application/json
| advertiseRoutePrefix required | object (AdvertiseRoutePrefixCreateRequest) Advertise route prefix create request schema. |
Responses
200
OK
400
Bad Request
401
Unauthorized
500
Internal Server Error
post/v1/advertise-route-prefixes
https://api.ntt.com/dsigw-erg/v1/advertise-route-prefixes
Request samples
- Payload
Content type
application/json
Copy
Expand all Collapse all {- "advertiseRoutePrefix": {
- "prefix": "192.168.1.0/24",
- "description": "prefix_1_description",
- "cellIds": [
- "12345678-1234-1234-1234-1234567890a1",
- "12345678-1234-1234-1234-1234567890a2"
], - "cellGroupId": "5be775de-aa0b-468c-ba69-6e35dc5c5c32"
}
}Response samples
- 200
- 400
- 401
- 500
Content type
application/json
Copy
Expand all Collapse all {- "advertiseRoutePrefix": {
- "id": "12345678-1234-1234-1234-1234567890a1",
- "prefix": "192.168.1.0/24",
- "description": "prefix_1_description",
- "cellIds": [
- "12345678-1234-1234-1234-1234567890a1",
- "12345678-1234-1234-1234-1234567890a2"
], - "cellGroupId": "047ae2a5-c763-4bea-9171-e178d08951ca",
- "operationId": "f7e966a2-9460-4907-9710-776e95cd0724",
- "tenantId": "12345678abcdabcdabcd1234567890ab",
- "updatedAt": "2026-02-01T06:00:00Z",
- "createdAt": "2026-02-01T00:00:00Z"
}
}Get Advertise-Route-Prefix Details
Get an Advertise route prefix resource.
Authorizations:
path Parameters
| advertise_route_prefix_id required | string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$ The ID of the Advertise route prefix resource. |
header Parameters
| X-Auth-Token required | string The keystone token. |
Responses
200
OK
400
Bad Request
401
Unauthorized
404
Not Found
500
Internal Server Error
get/v1/advertise-route-prefixes/{advertise_route_prefix_id}
https://api.ntt.com/dsigw-erg/v1/advertise-route-prefixes/{advertise_route_prefix_id}
Response samples
- 200
- 400
- 401
- 404
- 500
Content type
application/json
Copy
Expand all Collapse all {- "advertiseRoutePrefix": {
- "id": "12345678-1234-1234-1234-1234567890a1",
- "prefix": "192.168.1.0/24",
- "description": "prefix_1_description",
- "cellIds": [
- "12345678-1234-1234-1234-1234567890a1",
- "12345678-1234-1234-1234-1234567890a2"
], - "cellGroupId": "047ae2a5-c763-4bea-9171-e178d08951ca",
- "operationId": "f7e966a2-9460-4907-9710-776e95cd0725",
- "tenantId": "12345678abcdabcdabcd1234567890ab",
- "updatedAt": "2026-02-01T06:00:00Z",
- "createdAt": "2026-02-01T00:00:00Z"
}
}Update Advertise-Route-Prefix
Update an Advertise route prefix resource.
Authorizations:
path Parameters
| advertise_route_prefix_id required | string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$ The ID of the Advertise route prefix resource. |
header Parameters
| X-Auth-Token required | string The keystone token. |
Request Body schema: application/json
| advertiseRoutePrefix required | object (AdvertiseRoutePrefixUpdateRequest) Advertise route prefix update request schema. |
Responses
200
OK
400
Bad Request
401
Unauthorized
404
Not Found
500
Internal Server Error
patch/v1/advertise-route-prefixes/{advertise_route_prefix_id}
https://api.ntt.com/dsigw-erg/v1/advertise-route-prefixes/{advertise_route_prefix_id}
Request samples
- Payload
Content type
application/json
Copy
Expand all Collapse all {- "advertiseRoutePrefix": {
- "prefix": "192.168.1.0/24",
- "description": "prefix_1_description",
- "cellIds": [
- "12345678-1234-1234-1234-1234567890a1",
- "12345678-1234-1234-1234-1234567890a2"
]
}
}Response samples
- 200
- 400
- 401
- 404
- 500
Content type
application/json
Copy
Expand all Collapse all {- "advertiseRoutePrefix": {
- "id": "12345678-1234-1234-1234-1234567890a1",
- "prefix": "192.168.1.0/24",
- "description": "prefix_1_description",
- "cellIds": [
- "12345678-1234-1234-1234-1234567890a1",
- "12345678-1234-1234-1234-1234567890a3"
], - "cellGroupId": "047ae2a5-c763-4bea-9171-e178d08951ca",
- "operationId": "f7e966a2-9460-4907-9710-776e95cd0724",
- "tenantId": "12345678abcdabcdabcd1234567890ab",
- "updatedAt": "2026-02-01T06:00:00Z",
- "createdAt": "2026-02-01T00:00:00Z"
}
}Delete Advertise-Route-Prefix
Delete an Advertise route prefix resource.
Authorizations:
path Parameters
| advertise_route_prefix_id required | string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$ The ID of the Advertise route prefix resource. |
header Parameters
| X-Auth-Token required | string The keystone token. |
Responses
200
OK
400
Bad Request
401
Unauthorized
404
Not Found
500
Internal Server Error
delete/v1/advertise-route-prefixes/{advertise_route_prefix_id}
https://api.ntt.com/dsigw-erg/v1/advertise-route-prefixes/{advertise_route_prefix_id}
Response samples
- 400
- 401
- 404
- 500
Content type
application/json
Copy
Expand all Collapse all {- "errorCode": 400,
- "errorMessage": "Invalid request",
- "moreInfo": "{{moreInfo}}"
}