Documentation Powered by ReDoc

External Dynamic Lists - Flexible Secure Gateway API References (1.13.0)

Download OpenAPI specification:Download

URL: https://sdpf.ntt.com/ License: (c) NTT DOCOMO BUSINESS, Inc. All Rights Reserved. Terms of Service

External Dynamic List resource configuration.

Authentication

X-Auth-Token

Security Scheme Type API Key
Header parameter name: X-Auth-Token

edl

Get External Dynamic Lists

Get External Dynamic List resources in the authenticated user's tenant.

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 External Dynamic List resource.

name
string ^[a-zA-Z0-9]{1}[a-zA-Z0-9-\_\.]{0,30}$

The name of the External Dynamic List resource.

type
string
Enum: "ipList" "urlList"

The type of the External Dynamic List resource.

predefined
boolean

Whether the External Dynamic List resource is predefined.

updateScheduleInterval
string
Enum: "5min" "1hour" "1day" "1week" "1month"

The update schedule interval of the External Dynamic List resource.

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

The certificate profile ID used to fetch an HTTPS External Dynamic List.

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" "type" "predefined" "updateScheduleInterval" "certificateProfileId" "cellGroupId" "tenantId" "createdAt" "updatedAt"

Sort keys.

header Parameters
X-Auth-Token
required
string

The keystone token.

Responses

200

OK

400

Bad Request

401

Unauthorized

500

Internal Server Error

get/v1/external-dynamic-lists
https://api.ntt.com/dsigw-erg/v1/external-dynamic-lists

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "externalDynamicLists":
    [
    ]
}

Create External Dynamic List

Create an External Dynamic List resource in the authenticated user's tenant.

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

The keystone token.

Request Body schema: application/json
externalDynamicList
required
object (ExternalDynamicListCreateRequest)

External Dynamic List create request schema.

Responses

200

OK

400

Bad Request

401

Unauthorized

500

Internal Server Error

post/v1/external-dynamic-lists
https://api.ntt.com/dsigw-erg/v1/external-dynamic-lists

Request samples

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

Response samples

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

Get External Dynamic List Details

Get an External Dynamic List resource in the authenticated user's tenant.

Authorizations:
X-Auth-Token
path Parameters
id
required
string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$

The ID of the External Dynamic List resource.

header Parameters
X-Auth-Token
required
string

The keystone token.

Responses

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

get/v1/external-dynamic-lists/{id}
https://api.ntt.com/dsigw-erg/v1/external-dynamic-lists/{id}

Response samples

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

Update External Dynamic List

Update an External Dynamic List resource in the authenticated user's tenant. The type field is immutable. Predefined External Dynamic List resources cannot be updated.

Authorizations:
X-Auth-Token
path Parameters
id
required
string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$

The ID of the External Dynamic List resource.

header Parameters
X-Auth-Token
required
string

The keystone token.

Request Body schema: application/json
externalDynamicList
required
object (ExternalDynamicListUpdateRequest)

External Dynamic List update request schema. Omitted properties are not updated.

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

patch/v1/external-dynamic-lists/{id}
https://api.ntt.com/dsigw-erg/v1/external-dynamic-lists/{id}

Request samples

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

Response samples

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

Delete External Dynamic List

Delete an External Dynamic List resource in the authenticated user's tenant. Predefined External Dynamic List resources cannot be deleted. External Dynamic List resources referenced by policy resources cannot be deleted.

Authorizations:
X-Auth-Token
path Parameters
id
required
string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$

The ID of the External Dynamic List resource.

header Parameters
X-Auth-Token
required
string

The keystone token.

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

delete/v1/external-dynamic-lists/{id}
https://api.ntt.com/dsigw-erg/v1/external-dynamic-lists/{id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "errorCode": 400,
  • "errorMessage": "Invalid request",
  • "moreInfo": "{{moreInfo}}"
}

Get External Dynamic List Contents

Get valid entries of the External Dynamic List from the devices in all cells of the Cell-Group. If contents differ between cells, status is syncing and contents is null. Predefined External Dynamic List resources cannot be retrieved. Contents cannot be retrieved if the configStatus of the Cell-Group is not IN_SYNC, or if the External Dynamic List is not referred by any policy or profile.

Authorizations:
X-Auth-Token
path Parameters
id
required
string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$

The ID of the External Dynamic List resource.

header Parameters
X-Auth-Token
required
string

The keystone token.

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/v1/external-dynamic-lists/{id}/contents
https://api.ntt.com/dsigw-erg/v1/external-dynamic-lists/{id}/contents

Response samples

Content type
application/json
Example
Ok
Copy
 Expand all Collapse all
{
  • "externalDynamicList":
    {
    }
}

Refresh External Dynamic List

Refresh the specified External Dynamic List on all devices in cells belonging to the Cell-Group. This request is processed synchronously and returns after the refresh has been requested on all cells. You can use GET /v1/external-dynamic-lists/{id}/contents to confirm whether the refreshed contents have been applied. Predefined External Dynamic List resources cannot be refreshed. The External Dynamic List cannot be refreshed if no cells are found in the Cell-Group, if the configStatus of the Cell-Group is not IN_SYNC, or if the External Dynamic List is not referred by any policy or profile.

Authorizations:
X-Auth-Token
path Parameters
id
required
string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$

The ID of the External Dynamic List resource.

header Parameters
X-Auth-Token
required
string

The keystone token.

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

post/v1/external-dynamic-lists/{id}/refresh
https://api.ntt.com/dsigw-erg/v1/external-dynamic-lists/{id}/refresh

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "operationId": "12345678-1234-1234-1234-1234567890ab"
}