Certificate - Flexible Secure Gateway API References (1.13.0)

Download OpenAPI specification:Download

Manage the Certificates of the Cell-Groups.

Authentication

X-Auth-Token

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

certificate

Get Certificates

Get Certificate resources.

Authorizations:
query Parameters
id
string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$

Filter by the ID of the Certificate.

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

Filter by the ID of the Cell-Group the Certificate is allocated to.

header Parameters
X-Auth-Token
required
string

The keystone token.

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

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

Response samples

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

Create Certificate

Create a Certificate for a Cell-Group.

Authorizations:
header Parameters
X-Auth-Token
required
string

The keystone token.

Request Body schema: application/json
certificate
required
object

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

409

Conflict

500

Internal Server Error

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

Request samples

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

Response samples

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

Get Certificate

Get a Certificate resource.

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

The ID of the Certificate.

header Parameters
X-Auth-Token
required
string

The keystone token.

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/v1/certificates/{certificate_id}
https://api.ntt.com/dsigw-erg/v1/certificates/{certificate_id}

Response samples

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

Update Certificate

Update a Certificate resource.

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

The ID of the Certificate.

header Parameters
X-Auth-Token
required
string

The keystone token.

Request Body schema: application/json
certificate
required
object

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409

Conflict

500

Internal Server Error

patch/v1/certificates/{certificate_id}
https://api.ntt.com/dsigw-erg/v1/certificates/{certificate_id}

Request samples

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

Response samples

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

Delete Certificate

Delete a Certificate resource.

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

The ID of the Certificate.

header Parameters
X-Auth-Token
required
string

The keystone token.

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409

Conflict

500

Internal Server Error

delete/v1/certificates/{certificate_id}
https://api.ntt.com/dsigw-erg/v1/certificates/{certificate_id}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "errorCode": 400,
  • "errorMessage": "Invalid request",
  • "moreInfo": "{{moreInfo}}"
}

Export Certificate

Export certification of the Certificate.

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

The ID of the Certificate.

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/certificates/{certificate_id}/export-cert
https://api.ntt.com/dsigw-erg/v1/certificates/{certificate_id}/export-cert

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "cert": "-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----"
}