Documentation Powered by ReDoc

Security-Policy - Distributed Secure Internet 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

Security-policies describes that the Security-Policy of the Cell-Groups.

Authentication

X-Auth-Token

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

security-policy

Get Security Policies

Get Security-Policy 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.

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.

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

A name of the resource.

header Parameters
X-Auth-Token
string

The keystone token.

Responses

200

OK

400

Bad Request

401

Unauthorized

500

Internal Server Error

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

Response samples

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

Create Security Policy

Create a Security-Policy resource.

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

The keystone token.

Request Body schema: application/json
securityPolicy
required
object (SecurityPolicyCreateRequest)

Responses

200

OK

400

Bad Request

401

Unauthorized

500

Internal Server Error

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

Request samples

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

Response samples

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

Get Security Policy

Get a Security-Policy resource.

Authorizations:
X-Auth-Token
path Parameters
security_policy_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}$

The keystone token.

Responses

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

get/v1/security-policies/{security_policy_id}
https://api.ntt.com/dsigw-erg/v1/security-policies/{security_policy_id}

Response samples

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

Update Security Policy

Update a Security-Policy resource.

Authorizations:
X-Auth-Token
path Parameters
security_policy_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

The keystone token.

Request Body schema:
application/json
securityPolicy
required
object (SecurityPolicyUpdateRequest)

Responses

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

patch/v1/security-policies/{security_policy_id}
https://api.ntt.com/dsigw-erg/v1/security-policies/{security_policy_id}

Request samples

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

Response samples

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

Delete Security Policy

Delete a Security-Policy resource.

Authorizations:
X-Auth-Token
path Parameters
security_policy_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

The keystone token.

Responses

202

Accepted

401

Unauthorized

404

Not Found

500

Internal Server Error

delete/v1/security-policies/{security_policy_id}
https://api.ntt.com/dsigw-erg/v1/security-policies/{security_policy_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "errorCode": 401,
  • "errorMessage": "Invalid token. abcdef1234567890abcdef1234567890",
  • "moreInfo": null
}