Documentation Powered by ReDoc

Cell-Group - 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

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 ^[a-fA-F0-9]{32}$

The keystone token.

Responses

200

OK

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
application/json
Copy
 Expand all Collapse all
{
  • "cellGroups":
    [
    ]
}

Create Cell-Group

Create a Cell-Group 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
cellGroup
required
object (CellGroupCreateRequest)

CellGroup create request object.

Responses

200

OK

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

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

Response samples

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

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

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

OK

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

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

Response samples

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

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

OK

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 ^[a-fA-F0-9]{32}$

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

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 ^[a-fA-F0-9]{32}$

The keystone token.

Request Body schema: application/json

Responses

200

OK

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

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 ^[a-fA-F0-9]{32}$

The keystone token.

Request Body schema: application/json

Responses

200

OK

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

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."
}