Url-Filtering-Profile - Flexible Secure Gateway API References (1.10.0)

Download OpenAPI specification:Download

Url-filtering-Profile is the object for the URL-based filtering rule. Url-filtering-Profiles will be specified by the Security-Policy object.

Authentication

X-Auth-Token

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

url-filtering-profile

Get Url-Filtering-Profiles

Get Url-Filtering-Profile 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.
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.
_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

400

Bad Request

401

Unauthorized

500

Internal Server Error

get/v1/url-filtering-profiles

https://api.ntt.com/dsigw-erg/v1/url-filtering-profiles

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"urlFilteringProfiles": 
[
{"id": "db38db63-14d1-41fb-9d18-624dcfde73aa",
"name": "test_filter",
"customUrlCategories": 
[
{"customUrlCategoryId": "d7e30854-c38e-4836-b17a-0e95d3d80997",
"action": "allow"
}
],
"urlCategories": 
[
{"name": "weapons",
"action": "block",
"webIsolation": true
},
{"name": "microsoft365WorldwideAnyUrl",
"action": "allow",
"webIsolation": false
}
],
"cellGroupId": "5be775de-aa0b-468c-ba69-6e35dc5c5c32",
"tenantId": "12345678abcdabcdabcd1234567890ab",
"createdAt": "2020-09-16T11:58:20Z",
"updatedAt": "2020-09-16T11:58:20Z"
}
]
}

Create Url-Filtering-Profile

Create an Url-Filtering-Profile resource.

Authorizations:

X-Auth-Token

header Parameters

X-Auth-Token

required

string

The keystone token.

Request Body schema: application/json

urlFilteringProfile

required

object (UrlFilteringProfileCreateRequest)

Url-Filtering-Profile create request schema. Either customUrlCategories or urlCategories is required.

Responses

200

400

Bad Request

401

Unauthorized

500

Internal Server Error

post/v1/url-filtering-profiles

https://api.ntt.com/dsigw-erg/v1/url-filtering-profiles

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"urlFilteringProfile": 
{"name": "test_filter",
"customUrlCategories": 
[
{"customUrlCategoryId": "d7e30854-c38e-4836-b17a-0e95d3d80997",
"action": "allow"
}
],
"urlCategories": 
[
{"name": "weapons",
"action": "block"
},
{"name": "microsoft365WorldwideAnyUrl",
"action": "allow"
}
],
"cellGroupId": "5be775de-aa0b-468c-ba69-6e35dc5c5c32"
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"urlFilteringProfile": 
{"id": "db38db63-14d1-41fb-9d18-624dcfde73aa",
"name": "test_filter",
"customUrlCategories": 
[
{"customUrlCategoryId": "d7e30854-c38e-4836-b17a-0e95d3d80997",
"action": "allow"
}
],
"urlCategories": 
[
{"name": "weapons",
"action": "block"
},
{"name": "microsoft365WorldwideAnyUrl",
"action": "allow"
}
],
"cellGroupId": "5be775de-aa0b-468c-ba69-6e35dc5c5c32",
"tenantId": "12345678abcdabcdabcd1234567890ab",
"operationId": "f7e966a2-9460-4907-9710-776e95cd0724",
"createdAt": "2020-09-16T11:58:20Z",
"updatedAt": "2020-09-16T11:58:20Z"
}
}

Get Url-Filtering-Profile

Get an Url-Filtering-Profile resource.

Authorizations:

X-Auth-Token

path Parameters

url_filtering_profile_id

required

string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$

The ID of the Url-Filtering-Profile.

header Parameters

X-Auth-Token

required

string

The keystone token.

Responses

200

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

get/v1/url-filtering-profiles/{url_filtering_profile_id}

https://api.ntt.com/dsigw-erg/v1/url-filtering-profiles/{url_filtering_profile_id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"urlFilteringProfile": 
{"id": "db38db63-14d1-41fb-9d18-624dcfde73aa",
"name": "test_filter",
"customUrlCategories": 
[
{"customUrlCategoryId": "d7e30854-c38e-4836-b17a-0e95d3d80997",
"action": "allow"
}
],
"urlCategories": 
[
{"name": "weapons",
"action": "block",
"webIsolation": true
}
],
"cellGroupId": "5be775de-aa0b-468c-ba69-6e35dc5c5c32",
"tenantId": "12345678abcdabcdabcd1234567890ab",
"createdAt": "2020-09-16T11:58:20Z",
"updatedAt": "2020-09-16T11:58:20Z"
}
}

Update Url-Filtering-Profile

Update an Url-Filtering-Profile resource.

Authorizations:

X-Auth-Token

path Parameters

url_filtering_profile_id

required

string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$

The ID of the Url-Filtering-Profile.

header Parameters

X-Auth-Token

required

string

The keystone token.

Request Body schema: application/json

urlFilteringProfile

required

object (UrlFilteringProfileUpdateRequest)

Url-Filtering-Profile update request schema.

Responses

200

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

patch/v1/url-filtering-profiles/{url_filtering_profile_id}

https://api.ntt.com/dsigw-erg/v1/url-filtering-profiles/{url_filtering_profile_id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"urlFilteringProfile": 
{"name": "test_filter_updated"
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"urlFilteringProfile": 
{"id": "db38db63-14d1-41fb-9d18-624dcfde73aa",
"name": "test_filter_updated",
"customUrlCategories": 
[
{"customUrlCategoryId": "d7e30854-c38e-4836-b17a-0e95d3d80997",
"action": "allow"
}
],
"urlCategories": 
[
{"name": "weapons",
"action": "block"
}
],
"cellGroupId": "5be775de-aa0b-468c-ba69-6e35dc5c5c32",
"tenantId": "12345678abcdabcdabcd1234567890ab",
"operationId": "f7e966a2-9460-4907-9710-776e95cd0724",
"createdAt": "2020-09-16T11:58:20Z",
"updatedAt": "2020-09-16T12:04:30Z"
}
}

Delete Url-Filtering-Profile

Delete an Url-Filtering-Profile resource.

Authorizations:

X-Auth-Token

path Parameters

url_filtering_profile_id

required

string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$

The ID of the Url-Filtering-Profile.

header Parameters

X-Auth-Token

required

string

The keystone token.

Responses

200

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

delete/v1/url-filtering-profiles/{url_filtering_profile_id}

https://api.ntt.com/dsigw-erg/v1/url-filtering-profiles/{url_filtering_profile_id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


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