Address-group - Flexible Secure Gateway API References (1.12.0)
Download OpenAPI specification:Download
Address-group is the object for the address based filtering rule. Address-group will be specified by the Security-Policy object, decryption-exclustion setting, Captive-portal-policy object and Address-group.
Get address groups
Get Address 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-Z]{1}[a-zA-Z0-9-\_\.]{0,30}$ A name 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" "name" "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/address-groups
https://api.ntt.com/dsigw-erg/v1/address-groups
Response samples
- 200
- 400
- 401
- 500
Content type
application/json
Copy
Expand all Collapse all {- "addressGroups": [
- {
- "id": "12345678-1234-1234-1234-1234567890a1",
- "name": "address_group_1",
- "ipNetmasks": [
- "192.168.1.0/24",
- "172.16.2.0/16"
], - "ipRanges": [
- "10.0.1.0-10.0.1.5"
], - "fqdns": [
- "www.example.com",
- "mail.google.com"
], - "includeAddressGroupIds": [
- "f027cbbc-fc0b-4b92-b76f-fa6cf8413a8e"
], - "cellGroupId": "047ae2a5-c763-4bea-9171-e178d08951ca",
- "tenantId": "12345678abcdabcdabcd1234567890ab",
- "updatedAt": "2021-09-01T06:00:00Z",
- "createdAt": "2021-09-01T00:00:00Z"
}
]
}Create Address group
Create an Address group resource.
Authorizations:
header Parameters
| X-Auth-Token required | string The keystone token. |
Request Body schema: application/json
| addressGroup required | object or object or object or object (AddressGroupCreateRequest) Address group create request schema. |
Responses
200
OK
400
Bad Request
401
Unauthorized
500
Internal Server Error
post/v1/address-groups
https://api.ntt.com/dsigw-erg/v1/address-groups
Request samples
- Payload
Content type
application/json
Copy
Expand all Collapse all {- "addressGroup": {
- "name": "address_group_1",
- "ipNetmasks": [
- "192.168.1.0/24",
- "172.16.2.0/16"
], - "ipRanges": [
- "10.0.1.0-10.0.1.5"
], - "fqdns": [
- "www.example.com",
- "mail.google.com"
], - "includeAddressGroupIds": [
- "f027cbbc-fc0b-4b92-b76f-fa6cf8413a8e"
], - "cellGroupId": "5be775de-aa0b-468c-ba69-6e35dc5c5c32"
}
}Response samples
- 200
- 400
- 401
- 500
Content type
application/json
Copy
Expand all Collapse all {- "addressGroup": {
- "id": "12345678-1234-1234-1234-1234567890a1",
- "name": "address_group_1",
- "ipNetmasks": [
- "192.168.1.0/24",
- "172.16.2.0/16"
], - "ipRanges": [
- "10.0.1.0-10.0.1.5"
], - "fqdns": [
- "www.example.com",
- "mail.google.com"
], - "includeAddressGroupIds": [
- "f027cbbc-fc0b-4b92-b76f-fa6cf8413a8e"
], - "cellGroupId": "047ae2a5-c763-4bea-9171-e178d08951ca",
- "operationId": "f7e966a2-9460-4907-9710-776e95cd0724",
- "tenantId": "12345678abcdabcdabcd1234567890ab",
- "updatedAt": "2021-09-01T06:00:00Z",
- "createdAt": "2021-09-01T00:00:00Z"
}
}Get Address group Details
Get a Address group resource.
Authorizations:
path Parameters
| address_group_id required | string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$ The ID of the Address group 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/address-groups/{address_group_id}
https://api.ntt.com/dsigw-erg/v1/address-groups/{address_group_id}
Response samples
- 200
- 400
- 401
- 404
- 500
Content type
application/json
Copy
Expand all Collapse all {- "addressGroup": {
- "id": "12345678-1234-1234-1234-1234567890a1",
- "name": "address_group_1",
- "ipNetmasks": [
- "192.168.1.0/24",
- "172.16.2.0/16"
], - "ipRanges": [
- "10.0.1.0-10.0.1.5"
], - "fqdns": [
- "www.example.com",
- "mail.google.com"
], - "includeAddressGroupIds": [
- "f027cbbc-fc0b-4b92-b76f-fa6cf8413a8e"
], - "cellGroupId": "047ae2a5-c763-4bea-9171-e178d08951ca",
- "tenantId": "12345678abcdabcdabcd1234567890ab",
- "updatedAt": "2021-09-01T06:00:00Z",
- "createdAt": "2021-09-01T00:00:00Z"
}
}Update Address group
Update Address group resource.
Authorizations:
path Parameters
| address_group_id required | string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$ The ID of the Address group resource. |
header Parameters
| X-Auth-Token required | string The keystone token. |
Request Body schema: application/json
| addressGroup required | object (AddressGroupUpdateRequest) Address group update request schema. |
Responses
200
OK
400
Bad Request
401
Unauthorized
404
Not Found
500
Internal Server Error
patch/v1/address-groups/{address_group_id}
https://api.ntt.com/dsigw-erg/v1/address-groups/{address_group_id}
Request samples
- Payload
Content type
application/json
Copy
Expand all Collapse all {- "addressGroup": {
- "name": "address_group_1",
- "ipNetmasks": [
- "192.168.1.0/24",
- "172.16.2.0/16"
], - "ipRanges": [
- "10.0.1.0-10.0.1.5"
], - "fqdns": [
- "www.example.com",
- "mail.google.com",
- "ftp.website.org"
], - "includeAddressGroupIds": [
- "f027cbbc-fc0b-4b92-b76f-fa6cf8413a8e"
]
}
}Response samples
- 200
- 400
- 401
- 404
- 500
Content type
application/json
Copy
Expand all Collapse all {- "addressGroup": {
- "id": "12345678-1234-1234-1234-1234567890a1",
- "name": "address_group_1",
- "ipNetmasks": [
- "192.168.1.0/24",
- "172.16.2.0/16"
], - "ipRanges": [
- "10.0.1.0-10.0.1.5"
], - "fqdns": [
- "www.example.com",
- "mail.google.com",
- "ftp.website.org"
], - "includeAddressGroupIds": [
- "f027cbbc-fc0b-4b92-b76f-fa6cf8413a8e"
], - "cellGroupId": "047ae2a5-c763-4bea-9171-e178d08951ca",
- "operationId": "f7e966a2-9460-4907-9710-776e95cd0724",
- "tenantId": "12345678abcdabcdabcd1234567890ab",
- "updatedAt": "2021-09-01T06:00:00Z",
- "createdAt": "2021-09-01T00:00:00Z"
}
}Delete Address group
Delete an Address group resource.
Authorizations:
path Parameters
| address_group_id required | string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$ The ID of the Address group 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/address-groups/{address_group_id}
https://api.ntt.com/dsigw-erg/v1/address-groups/{address_group_id}
Response samples
- 400
- 401
- 404
- 500
Content type
application/json
Copy
Expand all Collapse all {- "errorCode": 400,
- "errorMessage": "Invalid request",
- "moreInfo": "{{moreInfo}}"
}