Captive-Portal-Policy - Distributed Secure Internet GateWay API References (1.5.0)

Download OpenAPI specification:Download

Captive-Portal-Policy resource.

Authentication

X-Auth-Token

Security Scheme Type	API Key
Header parameter name:	{keystone_token}

captive-portal-policy

Get Captive-Portal-Policies

Get Captive-Portal-Policy resources.

Authorizations:

X-Auth-Token

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.
action	string Enum: "none" "captive-portal" The action of the policy.

header Parameters

X-Auth-Token

required

string

The keystone token.

Responses

200

400

Bad Request

401

Unauthorized

500

Internal Server Error

get/v1/captive-portal-policies

https://api.ntt.com/dsigw-erg/v1/captive-portal-policies

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"captivePortalPolicies": 
[
{"id": "2944a32f-3fb7-430e-9134-5eb611be23f6",
"name": "test",
"cellGroupId": "047ae2a5-c763-4bea-9171-e178d08951ca",
"sourceAddresses": 
["any"
],
"destinationAddresses": 
["any"
],
"tcpPorts": 
["any"
],
"customUrlCategoryIds": 
["d7e30854-c38e-4836-b17a-0e95d3d80997"
],
"urlCategoryNames": 
["shopping"
],
"action": "none",
"tenantId": "12345678abcdabcdabcd1234567890ab",
"createdAt": "2020-08-27T10:04:04Z",
"updatedAt": "2020-08-27T10:04:04Z"
}
]
}

Create Captive-Portal-Policy

Create a Captive-Portal-Policy resource.

Authorizations:

X-Auth-Token

header Parameters

X-Auth-Token

string

The keystone token.

Request Body schema: application/json

captivePortalPolicy

required

object (CaptivePortalPolicyCreateRequest)

Either customUrlCategoryIds or urlCategoryNames is required.

Responses

200

400

Bad Request

401

Unauthorized

500

Internal Server Error

post/v1/captive-portal-policies

https://api.ntt.com/dsigw-erg/v1/captive-portal-policies

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"captivePortalPolicy": 
{"name": "test",
"cellGroupId": "047ae2a5-c763-4bea-9171-e178d08951ca",
"sourceAddresses": 
["any"
],
"destinationAddresses": 
["any"
],
"tcpPorts": 
["any"
],
"customUrlCategoryIds": 
["d7e30854-c38e-4836-b17a-0e95d3d80997"
],
"urlCategoryNames": 
["shopping"
],
"action": "none"
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"captivePortalPolicy": 
{"id": "2944a32f-3fb7-430e-9134-5eb611be23f6",
"name": "test",
"cellGroupId": "047ae2a5-c763-4bea-9171-e178d08951ca",
"sourceAddresses": 
["any"
],
"destinationAddresses": 
["any"
],
"tcpPorts": 
["any"
],
"customUrlCategoryIds": 
["d7e30854-c38e-4836-b17a-0e95d3d80997"
],
"urlCategoryNames": 
["shopping"
],
"action": "none",
"tenantId": "12345678abcdabcdabcd1234567890ab",
"operationId": "f2393b68-12b0-4ad6-8c3c-012f0a4136d7",
"createdAt": "2020-08-27T10:04:04Z",
"updatedAt": "2020-08-27T10:04:04Z"
}
}

Get Captive-Portal-Policy Details

Get a Captive-Portal-Policy resource.

Authorizations:

X-Auth-Token

path Parameters

captive_portal_policy_id

required

string

header Parameters

X-Auth-Token

string

The keystone token.

Responses

200

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

get/v1/captive-portal-policies/{captive_portal_policy_id}

https://api.ntt.com/dsigw-erg/v1/captive-portal-policies/{captive_portal_policy_id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"captivePortalPolicy": 
{"id": "2944a32f-3fb7-430e-9134-5eb611be23f6",
"name": "test",
"cellGroupId": "047ae2a5-c763-4bea-9171-e178d08951ca",
"sourceAddresses": 
["any"
],
"destinationAddresses": 
["any"
],
"tcpPorts": 
["80",
"443",
"8080-8088"
],
"customUrlCategoryIds": 
["d7e30854-c38e-4836-b17a-0e95d3d80997"
],
"urlCategoryNames": 
["shopping"
],
"action": "none",
"tenantId": "12345678abcdabcdabcd1234567890ab",
"createdAt": "2020-08-27T10:04:04Z",
"updatedAt": "2020-08-27T10:04:04Z"
}
}

Update Captive-Portal-Policy

Update a Captive-Portal-Policy resource.

Authorizations:

X-Auth-Token

path Parameters

captive_portal_policy_id

required

string

header Parameters

X-Auth-Token

string

Request Body schema: application/json

captivePortalPolicy

required

object (CaptivePortalPolicyUpdateRequest)

Responses

200

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

patch/v1/captive-portal-policies/{captive_portal_policy_id}

https://api.ntt.com/dsigw-erg/v1/captive-portal-policies/{captive_portal_policy_id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"captivePortalPolicy": 
{"name": "test_updated"
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"captivePortalPolicy": 
{"id": "2944a32f-3fb7-430e-9134-5eb611be23f6",
"name": "test_updated",
"cellGroupId": "047ae2a5-c763-4bea-9171-e178d08951ca",
"sourceAddresses": 
["any"
],
"destinationAddresses": 
["any"
],
"tcpPorts": 
["any"
],
"customUrlCategoryIds": 
["d7e30854-c38e-4836-b17a-0e95d3d80997"
],
"urlCategoryNames": 
["shopping"
],
"action": "none",
"tenantId": "12345678abcdabcdabcd1234567890ab",
"operationId": "f7e966a2-9460-4907-9710-776e95cd0724",
"createdAt": "2020-08-27T10:04:04Z",
"updatedAt": "2020-08-27T10:32:35Z"
}
}

Delete Captive-Portal-Policy

Delete a Captive-Portal-Policy resource.

Authorizations:

X-Auth-Token

path Parameters

captive_portal_policy_id

required

string

header Parameters

X-Auth-Token

string

Responses

200

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

delete/v1/captive-portal-policies/{captive_portal_policy_id}

https://api.ntt.com/dsigw-erg/v1/captive-portal-policies/{captive_portal_policy_id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"errorCode": 400,
"errorMessage": "Invalid request",
"moreInfo": "{{moreInfo}}"
}