Security-Policy - Flexible Secure Gateway API References (1.5.0)
Download OpenAPI specification:Download
Security-policies describes that the Security-Policy of the Cell-Groups.
Get Security Policies
Get Security-Policy 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. |
name | string ^[a-zA-Z]{1}[a-zA-Z0-9-\_\.]{0,30}$ A name of the resource. |
header Parameters
X-Auth-Token | string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$ The keystone token. |
Responses
200
OK
400
Bad Request
401
Unauthorized
500
Internal Server Error
get/v1/security-policies
https://api.ntt.com/dsigw-erg/v1/security-policies
Response samples
- 200
- 400
- 401
- 500
Content type
application/json
Copy
Expand all Collapse all {- "securityPolicies": [
- {
- "id": "7d4ca0e4-15bd-4e38-bab6-1913e4a8e239",
- "name": "test_poliy",
- "srcAddrs": [
- "192.168.0.0/24",
- "192.168.1.0/24"
], - "dstAddrs": [
- "any"
], - "dstPorts": [
- "80",
- "443"
], - "applications": [
- "any"
], - "action": "deny",
- "antiVirus": "block_recommended",
- "vulnerabilityProtection": "ips_medium_recommended",
- "antiSpyware": "medium_recommended",
- "urlFilteringProfile": "test_filter",
- "fileBlocking": "log_only_recommended",
- "wildfireDirection": "both_direction_recommended",
- "suppressLogs": true,
- "securityGroups": [
- "CN=group1,DC=ad-test1,DC=example,DC=com"
], - "customUrlCategoryIds": [
- "d7e30854-c38e-4836-b17a-0e95d3d80997"
], - "urlCategoryNames": [
- "shopping"
], - "cellGroupId": "5be775de-aa0b-468c-ba69-6e35dc5c5c32",
- "tenantId": "12345678abcdabcdabcd1234567890ab",
- "createdAt": "2020-06-23T06:03:25Z",
- "updatedAt": "2020-06-23T06:03:25Z"
}
]
}
Create Security Policy
Create a Security-Policy resource.
Authorizations:
header Parameters
X-Auth-Token | string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$ The keystone token. |
Request Body schema: application/json
securityPolicy required | object (SecurityPolicyCreateRequest) |
Responses
200
OK
400
Bad Request
401
Unauthorized
500
Internal Server Error
post/v1/security-policies
https://api.ntt.com/dsigw-erg/v1/security-policies
Request samples
- Payload
Content type
application/json
Copy
Expand all Collapse all {- "securityPolicy": {
- "name": "test_poliy",
- "srcAddrs": [
- "192.168.0.0/24",
- "192.168.1.0/24"
], - "dstAddrs": [
- "any"
], - "dstPorts": [
- "80",
- "443"
], - "applications": [
- "any"
], - "action": "deny",
- "antiVirus": "block_recommended",
- "vulnerabilityProtection": "ips_medium_recommended",
- "antiSpyware": "medium_recommended",
- "urlFilteringProfile": "test_filter",
- "fileBlocking": "log_only_recommended",
- "wildfireDirection": "both_direction_recommended",
- "suppressLogs": true,
- "securityGroups": [
- "CN=group1,DC=ad-test1,DC=example,DC=com"
], - "customUrlCategoryIds": [
- "d7e30854-c38e-4836-b17a-0e95d3d80997"
], - "urlCategoryNames": [
- "shopping"
], - "cellGroupId": "5be775de-aa0b-468c-ba69-6e35dc5c5c32"
}
}
Response samples
- 200
- 400
- 401
- 500
Content type
application/json
Copy
Expand all Collapse all {- "securityPolicy": {
- "id": "7d4ca0e4-15bd-4e38-bab6-1913e4a8e239",
- "name": "test_poliy",
- "srcAddrs": [
- "192.168.0.0/24",
- "192.168.1.0/24"
], - "dstAddrs": [
- "any"
], - "dstPorts": [
- "80",
- "443"
], - "applications": [
- "any"
], - "action": "deny",
- "antiVirus": "block_recommended",
- "vulnerabilityProtection": "ips_medium_recommended",
- "antiSpyware": "medium_recommended",
- "urlFilteringProfile": "test_filter",
- "fileBlocking": "log_only_recommended",
- "wildfireDirection": "both_direction_recommended",
- "suppressLogs": true,
- "securityGroups": [
- "CN=group1,DC=ad-test1,DC=example,DC=com"
], - "customUrlCategoryIds": [
- "d7e30854-c38e-4836-b17a-0e95d3d80997"
], - "urlCategoryNames": [
- "shopping"
], - "cellGroupId": "5be775de-aa0b-468c-ba69-6e35dc5c5c32",
- "operationId": "f38fdf0a-021a-42ba-a664-0ccf1e734671",
- "tenantId": "12345678abcdabcdabcd1234567890ab",
- "createdAt": "2020-06-23T06:03:25Z",
- "updatedAt": "2020-06-23T06:03:25Z"
}
}
Get Security Policy
Get a Security-Policy resource.
Authorizations:
path Parameters
security_policy_id required | string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$ |
header Parameters
X-Auth-Token | string ^[a-fA-F0-9]{32}$ The keystone token. |
Responses
200
OK
400
Bad Request
401
Unauthorized
404
Not Found
500
Internal Server Error
get/v1/security-policies/{security_policy_id}
https://api.ntt.com/dsigw-erg/v1/security-policies/{security_policy_id}
Response samples
- 200
- 400
- 401
- 404
- 500
Content type
application/json
Copy
Expand all Collapse all {- "securityPolicy": {
- "id": "7d4ca0e4-15bd-4e38-bab6-1913e4a8e239",
- "name": "test_poliy",
- "srcAddrs": [
- "192.168.0.0/24",
- "192.168.1.0/24"
], - "dstAddrs": [
- "any"
], - "dstPorts": [
- "80",
- "443"
], - "applications": [
- "any"
], - "action": "deny",
- "antiVirus": "block_recommended",
- "vulnerabilityProtection": "ips_medium_recommended",
- "antiSpyware": "medium_recommended",
- "urlFilteringProfile": "test_filter",
- "fileBlocking": "log_only_recommended",
- "wildfireDirection": "both_direction_recommended",
- "suppressLogs": true,
- "securityGroups": [
- "CN=group1,DC=ad-test1,DC=example,DC=com"
], - "customUrlCategoryIds": [
- "d7e30854-c38e-4836-b17a-0e95d3d80997"
], - "urlCategoryNames": [
- "shopping"
], - "cellGroupId": "5be775de-aa0b-468c-ba69-6e35dc5c5c32",
- "tenantId": "12345678abcdabcdabcd1234567890ab",
- "createdAt": "2020-06-23T06:03:25Z",
- "updatedAt": "2020-06-23T06:03:25Z"
}
}
Update Security Policy
Update a Security-Policy resource.
Authorizations:
path Parameters
security_policy_id required | string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$ |
header Parameters
X-Auth-Token | string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$ The keystone token. |
Request Body schema: application/json
application/json
securityPolicy required | object (SecurityPolicyUpdateRequest) |
Responses
200
OK
400
Bad Request
401
Unauthorized
404
Not Found
500
Internal Server Error
patch/v1/security-policies/{security_policy_id}
https://api.ntt.com/dsigw-erg/v1/security-policies/{security_policy_id}
Request samples
- Payload
Content type
application/json
Copy
Expand all Collapse all {- "securityPolicy": {
- "name": "test_poliy_updated"
}
}
Response samples
- 200
- 400
- 401
- 404
- 500
Content type
application/json
Copy
Expand all Collapse all {- "securityPolicy": {
- "id": "7d4ca0e4-15bd-4e38-bab6-1913e4a8e239",
- "name": "test_poliy_updated",
- "srcAddrs": [
- "192.168.0.0/24",
- "192.168.1.0/24"
], - "dstAddrs": [
- "any"
], - "dstPorts": [
- "80",
- "443"
], - "applications": [
- "any"
], - "action": "deny",
- "antiVirus": "block_recommended",
- "vulnerabilityProtection": "ips_medium_recommended",
- "antiSpyware": "medium_recommended",
- "urlFilteringProfile": "test_filter",
- "fileBlocking": "log_only_recommended",
- "wildfireDirection": "both_direction_recommended",
- "suppressLogs": true,
- "securityGroups": [
- "CN=group1,DC=ad-test1,DC=example,DC=com"
], - "customUrlCategoryIds": [
- "d7e30854-c38e-4836-b17a-0e95d3d80997"
], - "urlCategoryNames": [
- "shopping"
], - "cellGroupId": "5be775de-aa0b-468c-ba69-6e35dc5c5c32",
- "operationId": "2d6a1383-f693-4571-b770-07a0295d4d8b",
- "tenantId": "12345678abcdabcdabcd1234567890ab",
- "createdAt": "2020-06-23T06:03:25Z",
- "updatedAt": "2020-06-23T06:26:37Z"
}
}
Delete Security Policy
Delete a Security-Policy resource.
Authorizations:
path Parameters
security_policy_id required | string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$ |
header Parameters
X-Auth-Token | string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$ The keystone token. |
Responses
202
Accepted
401
Unauthorized
404
Not Found
500
Internal Server Error
delete/v1/security-policies/{security_policy_id}
https://api.ntt.com/dsigw-erg/v1/security-policies/{security_policy_id}
Response samples
- 401
- 404
- 500
Content type
application/json
Copy
Expand all Collapse all {- "errorCode": 401,
- "errorMessage": "Invalid token. abcdef1234567890abcdef1234567890",
- "moreInfo": null
}