Custom-Url-Category - Distributed Secure Internet GateWay API References (1.5.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:
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

The keystone token.

Responses

200

OK

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":
    [
    ]
}

Create Custom-Url-Category

Create a Custom-Url-Category resource.

Authorizations:
header Parameters
X-Auth-Token
string

The keystone token.

Request Body schema: application/json
customUrlCategory
required
object (CustomUrlCategoryCreateRequest)

Responses

200

OK

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

Content type
application/json
Copy
Expand all Collapse all
{
  • "customUrlCategory":
    {
    }
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "customUrlCategory":
    {
    }
}

Get Custom-Url-Category Details

Get a Custom-Url-Category resource.

Authorizations:
path Parameters
custom_url_category_id
required
string
header Parameters
X-Auth-Token
string

The keystone token.

Responses

200

OK

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":
    {
    }
}

Update Custom-Url-Category

Update a Custom-Url-Category resource.

Authorizations:
path Parameters
custom_url_category_id
required
string
header Parameters
X-Auth-Token
string
Request Body schema: application/json
customUrlCategory
required
object (CustomUrlCategoryUpdateRequest)

Responses

200

OK

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

Content type
application/json
Copy
Expand all Collapse all
{
  • "customUrlCategory":
    {
    }
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "customUrlCategory":
    {
    }
}

Delete Custom-Url-Category

Delete a Custom-Url-Category resource.

Authorizations:
path Parameters
custom_url_category_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/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}}"
}