Cell-Group - Distributed Secure Internet GateWay API References (1.5.0)

Download OpenAPI specification:Download

Cell-Groups specifies the group of Cells having the same policy.

Authentication

X-Auth-Token

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

cell-group

Get Cell-Groups

Get Cell-Group 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-Z0-9-_]{1,255}$ A name of the resource.

header Parameters

X-Auth-Token

required

string

The keystone token.

Responses

200

400

Bad Request

401

Unauthorized

500

Internal Server Error

get/v1/cell-groups

https://api.ntt.com/dsigw-erg/v1/cell-groups

Response samples

Content type

Copy

Expand all Collapse all


{"cellGroups": 
[
{"id": "5be775de-aa0b-468c-ba69-6e35dc5c5c32",
"name": "test_group",
"securityPolicies": 
["86acc283-c60d-4c3f-a193-77e249a9c3ab",
"932b6296-9981-4247-883c-ab059c8e8148"
],
"dnsDomain": "dsigw.ntt.com",
"dnsTimeToLive": 10,
"dnsHostname": "sample",
"alertEmails": 
["aaa@example.com"
],
"alertConditions": 
{"logAlerts": 
[
{"type": "virusDetectedWithAlert",
"interval": 60,
"threshold": 10
}
],
"metricsAlerts": 
[
{"type": "incomingTraffic",
"threshold": 70
}
]
},
"reservedPrivatePrefix": null,
"staticRoutes": [ ],
"logForward": [ ],
"logMonitoring": 
{"userId": false,
"authentication": false
},
"captivePortalSetting": 
{"enable": true,
"timer": 1440,
"idleTimer": 480,
"idAuthentication": true,
"idDomainAuthentication": true
},
"sslDecryptionSetting": 
{"overflowAction": "block",
"o365Decryption": false
},
"authenticationLinkMode": null,
"azureActiveDirectorySetting": 
{"samlIdentityProviderConfigId": null
},
"cellVersionId": "12345678-1234-1234-1234-1234567890ab",
"configVersion": 3,
"configStatus": "OUT_OF_SYNC",
"tenantId": "12345678abcdabcdabcd1234567890ab",
"createdAt": "2019-05-14T03:04:48Z",
"updatedAt": "2019-05-14T03:04:48Z"
}
]
}

Create Cell-Group

Create a Cell-Group resource.

Authorizations:

X-Auth-Token

header Parameters

X-Auth-Token

required

string

The keystone token.

Request Body schema: application/json

cellGroup

required

object (CellGroupCreateRequest)

CellGroup create request object.

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

post/v1/cell-groups

https://api.ntt.com/dsigw-erg/v1/cell-groups

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"cellGroup": 
{"name": "test_group",
"dnsDomain": "dsigw.poc.local",
"dnsHostname": "sample",
"alertEmails": 
["aaa@example.com"
],
"alertConditions": 
{"logAlerts": 
[
{"type": "virusDetectedWithAlert",
"interval": 60,
"threshold": 10
}
],
"metricsAlerts": 
[
{"type": "incomingTraffic",
"threshold": 70
}
]
}
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"cellGroup": 
{"id": "5be775de-aa0b-468c-ba69-6e35dc5c5c32",
"name": "test_group",
"securityPolicies": [ ],
"dnsDomain": "dsigw.ntt.com",
"dnsHostname": "sample",
"dnsTimeToLive": 10,
"alertEmails": 
["aaa@example.com"
],
"alertConditions": 
{"logAlerts": 
[
{"type": "virusDetectedWithAlert",
"interval": 60,
"threshold": 10
}
],
"metricsAlerts": 
[
{"type": "incomingTraffic",
"threshold": 70
}
]
},
"reservedPrivatePrefix": null,
"staticRoutes": [ ],
"logForward": [ ],
"logMonitoring": 
{"userId": false,
"authentication": false
},
"captivePortalSetting": 
{"enable": true,
"timer": 1440,
"idleTimer": 480,
"idAuthentication": true,
"idDomainAuthentication": true
},
"sslDecryptionSetting": 
{"overflowAction": "block",
"o365Decryption": false
},
"authenticationLinkMode": null,
"azureActiveDirectorySetting": 
{"samlIdentityProviderConfigId": null
},
"cellVersionId": "12345678-1234-1234-1234-1234567890ab",
"configVersion": 0,
"configStatus": "IN_SYNC",
"operationId": "715ee526-1c17-44c4-822d-c3c044babfe8",
"tenantId": "12345678abcdabcdabcd1234567890ab",
"createdAt": "2019-05-14T03:04:48Z",
"updatedAt": "2019-05-14T03:04:48Z"
}
}

Get Cell-Group Details

Get a Cell-Group resource.

Authorizations:

X-Auth-Token

path Parameters

cell_group_id

required

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

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/cell-groups/{cell_group_id}

