Documentation Powered by ReDoc

Area - Flexible Secure Gateway API References (1.10.0)

Download OpenAPI specification:Download

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

Area/Zone are the resource accommodation units. The Area belongs specific Area/Zone.

Authentication

X-Auth-Token

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

area

Get Area

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

_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" "description"

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/areas
https://api.ntt.com/dsigw-erg/v1/areas

Response samples

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

Get Area Details

Get a Area resource.

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

The ID of the Area 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/areas/{area_id}
https://api.ntt.com/dsigw-erg/v1/areas/{area_id}

Response samples

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