Custom-Url-Category - Flexible Secure Gateway API References (1.10.0)

Download OpenAPI specification:Download

Custom Url Categories.

Authentication

X-Auth-Token

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

custom-url-category

Get CustomUrlCategories

Get Custom-Url-Category 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.
_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" "predefined" "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/custom-url-categories

https://api.ntt.com/dsigw-erg/v1/custom-url-categories

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"customUrlCategories": 
[
{"id": "2944a32f-3fb7-430e-9134-5eb611be23f6",
"name": "test",
"cellGroupId": "047ae2a5-c763-4bea-9171-e178d08951ca",
"urls": 
["fuga.com"
],
"tenantId": "12345678abcdabcdabcd1234567890ab",
"createdAt": "2020-08-27T10:04:04Z",
"updatedAt": "2020-08-27T10:04:04Z",
"predefined": false
}
]
}

Create Custom-Url-Category

Create a Custom-Url-Category resource.

Authorizations:

X-Auth-Token

header Parameters

X-Auth-Token

string

The keystone token.

Request Body schema: application/json

customUrlCategory

required

object (CustomUrlCategoryCreateRequest)

Custom-Url-Category create request schema.

Responses

200

400

Bad Request

401

Unauthorized

500

Internal Server Error

post/v1/custom-url-categories

https://api.ntt.com/dsigw-erg/v1/custom-url-categories

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"customUrlCategory": 
{"name": "test",
"cellGroupId": "047ae2a5-c763-4bea-9171-e178d08951ca",
"urls": 
["fuga.com"
]
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"customUrlCategory": 
{"id": "2944a32f-3fb7-430e-9134-5eb611be23f6",
"name": "test",
"cellGroupId": "047ae2a5-c763-4bea-9171-e178d08951ca",
"urls": 
["fuga.com"
],
"tenantId": "12345678abcdabcdabcd1234567890ab",
"operationId": "f2393b68-12b0-4ad6-8c3c-012f0a4136d7",
"createdAt": "2020-08-27T10:04:04Z",
"updatedAt": "2020-08-27T10:04:04Z",
"predefined": false
}
}

Get Custom-Url-Category Details

Get a Custom-Url-Category resource.

Authorizations:

X-Auth-Token

path Parameters

custom_url_category_id

required

string

The ID of the Custom-Url-Category.

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/custom-url-categories/{custom_url_category_id}

https://api.ntt.com/dsigw-erg/v1/custom-url-categories/{custom_url_category_id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"customUrlCategory": 
{"id": "2944a32f-3fb7-430e-9134-5eb611be23f6",
"name": "test",
"cellGroupId": "047ae2a5-c763-4bea-9171-e178d08951ca",
"urls": 
["fuga.com"
],
"tenantId": "12345678abcdabcdabcd1234567890ab",
"createdAt": "2020-08-27T10:04:04Z",
"updatedAt": "2020-08-27T10:04:04Z",
"predefined": false
}
}

Update Custom-Url-Category

Update a Custom-Url-Category resource.

Authorizations:

X-Auth-Token

path Parameters

custom_url_category_id

required

string

The ID of the Custom-Url-Category.

header Parameters

X-Auth-Token

string

The keystone token.

Request Body schema: application/json

customUrlCategory

required

object (CustomUrlCategoryUpdateRequest)

Custom-Url-Category update request schema.

Responses

200

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

patch/v1/custom-url-categories/{custom_url_category_id}

https://api.ntt.com/dsigw-erg/v1/custom-url-categories/{custom_url_category_id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"customUrlCategory": 
{"name": "test_updated"
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"customUrlCategory": 
{"id": "2944a32f-3fb7-430e-9134-5eb611be23f6",
"name": "test_updated",
"cellGroupId": "047ae2a5-c763-4bea-9171-e178d08951ca",
"urls": 
["fuga.com"
],
"tenantId": "12345678abcdabcdabcd1234567890ab",
"operationId": "f7e966a2-9460-4907-9710-776e95cd0724",
"createdAt": "2020-08-27T10:04:04Z",
"updatedAt": "2020-08-27T10:32:35Z",
"predefined": false
}
}

Delete Custom-Url-Category

Delete a Custom-Url-Category resource.

Authorizations:

X-Auth-Token

path Parameters

custom_url_category_id

required

string

The ID of the Custom-Url-Category.

header Parameters

X-Auth-Token

string

The keystone token.

Responses

200

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

delete/v1/custom-url-categories/{custom_url_category_id}

https://api.ntt.com/dsigw-erg/v1/custom-url-categories/{custom_url_category_id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


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