https://api.ntt.com/dsigw-erg/v1/cell-groups/{cell_group_id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"cellGroup": 
{"id": "5be775de-aa0b-468c-ba69-6e35dc5c5c32",
"name": "test_group_updated",
"securityPolicies": 
["86acc283-c60d-4c3f-a193-77e249a9c3ab",
"932b6296-9981-4247-883c-ab059c8e8148"
],
"dnsDomain": "dsigw.ntt.com",
"dnsHostname": "sample",
"dnsTimeToLive": 10,
"alertEmails": 
["aaa@example.com"
],
"alertConditions": 
{"logAlerts": 
[
{"type": "virusDetectedWithAlert",
"interval": 60,
"threshold": 10
}
],
"metricsAlerts": 
[
{"type": "incomingTraffic",
"threshold": 70
}
]
},
"reservedPrivatePrefix": null,
"staticRoutes": [ ],
"logForward": [ ],
"logMonitoring": 
{"userId": false,
"authentication": false
},
"captivePortalSetting": 
{"enable": true,
"timer": 1440,
"idleTimer": 480,
"idAuthentication": true,
"idDomainAuthentication": true
},
"sslDecryptionSetting": 
{"overflowAction": "block",
"o365Decryption": false
},
"authenticationLinkMode": null,
"azureActiveDirectorySetting": 
{"samlIdentityProviderConfigId": "12345678-1234-1234-1234-1234567890ab"
},
"cellVersionId": "12345678-1234-1234-1234-1234567890ab",
"configVersion": 3,
"configStatus": "OUT_OF_SYNC",
"tenantId": "12345678abcdabcdabcd1234567890ab",
"createdAt": "2019-05-14T03:04:48Z",
"updatedAt": "2019-05-14T03:04:48Z"
}
}

Update Cell-Group

Update a Cell-Group resource.

Authorizations:

X-Auth-Token

path Parameters

cell_group_id

required

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

header Parameters

X-Auth-Token

string ^[a-fA-F0-9]{32}$

Request Body schema: application/json

cellGroup

required

object (CellGroupUpdateRequest)

CellGroup update request schema.

Responses

200

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

patch/v1/cell-groups/{cell_group_id}

https://api.ntt.com/dsigw-erg/v1/cell-groups/{cell_group_id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"cellGroup": 
{"name": "test_group_updated",
"securityPolicies": 
["86acc283-c60d-4c3f-a193-77e249a9c3ab",
"932b6296-9981-4247-883c-ab059c8e8148"
]
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"cellGroup": 
{"id": "5be775de-aa0b-468c-ba69-6e35dc5c5c32",
"name": "test_group_updated",
"securityPolicies": 
["86acc283-c60d-4c3f-a193-77e249a9c3ab",
"932b6296-9981-4247-883c-ab059c8e8148"
],
"dnsDomain": "dsigw.ntt.com",
"dnsHostname": "sample",
"dnsTimeToLive": 10,
"reservedPrivatePrefix": null,
"staticRoutes": [ ],
"alertEmails": 
["aaa@example.com"
],
"alertConditions": 
{"logAlerts": 
[
{"type": "virusDetectedWithAlert",
"interval": 60,
"threshold": 10
}
],
"metricsAlerts": 
[
{"type": "incomingTraffic",
"threshold": 70
}
]
},
"logForward": [ ],
"logMonitoring": 
{"userId": false,
"authentication": false
},
"captivePortalSetting": 
{"enable": true,
"timer": 1440,
"idleTimer": 480,
"idAuthentication": true,
"idDomainAuthentication": true
},
"sslDecryptionSetting": 
{"overflowAction": "block",
"o365Decryption": false
},
"authenticationLinkMode": null,
"azureActiveDirectorySetting": 
{"samlIdentityProviderConfigId": "12345678-1234-1234-1234-1234567890ab"
},
"cellVersionId": "12345678-1234-1234-1234-1234567890ab",
"configVersion": 4,
"configStatus": "OUT_OF_SYNC",
"tenantId": "12345678abcdabcdabcd1234567890ab",
"operationId": "715ee526-1c17-44c4-822d-c3c044babfe8",
"createdAt": "2019-05-14T03:04:48Z",
"updatedAt": "2019-05-14T03:04:48Z"
}
}

Delete Cell-Group

Delete a Cell-Group resource.

Authorizations:

X-Auth-Token

path Parameters

cell_group_id

required

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

header Parameters

X-Auth-Token

string ^[a-fA-F0-9]{32}$

Responses

200

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

delete/v1/cell-groups/{cell_group_id}

https://api.ntt.com/dsigw-erg/v1/cell-groups/{cell_group_id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


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

Sync Cell-Group Config

Sync configuration to Cells belonging to the Cell-Group.

Authorizations:

X-Auth-Token

path Parameters

cell_group_id

required

string

header Parameters

X-Auth-Token

required

string

The keystone token.

Request Body schema: application/json

Responses

202

Accepted

400

Bad Request

401

Unauthorized

404

Not Found

409

Conflict

500

Internal Server Error

post/v1/cell-groups/{cell_group_id}/sync

https://api.ntt.com/dsigw-erg/v1/cell-groups/{cell_group_id}/sync

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{ }

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"operationId": "3f72399b-f62b-46fa-9024-4ccbc4f3f900",
"message": "Order accepted."
}

Export Cell-Group Cert

Export certification used in the Cell-Group.

Authorizations:

X-Auth-Token

path Parameters

cell_group_id

required

string

header Parameters

X-Auth-Token

required

string

The keystone token.

Request Body schema: application/json

Responses

200

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

get/v1/cell-groups/{cell_group_id}/export-cert

https://api.ntt.com/dsigw-erg/v1/cell-groups/{cell_group_id}/export-cert

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{ }

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"cert": "-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----"
}

Renew Cell-Group Cert

Re-create certificate used in the Cell-Group.

Authorizations:

X-Auth-Token

path Parameters

cell_group_id

required

string

header Parameters

X-Auth-Token

required

string

The keystone token.

Request Body schema: application/json

Responses

200

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

post/v1/cell-groups/{cell_group_id}/renew-cert

https://api.ntt.com/dsigw-erg/v1/cell-groups/{cell_group_id}/renew-cert

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{ }

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"operationId": "e3e5cd65-ea59-409a-a66d-808e41c47c5b",
"message": "Renew cert completed."
}