Documentation Powered by ReDoc

Cell - Flexible Secure Gateway API References (1.5.0)

Download OpenAPI specification:Download

URL: https://sdpf.ntt.com/ License: (c) 2020-2022 NTT Communications Corporation All Rights Reserved. Terms of Service

Cells are an actual components that realize DSIGW service. Cells always belong to Cell-Groups and are connected to the customer network via FIC connection.

Authentication

X-Auth-Token

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

cell

Get Cell

Get Cell 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.

area
string

The Area of the Cell deployed.

zone
string

The Zone of the Cell deployed.

plan
string

A Plan name of the Cell.

cellGroupId
string

The Cell-Group ID which the resource belongs.

configVersion
integer

Config version of Cell (incremental).

proxyHostname
string

A hostname of the proxy.

utmHostname
string

A hostname of the utm.

configStatus
string

The status of config synchronization.

tenantId
string

The tenant ID which the resource belongs.

header Parameters
X-Auth-Token
required
string ^[a-fA-F0-9]{32}$

The keystone token.

Responses

200

OK

400

Bad Request

401

Unauthorized

500

Internal Server Error

get/v1/cells
https://api.ntt.com/dsigw-erg/v1/cells

Response samples

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

Create Cell

Create a Cell resource.

Authorizations:
X-Auth-Token
header Parameters
X-Auth-Token
required
string ^[a-fA-F0-9]{32}$

The keystone token.

Request Body schema: application/json
cell
required
object (CellCreateRequest)

Responses

202

OK

400

Bad Request

401

Unauthorized

403

Forbidden

409

Conflict

500

Internal Server Error

post/v1/cells
https://api.ntt.com/dsigw-erg/v1/cells

Request samples

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

Response samples

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

Get Cell Details

Get a Cell resource.

Authorizations:
X-Auth-Token
path Parameters
cell_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 ^[a-fA-F0-9]{32}$

The keystone token.

Responses

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

get/v1/cells/{cell_id}
https://api.ntt.com/dsigw-erg/v1/cells/{cell_id}

Response samples

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

Update Cell

Update a Cell resource.

Authorizations:
X-Auth-Token
path Parameters
cell_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 ^[a-fA-F0-9]{32}$
Request Body schema: application/json
cell
required
object (CellUpdateRequest)

Responses

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

patch/v1/cells/{cell_id}
https://api.ntt.com/dsigw-erg/v1/cells/{cell_id}

Request samples

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

Response samples

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

Delete Cell

Delete a Cell resource.

Authorizations:
X-Auth-Token
path Parameters
cell_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 ^[a-fA-F0-9]{32}$

Responses

202

OK

400

Bad Request

401

Unauthorized

404

Not Found

409

Conflict

500

Internal Server Error

delete/v1/cells/{cell_id}
https://api.ntt.com/dsigw-erg/v1/cells/{cell_id}

Response samples

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