Captive-Portal-Exclusion - Flexible Secure Gateway API References (1.5.0)
Download OpenAPI specification:Download
Captive-Portal-Exclusion resource.
Get Captive-Portal-Exclusions
Get Captive-Portal-Exclusion 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. |
header Parameters
| X-Auth-Token required | 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/captive-portal-exclusions
https://api.ntt.com/dsigw-erg/v1/captive-portal-exclusions
Response samples
- 200
- 400
- 401
- 500
Content type
application/json
Copy
Expand all Collapse all {- "captivePortalExclusions": [
- {
- "id": "2944a32f-3fb7-430e-9134-5eb611be23f6",
- "name": "test",
- "cellGroupId": "047ae2a5-c763-4bea-9171-e178d08951ca",
- "srcAddrs": [
- "any"
], - "dstAddrs": [
- "any"
], - "customUrlCategoryIds": [
- "d7e30854-c38e-4836-b17a-0e95d3d80997"
], - "urlCategoryNames": [
- "shopping"
], - "tenantId": "12345678abcdabcdabcd1234567890ab",
- "createdAt": "2020-08-27T10:04:04Z",
- "updatedAt": "2020-08-27T10:04:04Z"
}
]
}Create Captive-Portal-Exclusion
Create a Captive-Portal-Exclusion 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
| captivePortalExclusion required | object (CaptivePortalExclusionCreateRequest) Either customUrlCategoryIds or urlCategoryNames is required. |
Responses
200
OK
400
Bad Request
401
Unauthorized
500
Internal Server Error
post/v1/captive-portal-exclusions
https://api.ntt.com/dsigw-erg/v1/captive-portal-exclusions
Request samples
- Payload
Content type
application/json
Copy
Expand all Collapse all {- "captivePortalExclusion": {
- "name": "test",
- "cellGroupId": "047ae2a5-c763-4bea-9171-e178d08951ca",
- "srcAddrs": [
- "any"
], - "dstAddrs": [
- "any"
], - "customUrlCategoryIds": [
- "d7e30854-c38e-4836-b17a-0e95d3d80997"
], - "urlCategoryNames": [
- "shopping"
]
}
}Response samples
- 200
- 400
- 401
- 500
Content type
application/json
Copy
Expand all Collapse all {- "captivePortalExclusion": {
- "id": "2944a32f-3fb7-430e-9134-5eb611be23f6",
- "name": "test",
- "cellGroupId": "047ae2a5-c763-4bea-9171-e178d08951ca",
- "srcAddrs": [
- "any"
], - "dstAddrs": [
- "any"
], - "customUrlCategoryIds": [
- "d7e30854-c38e-4836-b17a-0e95d3d80997"
], - "urlCategoryNames": [
- "shopping"
], - "tenantId": "12345678abcdabcdabcd1234567890ab",
- "operationId": "f2393b68-12b0-4ad6-8c3c-012f0a4136d7",
- "createdAt": "2020-08-27T10:04:04Z",
- "updatedAt": "2020-08-27T10:04:04Z"
}
}Get Captive-Portal-Exclusion Details
Get a Captive-Portal-Exclusion resource.
Authorizations:
path Parameters
| captive_portal_exclusion_id required | string |
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
404
Not Found
500
Internal Server Error
get/v1/captive-portal-exclusions/{captive_portal_exclusion_id}
https://api.ntt.com/dsigw-erg/v1/captive-portal-exclusions/{captive_portal_exclusion_id}
Response samples
- 200
- 400
- 401
- 404
- 500
Content type
application/json
Copy
Expand all Collapse all {- "captivePortalExclusion": {
- "id": "2944a32f-3fb7-430e-9134-5eb611be23f6",
- "name": "test",
- "cellGroupId": "047ae2a5-c763-4bea-9171-e178d08951ca",
- "srcAddrs": [
- "any"
], - "dstAddrs": [
- "any"
], - "customUrlCategoryIds": [
- "d7e30854-c38e-4836-b17a-0e95d3d80997"
], - "urlCategoryNames": [
- "shopping"
], - "tenantId": "12345678abcdabcdabcd1234567890ab",
- "createdAt": "2020-08-27T10:04:04Z",
- "updatedAt": "2020-08-27T10:04:04Z"
}
}Update Captive-Portal-Exclusion
Update a Captive-Portal-Exclusion resource.
Authorizations:
path Parameters
| captive_portal_exclusion_id required | string |
header Parameters
| X-Auth-Token | string |
Request Body schema: application/json
| captivePortalExclusion required | object (CaptivePortalExclusionUpdateRequest) |
Responses
200
OK
400
Bad Request
401
Unauthorized
404
Not Found
500
Internal Server Error
patch/v1/captive-portal-exclusions/{captive_portal_exclusion_id}
https://api.ntt.com/dsigw-erg/v1/captive-portal-exclusions/{captive_portal_exclusion_id}
Request samples
- Payload
Content type
application/json
Copy
Expand all Collapse all {- "captivePortalExclusion": {
- "name": "test_updated"
}
}Response samples
- 200
- 400
- 401
- 404
- 500
Content type
application/json
Copy
Expand all Collapse all {- "captivePortalExclusion": {
- "id": "2944a32f-3fb7-430e-9134-5eb611be23f6",
- "name": "test_updated",
- "cellGroupId": "047ae2a5-c763-4bea-9171-e178d08951ca",
- "srcAddrs": [
- "any"
], - "dstAddrs": [
- "any"
], - "customUrlCategoryIds": [
- "d7e30854-c38e-4836-b17a-0e95d3d80997"
], - "urlCategoryNames": [
- "shopping"
], - "tenantId": "12345678abcdabcdabcd1234567890ab",
- "operationId": "f7e966a2-9460-4907-9710-776e95cd0724",
- "createdAt": "2020-08-27T10:04:04Z",
- "updatedAt": "2020-08-27T10:32:35Z"
}
}Delete Captive-Portal-Exclusion
Delete a Captive-Portal-Exclusion resource.
Authorizations:
path Parameters
| captive_portal_exclusion_id required | string |
header Parameters
| X-Auth-Token | string |
Responses
200
OK
400
Bad Request
401
Unauthorized
404
Not Found
500
Internal Server Error
delete/v1/captive-portal-exclusions/{captive_portal_exclusion_id}
https://api.ntt.com/dsigw-erg/v1/captive-portal-exclusions/{captive_portal_exclusion_id}
Response samples
- 400
- 401
- 404
- 500
Content type
application/json
Copy
Expand all Collapse all {- "errorCode": 400,
- "errorMessage": "Invalid request",
- "moreInfo": "{{moreInfo}}"
}