Documentation Powered by ReDoc

API Gateway as a Service X テナント管理API (1.07)

Download OpenAPI specification:Download

Authentication

KeyStoneAuth

KeystoneTokenを設定

Security Scheme Type API Key
Header parameter name: X-Auth-Token

Info for a specific sdpfTenantId

Authorizations:
KeyStoneAuth
path Parameters
sdpfTenantId
required
string
Example: d09c457e4ddb4acca2f15e1ce3db209d

maximum 64 Characters

Responses

200

正常レスポンス

401

認証エラー

500

サーバエラー

get/sdpfTenants/{sdpfTenantId}
https://api.ntt.com/apigw-x/v1/sdpfTenants/{sdpfTenantId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "sdpfTenantId": "d09c457e4ddb4acca2f15e1ce3db209d",
  • "partnerId": "string",
  • "partnerName": "string",
  • "customerName": "string",
  • "contractDate": "2020-01-01T12:00:00.000Z",
  • "axrossTenants":
    [
    ],
  • "axrossOptions":
    [
    ]
}

Create an axrossTenantId

Authorizations:
KeyStoneAuth
path Parameters
sdpfTenantId
required
string
Example: d09c457e4ddb4acca2f15e1ce3db209d

maximum 64 Characters

Request Body schema: application/json
partnerId
string

maximum 64 Characters

partnerName
string

maximum 64 Characters

customerName
string

maximum 64 Characters

axrossTenants
Array of objects
axrossOptions
Array of objects

Responses

201

正常レスポンス

400

validationエラー

401

認証エラー

500

サーバエラー

post/sdpfTenants/{sdpfTenantId}
https://api.ntt.com/apigw-x/v1/sdpfTenants/{sdpfTenantId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "partnerId": "string",
  • "partnerName": "string",
  • "customerName": "string",
  • "axrossTenants":
    [
    ],
  • "axrossOptions":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "sdpfTenantId": "d09c457e4ddb4acca2f15e1ce3db209d",
  • "partnerId": "string",
  • "partnerName": "string",
  • "customerName": "string",
  • "axrossTenants":
    {
    },
  • "axrossOptions":
    {
    }
}

Delete all axrossTenantId in sdpfTenant

Authorizations:
KeyStoneAuth
path Parameters
sdpfTenantId
required
string
Example: d09c457e4ddb4acca2f15e1ce3db209d

maximum 64 Characters

Responses

200

正常

400

validationエラー

401

認証エラー

404

未存在エラー

500

サーバエラー

delete/sdpfTenants/{sdpfTenantId}
https://api.ntt.com/apigw-x/v1/sdpfTenants/{sdpfTenantId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "errorCode": "E010001",
  • "errorMessage": "string"
}

Info for a specific axrossTenantId

Authorizations:
KeyStoneAuth
path Parameters
sdpfTenantId
required
string
Example: d09c457e4ddb4acca2f15e1ce3db209d

maximum 64 Characters

axrossTenantId
required
string
Example: 12ee5389-de3b-4f76-9ba7-13a4b584d384

maximum 36 Characters

Responses

200

正常レスポンス

401

認証エラー

500

サーバエラー

get/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}
https://api.ntt.com/apigw-x/v1/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "axrossTenantId": "12ee5389-de3b-4f76-9ba7-13a4b584d384",
  • "sdpfTenantId": "d09c457e4ddb4acca2f15e1ce3db209d",
  • "axrossPlanId": "string",
  • "axrossPlan": "string",
  • "axrossTenantName": "string",
  • "cloud": "string",
  • "region": "string",
  • "subDomain": "string",
  • "contractDate": "2020-01-01T12:00:00.000Z",
  • "cancelDate": "2020-01-01T12:00:00.000Z",
  • "deployStatus": "string",
  • "deployDate": "2020-01-01T12:00:00.000Z",
  • "org": "string",
  • "billingStartDate": "2020-01-01T12:00:00.000Z",
  • "cidr": "string",
  • "axrossOptions":
    [
    ]
}

Update a specific of axrossTenantId

Authorizations:
KeyStoneAuth
path Parameters
sdpfTenantId
required
string
Example: d09c457e4ddb4acca2f15e1ce3db209d

maximum 64 Characters

axrossTenantId
required
string
Example: 12ee5389-de3b-4f76-9ba7-13a4b584d384

maximum 36 Characters

Request Body schema: application/json
axrossPlan
string
axrossTenantName
string

Responses

200

正常

400

validationエラー

401

認証エラー

404

未存在エラー

500

サーバエラー

put/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}
https://api.ntt.com/apigw-x/v1/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "axrossPlan": "string",
  • "axrossTenantName": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "sdpfTenantId": "d09c457e4ddb4acca2f15e1ce3db209d",
  • "axrossTenantId": "12ee5389-de3b-4f76-9ba7-13a4b584d384",
  • "axrossPlan": "string",
  • "axrossTenantName": "string"
}

Delete a specific of axrossTenantId

Authorizations:
KeyStoneAuth
path Parameters
sdpfTenantId
required
string
Example: d09c457e4ddb4acca2f15e1ce3db209d

maximum 64 Characters

axrossTenantId
required
string
Example: 12ee5389-de3b-4f76-9ba7-13a4b584d384

maximum 36 Characters

Responses

200

正常

400

validationエラー

401

認証エラー

404

未存在エラー

500

サーバエラー

delete/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}
https://api.ntt.com/apigw-x/v1/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "errorCode": "E010001",
  • "errorMessage": "string"
}

Info for all Option

Authorizations:
KeyStoneAuth
path Parameters
sdpfTenantId
required
string
Example: d09c457e4ddb4acca2f15e1ce3db209d

maximum 64 Characters

axrossTenantId
required
string
Example: 12ee5389-de3b-4f76-9ba7-13a4b584d384

maximum 36 Characters

Responses

200

正常レスポンス

401

認証エラー

500

サーバエラー

get/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/options
https://api.ntt.com/apigw-x/v1/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/options

Response samples

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

Create an axrossOptionId

Authorizations:
KeyStoneAuth
path Parameters
sdpfTenantId
required
string
Example: d09c457e4ddb4acca2f15e1ce3db209d

maximum 64 Characters

axrossTenantId
required
string
Example: 12ee5389-de3b-4f76-9ba7-13a4b584d384

maximum 36 Characters

Request Body schema: application/json
optionContent
string

can Set (staticIP/cloudPeering/ficGateway/backendMtls)

cloud
string

can Set (Amazon Web Service/Google Cloud/Microsoft Azure) to use for cloudPeering or ficGateway

gcpBackendProjectId
string

minimum 6 Characters, maximum 30 Characters to use for cloudPeering(Google Cloud)

gcpBackendVpcId
string

maximum 63 Characters to use for cloudPeering(Google Cloud)

awsBackendAccountId
string

12 Characters to use for cloudPeering(Amazon Web Service)

awsBackendVpcId
string

21 Characters to use for cloudPeering(Amazon Web Service)

awsBackendVpcCIDR
string

maximum 18 Characters and Cidr can set from /16 to /28 to use for cloudPeering(Amazon Web Service).

awsAsNumber
string

maximum 10 Characters to use for ficGateway(Amazon Web Service)

Responses

201

正常レスポンス

400

validationエラー

401

認証エラー

500

サーバエラー

post/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/options
https://api.ntt.com/apigw-x/v1/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/options

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "optionContent": "string",
  • "cloud": "string",
  • "gcpBackendProjectId": "string",
  • "gcpBackendVpcId": "string",
  • "awsBackendAccountId": "string",
  • "awsBackendVpcId": "string",
  • "awsBackendVpcCIDR": "string",
  • "awsAsNumber": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "axrossOptionId": "13ee5389-de3b-4f76-9ba7-13a4b584d384",
  • "optionId": "string",
  • "optionContent": "string",
  • "contractDate": "2020-01-01T12:00:00.000Z",
  • "cancelDate": "2020-01-01T12:00:00.000Z",
  • "deployDate": "2020-01-01T12:00:00.000Z",
  • "axrossOptionDeployId": "13ee5389-de3b-4f76-9ba7-13a4b584d384",
  • "cloud": "string",
  • "gcpBackendProjectId": "string",
  • "gcpBackendVpcId": "string",
  • "awsBackendAccountId": "string",
  • "awsBackendVpcId": "string",
  • "awsBackendVpcCIDR": "string",
  • "awsAsNumber": "string"
}

Info for a specific axrossOptionId

Authorizations:
KeyStoneAuth
path Parameters
sdpfTenantId
required
string
Example: d09c457e4ddb4acca2f15e1ce3db209d

maximum 64 Characters

axrossTenantId
required
string
Example: 12ee5389-de3b-4f76-9ba7-13a4b584d384

maximum 36 Characters

axrossOptionId
required
string
Example: 13ee5389-de3b-4f76-9ba7-13a4b584d384

maximum 36 Characters

Responses

200

正常レスポンス

401

認証エラー

500

サーバエラー

get/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/options/{axrossOptionId}
https://api.ntt.com/apigw-x/v1/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/options/{axrossOptionId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "axrossOptionId": "13ee5389-de3b-4f76-9ba7-13a4b584d384",
  • "optionId": "string",
  • "optionContent": "string",
  • "contractDate": "2020-01-01T12:00:00.000Z",
  • "cancelDate": "2020-01-01T12:00:00.000Z",
  • "deployDate": "2020-01-01T12:00:00.000Z",
  • "billingStartDate": "2020-01-01T12:00:00.000Z",
  • "optionDeployStatus": "string",
  • "axrossOptionDeployId": "13ee5389-de3b-4f76-9ba7-13a4b584d384",
  • "properties":
    {
    }
}

Update a specific of axrossOptionId

Authorizations:
KeyStoneAuth
path Parameters
sdpfTenantId
required
string
Example: d09c457e4ddb4acca2f15e1ce3db209d

maximum 64 Characters

axrossTenantId
required
string
Example: 12ee5389-de3b-4f76-9ba7-13a4b584d384

maximum 36 Characters

axrossOptionId
required
string
Example: 13ee5389-de3b-4f76-9ba7-13a4b584d384

maximum 36 Characters

Request Body schema: application/json
optionContent
string

can Set (ficGateway)

cloud
string

can Set (Amazon Web Service) to use for ficGateway

awsFicConnectionId
string

13 Characters to use for ficGateway(Amazon Web Service)

awsBackendSdpfTenantId
string

32 Characters to use for ficGateway(Amazon Web Service)

Responses

200

正常レスポンス

400

validationエラー

401

認証エラー

404

未存在エラー

500

サーバエラー

put/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/options/{axrossOptionId}
https://api.ntt.com/apigw-x/v1/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/options/{axrossOptionId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "optionContent": "string",
  • "cloud": "string",
  • "awsFicConnectionId": "string",
  • "awsBackendSdpfTenantId": "d09c457e4ddb4acca2f15e1ce3db209d"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "optionContent": "string",
  • "cloud": "string",
  • "awsFicConnectionId": "string",
  • "awsBackendSdpfTenantId": "d09c457e4ddb4acca2f15e1ce3db209d"
}

Delete a specific of axrossOptionId

Authorizations:
KeyStoneAuth
path Parameters
sdpfTenantId
required
string
Example: d09c457e4ddb4acca2f15e1ce3db209d

maximum 64 Characters

axrossTenantId
required
string
Example: 12ee5389-de3b-4f76-9ba7-13a4b584d384

maximum 36 Characters

axrossOptionId
required
string
Example: 9aa309b4-cd14-41ed-bedb-952f90577f07

maximum 36 Characters

Responses

200

正常

400

validationエラー

401

認証エラー

404

未存在エラー

500

サーバエラー

delete/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/options/{axrossOptionId}
https://api.ntt.com/apigw-x/v1/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/options/{axrossOptionId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "errorCode": "E010001",
  • "errorMessage": "string"
}

Info for Location of Cloud

Authorizations:
KeyStoneAuth
path Parameters
sdpfTenantId
required
string
Example: d09c457e4ddb4acca2f15e1ce3db209d

maximum 64 Characters

Responses

200

正常レスポンス

401

認証エラー

500

サーバエラー

get/sdpfTenants/{sdpfTenantId}/locations
https://api.ntt.com/apigw-x/v1/sdpfTenants/{sdpfTenantId}/locations

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Amazon Web Service":
    [
    ],
  • "Google Cloud Platform":
    [
    ],
  • "Microsoft Azure":
    [
    ]
}

Info for all apiName

Authorizations:
KeyStoneAuth
path Parameters
sdpfTenantId
required
string
Example: d09c457e4ddb4acca2f15e1ce3db209d

maximum 64 Characters

axrossTenantId
required
string
Example: 12ee5389-de3b-4f76-9ba7-13a4b584d384

maximum 36 Characters

Responses

200

正常

get/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/apis
https://api.ntt.com/apigw-x/v1/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/apis

Response samples

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

Create a apiName

Authorizations:
KeyStoneAuth
path Parameters
sdpfTenantId
required
string
Example: d09c457e4ddb4acca2f15e1ce3db209d

maximum 64 Characters

axrossTenantId
required
string
Example: 12ee5389-de3b-4f76-9ba7-13a4b584d384

maximum 36 Characters

Request Body schema: application/json
name
string (apiNameObject)

maximum 50 Characters

properties
object (apiPropertiesObject)

Responses

201

正常

post/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/apis
https://api.ntt.com/apigw-x/v1/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/apis

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "sampleApi",
  • "properties":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "9aa309b4-cd14-41ed-bedb-952f90577f07",
  • "name": "sampleApi",
  • "properties":
    {
    }
}

Info for a specific apiName

Authorizations:
KeyStoneAuth
path Parameters
sdpfTenantId
required
string
Example: d09c457e4ddb4acca2f15e1ce3db209d

maximum 64 Characters

axrossTenantId
required
string
Example: 9aa309b4-cd14-41ed-bedb-952f90577f07

maximum 36 Characters

apiName
required
string
Example: apiName1

maximum 50 Characters

Responses

200

正常

get/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/apis/{apiName}
https://api.ntt.com/apigw-x/v1/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/apis/{apiName}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "9aa309b4-cd14-41ed-bedb-952f90577f07",
  • "name": "sampleApi",
  • "properties":
    {
    },
  • "lastUpdate": "2021-07-15T19:45:45.000Z",
  • "status": "APPROVE"
}

Delete a specific of apiName

Authorizations:
KeyStoneAuth
path Parameters
sdpfTenantId
required
string
Example: d09c457e4ddb4acca2f15e1ce3db209d

maximum 64 Characters

axrossTenantId
required
string
Example: 9aa309b4-cd14-41ed-bedb-952f90577f07

maximum 36 Characters

apiName
required
string
Example: apiName1

maximum 50 Characters

Responses

200

正常

delete/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/apis/{apiName}
https://api.ntt.com/apigw-x/v1/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/apis/{apiName}

Update a specific of apiName

Authorizations:
KeyStoneAuth
path Parameters
sdpfTenantId
required
string
Example: d09c457e4ddb4acca2f15e1ce3db209d

maximum 64 Characters

axrossTenantId
required
string
Example: 9aa309b4-cd14-41ed-bedb-952f90577f07

maximum 36 Characters

apiName
required
string
Example: apiName1

maximum 50 Characters

Request Body schema: application/json
properties
object (apiPropertiesObject)

Responses

200

正常

put/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/apis/{apiName}
https://api.ntt.com/apigw-x/v1/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/apis/{apiName}

Request samples

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "9aa309b4-cd14-41ed-bedb-952f90577f07",
  • "name": "sampleApi",
  • "properties":
    {
    }
}

Info for all credentialId

Authorizations:
KeyStoneAuth
path Parameters
sdpfTenantId
required
string
Example: d09c457e4ddb4acca2f15e1ce3db209d

maximum 64 Characters

axrossTenantId
required
string
Example: 12ee5389-de3b-4f76-9ba7-13a4b584d384

maximum 36 Characters

Responses

200

正常

get/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/credentials
https://api.ntt.com/apigw-x/v1/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/credentials

Response samples

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

Create a credentialId

Authorizations:
KeyStoneAuth
path Parameters
sdpfTenantId
required
string
Example: d09c457e4ddb4acca2f15e1ce3db209d

maximum 64 Characters

axrossTenantId
required
string
Example: 12ee5389-de3b-4f76-9ba7-13a4b584d384

maximum 36 Characters

Request Body schema: application/json
credentialName
string (credentialNameObject)

maximum 50 Characters

expiration
string (expirationPostObject)

Time Zone is UTC. Date Only. If value is "" then expiration is Never.

note
string (noteObject)

maximum 32 Characters

Responses

201

正常

post/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/credentials
https://api.ntt.com/apigw-x/v1/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/credentials

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "credentialName": "sampleCredentials",
  • "expiration": "2021-08-15 00:00:00",
  • "note": "user comment"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "9aa309b4-cd14-41ed-bedb-952f90577f08",
  • "credentialName": "sampleCredentials",
  • "consumerKeyProperty":
    {
    },
  • "note": "user comment",
  • "issueAt": "2021-07-15T19:45:45.000Z",
  • "lastUpdate": "2021-07-15T19:45:45.000Z"
}

Info for a specific credentialId

Authorizations:
KeyStoneAuth
path Parameters
sdpfTenantId
required
string
Example: d09c457e4ddb4acca2f15e1ce3db209d

maximum 64 Characters

axrossTenantId
required
string
Example: 9aa309b4-cd14-41ed-bedb-952f90577f07

maximum 36 Characters

credentialId
required
string
Example: 9aa309b4-cd14-41ed-bedb-952f90577f08

maximum 36 Characters

Responses

200

正常

get/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/credentials/{credentialId}
https://api.ntt.com/apigw-x/v1/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/credentials/{credentialId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "9aa309b4-cd14-41ed-bedb-952f90577f08",
  • "credentialName": "sampleCredentials",
  • "consumerKeys":
    [
    ],
  • "note": "user comment",
  • "issueAt": "2021-07-15T19:45:45.000Z",
  • "lastUpdate": "2021-07-15T19:45:45.000Z"
}

Create a consumerKeyId

Authorizations:
KeyStoneAuth
path Parameters
sdpfTenantId
required
string
Example: d09c457e4ddb4acca2f15e1ce3db209d

maximum 64 Characters

axrossTenantId
required
string
Example: 9aa309b4-cd14-41ed-bedb-952f90577f07

maximum 36 Characters

credentialId
required
string
Example: 9aa309b4-cd14-41ed-bedb-952f90577f08

maximum 36 Characters

Request Body schema: application/json
expiration
string (expirationPostObject)

Time Zone is UTC. Date Only. If value is "" then expiration is Never.

Responses

200

正常

post/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/credentials/{credentialId}
https://api.ntt.com/apigw-x/v1/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/credentials/{credentialId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "expiration": "2021-08-15 00:00:00"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "9aa309b4-cd14-41ed-bedb-952f90577f08",
  • "credentialName": "sampleCredentials",
  • "consumerKeyProperty":
    {
    },
  • "note": "user comment",
  • "issueAt": "2021-07-15T19:45:45.000Z",
  • "lastUpdate": "2021-07-15T19:45:45.000Z"
}

Delete a specific of credentialId

Authorizations:
KeyStoneAuth
path Parameters
sdpfTenantId
required
string
Example: d09c457e4ddb4acca2f15e1ce3db209d

maximum 64 Characters

axrossTenantId
required
string
Example: 9aa309b4-cd14-41ed-bedb-952f90577f07

maximum 36 Characters

credentialId
required
string
Example: 9aa309b4-cd14-41ed-bedb-952f90577f08

maximum 36 Characters

Responses

200

正常

delete/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/credentials/{credentialId}
https://api.ntt.com/apigw-x/v1/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/credentials/{credentialId}

Info for a specific consumerKeyId

Authorizations:
KeyStoneAuth
path Parameters
sdpfTenantId
required
string
Example: d09c457e4ddb4acca2f15e1ce3db209d

maximum 64 Characters

axrossTenantId
required
string
Example: 9aa309b4-cd14-41ed-bedb-952f90577f07

maximum 36 Characters

credentialId
required
string
Example: 9aa309b4-cd14-41ed-bedb-952f90577f08

maximum 36 Characters

consumerKeyId
required
string
Example: 9aa309b4-cd14-41ed-bedb-952f90577f09

maximum 36 Characters

Responses

200

正常

get/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/credentials/{credentialId}/consumerKeys/{consumerKeyId}
https://api.ntt.com/apigw-x/v1/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/credentials/{credentialId}/consumerKeys/{consumerKeyId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "9aa309b4-cd14-41ed-bedb-952f90577f08",
  • "consumerKey": "abcdefghijklmn1234567890",
  • "expiration": "2021-08-15T00:00:00.000Z",
  • "issueAt": "2021-07-15T19:45:45.000Z",
  • "lastUpdate": "2021-07-15T19:45:45.000Z"
}

Delete a specific of consumerKeyId

Authorizations:
KeyStoneAuth
path Parameters
sdpfTenantId
required
string
Example: d09c457e4ddb4acca2f15e1ce3db209d

maximum 64 Characters

axrossTenantId
required
string
Example: 9aa309b4-cd14-41ed-bedb-952f90577f07

maximum 36 Characters

credentialId
required
string
Example: 9aa309b4-cd14-41ed-bedb-952f90577f08

maximum 36 Characters

consumerKeyId
required
string
Example: 9aa309b4-cd14-41ed-bedb-952f90577f09

maximum 36 Characters

Responses

200

正常

delete/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/credentials/{credentialId}/consumerKeys/{consumerKeyId}
https://api.ntt.com/apigw-x/v1/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/credentials/{credentialId}/consumerKeys/{consumerKeyId}

Info for all keystoreId

Authorizations:
KeyStoneAuth
path Parameters
sdpfTenantId
required
string
Example: d09c457e4ddb4acca2f15e1ce3db209d

maximum 64 Characters

axrossTenantId
required
string
Example: 12ee5389-de3b-4f76-9ba7-13a4b584d384

maximum 36 Characters

Responses

200

正常レスポンス

401

認証エラー

500

サーバエラー

get/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/keystores
https://api.ntt.com/apigw-x/v1/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/keystores

Response samples

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

Create a keystoreId and Send backend mTLS ceritificate file

Authorizations:
KeyStoneAuth
path Parameters
sdpfTenantId
required
string
Example: d09c457e4ddb4acca2f15e1ce3db209d

maximum 64 Characters

axrossTenantId
required
string
Example: 12ee5389-de3b-4f76-9ba7-13a4b584d384

maximum 36 Characters

Request Body schema: multipart/form-data
file
object

backend mTLS ceritificate file(file format .p12 or .pfx). include filename.

keystoreAlias
string

backend mTLS keystore Alias. maximum 255 Characters.

password
string

backend mTLS certificate's password. between 6 and 16 Characters.

Responses

201

正常レスポンス

400

validationエラー

401

認証エラー

500

サーバエラー

post/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/keystores
https://api.ntt.com/apigw-x/v1/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/keystores

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "13ee5389-de3b-4f76-9ba7-13a4b584d384",
  • "keystoreName": "13ee5389-de3b-4f76-9ba7-13a4b584d385",
  • "keystoreAlias": "string",
  • "expiration": "2020-01-02T12:00:00.000Z",
  • "createDate": "2020-01-01T12:00:00.000Z"
}

Info for a specific keystoreId

Authorizations:
KeyStoneAuth
path Parameters
sdpfTenantId
required
string
Example: d09c457e4ddb4acca2f15e1ce3db209d

maximum 64 Characters

axrossTenantId
required
string
Example: 12ee5389-de3b-4f76-9ba7-13a4b584d384

maximum 36 Characters

keystoreId
required
string
Example: 12ee5389-de3b-4f76-9ba7-13a4b584d385

maximum 36 Characters

Responses

200

正常レスポンス

401

認証エラー

500

サーバエラー

get/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/keystores/{keystoreId}
https://api.ntt.com/apigw-x/v1/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/keystores/{keystoreId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "13ee5389-de3b-4f76-9ba7-13a4b584d384",
  • "keystoreName": "13ee5389-de3b-4f76-9ba7-13a4b584d385",
  • "keystoreAlias": "string",
  • "expiration": "2020-01-02T12:00:00.000Z",
  • "createDate": "2020-01-01T12:00:00.000Z"
}

Delete a specific of keystoreId

Authorizations:
KeyStoneAuth
path Parameters
sdpfTenantId
required
string
Example: d09c457e4ddb4acca2f15e1ce3db209d

maximum 64 Characters

axrossTenantId
required
string
Example: 12ee5389-de3b-4f76-9ba7-13a4b584d384

maximum 36 Characters

keystoreId
required
string
Example: 12ee5389-de3b-4f76-9ba7-13a4b584d385

maximum 36 Characters

Responses

200

正常

400

validationエラー

401

認証エラー

404

未存在エラー

500

サーバエラー

delete/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/keystores/{keystoreId}
https://api.ntt.com/apigw-x/v1/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/keystores/{keystoreId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "errorCode": "E010001",
  • "errorMessage": "string"
}

Info for all loggingId

Authorizations:
KeyStoneAuth
path Parameters
sdpfTenantId
required
string
Example: d09c457e4ddb4acca2f15e1ce3db209d

maximum 64 Characters

axrossTenantId
required
string
Example: 12ee5389-de3b-4f76-9ba7-13a4b584d384

maximum 36 Characters

Responses

200

正常レスポンス

401

認証エラー

500

サーバエラー

get/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/loggings
https://api.ntt.com/apigw-x/v1/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/loggings

Response samples

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

Create a loggingId

Authorizations:
KeyStoneAuth
path Parameters
sdpfTenantId
required
string
Example: d09c457e4ddb4acca2f15e1ce3db209d

maximum 64 Characters

axrossTenantId
required
string
Example: 12ee5389-de3b-4f76-9ba7-13a4b584d384

maximum 36 Characters

Request Body schema: application/json
bucket
string

backet for cloud storage service.

storageService
string

can Set (aws/gcp/azure/wasabi) to use for cloud storage service

storageEndpoint
string

storage endpoint for cloud storage service(only aws, wasabi).

accessKey
string

access key for cloud storage service.

secretAccessKey
string

secret access key for cloud storage service(only aws, wasabi).

Responses

201

正常レスポンス

400

validationエラー

401

認証エラー

500

サーバエラー

post/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/loggings
https://api.ntt.com/apigw-x/v1/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/loggings

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "bucket": "string",
  • "storageService": "string",
  • "storageEndpoint": "string",
  • "accessKey": "string",
  • "secretAccessKey": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "loggingId": "13ee5389-de3b-4f76-9ba7-13a4b584d384",
  • "bucket": "string",
  • "storageService": "string",
  • "storageEndpoint": "string",
  • "storageAccount": "string",
  • "storageUuid": "13ee5389-de3b-4f76-9ba7-13a4b584d384",
  • "createDate": "2020-01-01T12:00:00.000Z",
  • "deleteDate": "2020-01-01T12:00:00.000Z",
  • "lastUpdate": "2020-01-01T12:00:00.000Z",
  • "status": "string"
}

Info for a specific loggingId

Authorizations:
KeyStoneAuth
path Parameters
sdpfTenantId
required
string
Example: d09c457e4ddb4acca2f15e1ce3db209d

maximum 64 Characters

axrossTenantId
required
string
Example: 12ee5389-de3b-4f76-9ba7-13a4b584d384

maximum 36 Characters

loggingId
required
string
Example: 12ee5389-de3b-4f76-9ba7-13a4b584d384

maximum 36 Characters

Responses

200

正常レスポンス

401

認証エラー

500

サーバエラー

get/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/loggings/{loggingId}
https://api.ntt.com/apigw-x/v1/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/loggings/{loggingId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "loggingId": "13ee5389-de3b-4f76-9ba7-13a4b584d384",
  • "bucket": "string",
  • "storageService": "string",
  • "storageEndpoint": "string",
  • "storageAccount": "string",
  • "storageUuid": "13ee5389-de3b-4f76-9ba7-13a4b584d384",
  • "createDate": "2020-01-01T12:00:00.000Z",
  • "deleteDate": "2020-01-01T12:00:00.000Z",
  • "lastUpdate": "2020-01-01T12:00:00.000Z",
  • "status": "string",
  • "apiNames":
    [
    ]
}

Delete a specific of loggingId

Authorizations:
KeyStoneAuth
path Parameters
sdpfTenantId
required
string
Example: d09c457e4ddb4acca2f15e1ce3db209d

maximum 64 Characters

axrossTenantId
required
string
Example: 12ee5389-de3b-4f76-9ba7-13a4b584d384

maximum 36 Characters

loggingId
required
string
Example: 12ee5389-de3b-4f76-9ba7-13a4b584d384

maximum 36 Characters

Responses

200

正常

400

validationエラー

401

認証エラー

404

未存在エラー

500

サーバエラー

delete/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/loggings/{loggingId}
https://api.ntt.com/apigw-x/v1/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/loggings/{loggingId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "errorCode": "E010001",
  • "errorMessage": "string"
}

Update a specific of loggingId

Authorizations:
KeyStoneAuth
path Parameters
sdpfTenantId
required
string
Example: d09c457e4ddb4acca2f15e1ce3db209d

maximum 64 Characters

axrossTenantId
required
string
Example: 9aa309b4-cd14-41ed-bedb-952f90577f07

maximum 36 Characters

loggingId
required
string
Example: 12ee5389-de3b-4f76-9ba7-13a4b584d384

maximum 36 Characters

Request Body schema: application/json
storageEndpoint
string

storage endpoint for cloud storage service(only aws, wasabi).

accessKey
string

access key for cloud storage service.

secretAccessKey
string

secret access key for cloud storage service(only aws, wasabi).

activated
boolean

can Set (true/false) to use for activeted status by cloud storage service

apiNames
string

api Names to use cloud Storage Service for API logging

Responses

200

正常

put/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/loggings/{loggingId}
https://api.ntt.com/apigw-x/v1/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/loggings/{loggingId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "storageEndpoint": "string",
  • "accessKey": "string",
  • "secretAccessKey": "string",
  • "activated": true,
  • "apiNames":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "loggingId": "13ee5389-de3b-4f76-9ba7-13a4b584d384",
  • "bucket": "string",
  • "storageService": "string",
  • "storageEndpoint": "string",
  • "storageAccount": "string",
  • "storageUuid": "13ee5389-de3b-4f76-9ba7-13a4b584d384",
  • "createDate": "2020-01-01T12:00:00.000Z",
  • "deleteDate": "2020-01-01T12:00:00.000Z",
  • "lastUpdate": "2020-01-01T12:00:00.000Z",
  • "status": "string",
  • "apiNames":
    [
    ]
}

Info for apiName List to use loggingId

Authorizations:
KeyStoneAuth
path Parameters
sdpfTenantId
required
string
Example: d09c457e4ddb4acca2f15e1ce3db209d

maximum 64 Characters

axrossTenantId
required
string
Example: 12ee5389-de3b-4f76-9ba7-13a4b584d384

maximum 36 Characters

loggingId
required
string
Example: 12ee5389-de3b-4f76-9ba7-13a4b584d384

maximum 36 Characters

Responses

200

正常レスポンス

401

認証エラー

500

サーバエラー

get/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/loggings/{loggingId}/apis
https://api.ntt.com/apigw-x/v1/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/loggings/{loggingId}/apis

Response samples

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

Add apiName List to use loggingId

Authorizations:
KeyStoneAuth
path Parameters
sdpfTenantId
required
string
Example: d09c457e4ddb4acca2f15e1ce3db209d

maximum 64 Characters

axrossTenantId
required
string
Example: 12ee5389-de3b-4f76-9ba7-13a4b584d384

maximum 36 Characters

loggingId
required
string
Example: 12ee5389-de3b-4f76-9ba7-13a4b584d384

maximum 36 Characters

Request Body schema: application/json
apiName
any

maximum 50 Characters

Responses

201

正常レスポンス

400

validationエラー

401

認証エラー

500

サーバエラー

post/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/loggings/{loggingId}/apis
https://api.ntt.com/apigw-x/v1/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/loggings/{loggingId}/apis

Request samples

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

Response samples

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

Delete apiName List to use loggingId

Authorizations:
KeyStoneAuth
path Parameters
sdpfTenantId
required
string
Example: d09c457e4ddb4acca2f15e1ce3db209d

maximum 64 Characters

axrossTenantId
required
string
Example: 12ee5389-de3b-4f76-9ba7-13a4b584d384

maximum 36 Characters

loggingId
required
string
Example: 12ee5389-de3b-4f76-9ba7-13a4b584d384

maximum 36 Characters

apiName
required
string
Example: apiName1

maximum 50 Characters

Responses

200

正常

400

validationエラー

401

認証エラー

404

未存在エラー

500

サーバエラー

delete/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/loggings/{loggingId}/apis/{apiName}
https://api.ntt.com/apigw-x/v1/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/loggings/{loggingId}/apis/{apiName}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "errorCode": "E010001",
  • "errorMessage": "string"
}

Info for all accessRuleId

Authorizations:
KeyStoneAuth
path Parameters
sdpfTenantId
required
string
Example: d09c457e4ddb4acca2f15e1ce3db209d

maximum 64 Characters

axrossTenantId
required
string
Example: 12ee5389-de3b-4f76-9ba7-13a4b584d384

maximum 36 Characters

Responses

200

正常レスポンス

401

認証エラー

500

サーバエラー

get/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/accessRules
https://api.ntt.com/apigw-x/v1/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/accessRules

Response samples

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

Create a accessRuleId

Authorizations:
KeyStoneAuth
path Parameters
sdpfTenantId
required
string
Example: d09c457e4ddb4acca2f15e1ce3db209d

maximum 64 Characters

axrossTenantId
required
string
Example: 12ee5389-de3b-4f76-9ba7-13a4b584d384

maximum 36 Characters

Request Body schema: application/json
accessRuleName
string

maximum 32 Characters.

type
string

can Set (whiteList/blackList) to access Rule List Type

details
Array of objects (accessRuleDetailObject)
apiNames
string

api Names to use Access Rule

Responses

201

正常レスポンス

400

validationエラー

401

認証エラー

500

サーバエラー

post/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/accessRules
https://api.ntt.com/apigw-x/v1/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/accessRules

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "accessRuleName": "string",
  • "type": "string",
  • "details":
    [
    ],
  • "apiNames":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "accessRuleId": "13ee5389-de3b-4f76-9ba7-13a4b584d384",
  • "accessRuleName": "string",
  • "type": "string",
  • "createDate": "2020-01-01T12:00:00.000Z",
  • "deleteDate": "2020-01-01T12:00:00.000Z",
  • "lastUpdate": "2020-01-01T12:00:00.000Z",
  • "details":
    [
    ],
  • "apiNames":
    [
    ]
}

Info for a specific accessRuleId

Authorizations:
KeyStoneAuth
path Parameters
sdpfTenantId
required
string
Example: d09c457e4ddb4acca2f15e1ce3db209d

maximum 64 Characters

axrossTenantId
required
string
Example: 12ee5389-de3b-4f76-9ba7-13a4b584d384

maximum 36 Characters

accessRuleId
required
string
Example: 12ee5389-de3b-4f76-9ba7-13a4b584d384

maximum 36 Characters

Responses

200

正常レスポンス

401

認証エラー

500

サーバエラー

get/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/accessRules/{accessRuleId}
https://api.ntt.com/apigw-x/v1/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/accessRules/{accessRuleId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "accessRuleId": "13ee5389-de3b-4f76-9ba7-13a4b584d384",
  • "accessRuleName": "string",
  • "type": "string",
  • "createDate": "2020-01-01T12:00:00.000Z",
  • "deleteDate": "2020-01-01T12:00:00.000Z",
  • "lastUpdate": "2020-01-01T12:00:00.000Z",
  • "details":
    [
    ],
  • "apiNames":
    [
    ]
}

Delete a specific of accessRuleId

Authorizations:
KeyStoneAuth
path Parameters
sdpfTenantId
required
string
Example: d09c457e4ddb4acca2f15e1ce3db209d

maximum 64 Characters

axrossTenantId
required
string
Example: 12ee5389-de3b-4f76-9ba7-13a4b584d384

maximum 36 Characters

accessRuleId
required
string
Example: 12ee5389-de3b-4f76-9ba7-13a4b584d384

maximum 36 Characters

Responses

200

正常

400

validationエラー

401

認証エラー

404

未存在エラー

500

サーバエラー

delete/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/accessRules/{accessRuleId}
https://api.ntt.com/apigw-x/v1/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/accessRules/{accessRuleId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "errorCode": "E010001",
  • "errorMessage": "string"
}

Update a specific of accessRuleId

Authorizations:
KeyStoneAuth
path Parameters
sdpfTenantId
required
string
Example: d09c457e4ddb4acca2f15e1ce3db209d

maximum 64 Characters

axrossTenantId
required
string
Example: 9aa309b4-cd14-41ed-bedb-952f90577f07

maximum 36 Characters

accessRuleId
required
string
Example: 12ee5389-de3b-4f76-9ba7-13a4b584d384

maximum 36 Characters

Request Body schema: application/json
details
Array of objects (accessRuleDetailObject)
apiNames
string

api Names to use Access Rule

Responses

200

正常

put/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/accessRules/{accessRuleId}
https://api.ntt.com/apigw-x/v1/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/accessRules/{accessRuleId}

Request samples

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "accessRuleId": "13ee5389-de3b-4f76-9ba7-13a4b584d384",
  • "accessRuleName": "string",
  • "type": "string",
  • "createDate": "2020-01-01T12:00:00.000Z",
  • "deleteDate": "2020-01-01T12:00:00.000Z",
  • "lastUpdate": "2020-01-01T12:00:00.000Z",
  • "details":
    [
    ],
  • "apiNames":
    [
    ]
}

Info for all customHeaderId

Authorizations:
KeyStoneAuth
path Parameters
sdpfTenantId
required
string
Example: d09c457e4ddb4acca2f15e1ce3db209d

maximum 64 Characters

axrossTenantId
required
string
Example: 12ee5389-de3b-4f76-9ba7-13a4b584d384

maximum 36 Characters

Responses

200

正常レスポンス

401

認証エラー

500

サーバエラー

get/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/customHeaders
https://api.ntt.com/apigw-x/v1/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/customHeaders

Response samples

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

Create a customHeaderId

Authorizations:
KeyStoneAuth
path Parameters
sdpfTenantId
required
string
Example: d09c457e4ddb4acca2f15e1ce3db209d

maximum 64 Characters

axrossTenantId
required
string
Example: 12ee5389-de3b-4f76-9ba7-13a4b584d384

maximum 36 Characters

Request Body schema: application/json
customHeaderName
string

maximum 32 Characters.

details
Array of objects (customHeaderDetailObject)
apiNames
string

api Names to use Custom Header

Responses

201

正常レスポンス

400

validationエラー

401

認証エラー

500

サーバエラー

post/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/customHeaders
https://api.ntt.com/apigw-x/v1/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/customHeaders

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "customHeaderName": "string",
  • "details":
    [
    ],
  • "apiNames":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "customHeaderId": "13ee5389-de3b-4f76-9ba7-13a4b584d384",
  • "customHeaderName": "string",
  • "createDate": "2020-01-01T12:00:00.000Z",
  • "deleteDate": "2020-01-01T12:00:00.000Z",
  • "lastUpdate": "2020-01-01T12:00:00.000Z",
  • "details":
    [
    ],
  • "apiNames":
    [
    ]
}

Info for a specific customHeaderId

Authorizations:
KeyStoneAuth
path Parameters
sdpfTenantId
required
string
Example: d09c457e4ddb4acca2f15e1ce3db209d

maximum 64 Characters

axrossTenantId
required
string
Example: 12ee5389-de3b-4f76-9ba7-13a4b584d384

maximum 36 Characters

customHeaderId
required
string
Example: 12ee5389-de3b-4f76-9ba7-13a4b584d384

maximum 36 Characters

Responses

200

正常レスポンス

401

認証エラー

500

サーバエラー

get/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/customHeaders/{customHeaderId}
https://api.ntt.com/apigw-x/v1/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/customHeaders/{customHeaderId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "customHeaderId": "13ee5389-de3b-4f76-9ba7-13a4b584d384",
  • "customHeaderName": "string",
  • "createDate": "2020-01-01T12:00:00.000Z",
  • "deleteDate": "2020-01-01T12:00:00.000Z",
  • "lastUpdate": "2020-01-01T12:00:00.000Z",
  • "details":
    [
    ],
  • "apiNames":
    [
    ]
}

Delete a specific of customHeaderId

Authorizations:
KeyStoneAuth
path Parameters
sdpfTenantId
required
string
Example: d09c457e4ddb4acca2f15e1ce3db209d

maximum 64 Characters

axrossTenantId
required
string
Example: 12ee5389-de3b-4f76-9ba7-13a4b584d384

maximum 36 Characters

customHeaderId
required
string
Example: 12ee5389-de3b-4f76-9ba7-13a4b584d384

maximum 36 Characters

Responses

200

正常

400

validationエラー

401

認証エラー

404

未存在エラー

500

サーバエラー

delete/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/customHeaders/{customHeaderId}
https://api.ntt.com/apigw-x/v1/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/customHeaders/{customHeaderId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "errorCode": "E010001",
  • "errorMessage": "string"
}

Update a specific of customHeaderId

Authorizations:
KeyStoneAuth
path Parameters
sdpfTenantId
required
string
Example: d09c457e4ddb4acca2f15e1ce3db209d

maximum 64 Characters

axrossTenantId
required
string
Example: 9aa309b4-cd14-41ed-bedb-952f90577f07

maximum 36 Characters

customHeaderId
required
string
Example: 12ee5389-de3b-4f76-9ba7-13a4b584d384

maximum 36 Characters

Request Body schema: application/json
details
Array of objects (accessRuleDetailObject)
apiNames
string

api Names to use Custom Header

Responses

200

正常

put/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/customHeaders/{customHeaderId}
https://api.ntt.com/apigw-x/v1/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/customHeaders/{customHeaderId}

Request samples

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "customHeaderId": "13ee5389-de3b-4f76-9ba7-13a4b584d384",
  • "customHeaderName": "string",
  • "createDate": "2020-01-01T12:00:00.000Z",
  • "deleteDate": "2020-01-01T12:00:00.000Z",
  • "lastUpdate": "2020-01-01T12:00:00.000Z",
  • "details":
    [
    ],
  • "apiNames":
    [
    ]
}

Info for all apiEventId

Authorizations:
KeyStoneAuth
path Parameters
sdpfTenantId
required
string
Example: d09c457e4ddb4acca2f15e1ce3db209d

maximum 64 Characters

axrossTenantId
required
string
Example: 12ee5389-de3b-4f76-9ba7-13a4b584d384

maximum 36 Characters

Responses

200

正常レスポンス

401

認証エラー

500

サーバエラー

get/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/events
https://api.ntt.com/apigw-x/v1/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/events

Response samples

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

Create a apiEventId

Authorizations:
KeyStoneAuth
path Parameters
sdpfTenantId
required
string
Example: d09c457e4ddb4acca2f15e1ce3db209d

maximum 64 Characters

axrossTenantId
required
string
Example: 12ee5389-de3b-4f76-9ba7-13a4b584d384

maximum 36 Characters

Request Body schema: application/json
eventName
string

maximum 32 Characters.

startTime
string <date-time>

Event Start Time.Time Zone is UTC.

endTime
string <date-time>

Event End Time.Time Zone is UTC.

Responses

201

正常レスポンス

400

validationエラー

401

認証エラー

500

サーバエラー

post/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/events
https://api.ntt.com/apigw-x/v1/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/events

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "eventName": "string",
  • "startTime": "2020-01-01T12:00:00.000Z",
  • "endTime": "2020-01-01T12:00:00.000Z"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "apiEventId": "13ee5389-de3b-4f76-9ba7-13a4b584d384",
  • "eventName": "string",
  • "createDate": "2020-01-01T12:00:00.000Z",
  • "deleteDate": "2020-01-01T12:00:00.000Z",
  • "lastUpdate": "2020-01-01T12:00:00.000Z",
  • "startTime": "2020-01-01T12:00:00.000Z",
  • "endTime": "2020-01-01T12:00:00.000Z",
  • "status": "string",
  • "apiNames":
    [
    ]
}

Info for a specific apiEventId

Authorizations:
KeyStoneAuth
path Parameters
sdpfTenantId
required
string
Example: d09c457e4ddb4acca2f15e1ce3db209d

maximum 64 Characters

axrossTenantId
required
string
Example: 12ee5389-de3b-4f76-9ba7-13a4b584d384

maximum 36 Characters

apiEventId
required
string
Example: 12ee5389-de3b-4f76-9ba7-13a4b584d384

maximum 36 Characters

Responses

200

正常レスポンス

401

認証エラー

500

サーバエラー

get/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/events/{apiEventId}
https://api.ntt.com/apigw-x/v1/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/events/{apiEventId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "apiEventId": "13ee5389-de3b-4f76-9ba7-13a4b584d384",
  • "eventName": "string",
  • "createDate": "2020-01-01T12:00:00.000Z",
  • "deleteDate": "2020-01-01T12:00:00.000Z",
  • "lastUpdate": "2020-01-01T12:00:00.000Z",
  • "startTime": "2020-01-01T12:00:00.000Z",
  • "endTime": "2020-01-01T12:00:00.000Z",
  • "status": "string",
  • "apiNames":
    [
    ]
}

Delete a specific of apiEventId

Authorizations:
KeyStoneAuth
path Parameters
sdpfTenantId
required
string
Example: d09c457e4ddb4acca2f15e1ce3db209d

maximum 64 Characters

axrossTenantId
required
string
Example: 12ee5389-de3b-4f76-9ba7-13a4b584d384

maximum 36 Characters

apiEventId
required
string
Example: 12ee5389-de3b-4f76-9ba7-13a4b584d384

maximum 36 Characters

Responses

200

正常

400

validationエラー

401

認証エラー

404

未存在エラー

500

サーバエラー

delete/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/events/{apiEventId}
https://api.ntt.com/apigw-x/v1/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/events/{apiEventId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "errorCode": "E010001",
  • "errorMessage": "string"
}

Update a specific of apiEventId

Authorizations:
KeyStoneAuth
path Parameters
sdpfTenantId
required
string
Example: d09c457e4ddb4acca2f15e1ce3db209d

maximum 64 Characters

axrossTenantId
required
string
Example: 9aa309b4-cd14-41ed-bedb-952f90577f07

maximum 36 Characters

apiEventId
required
string
Example: 12ee5389-de3b-4f76-9ba7-13a4b584d384

maximum 36 Characters

Request Body schema: application/json
startTime
string <date-time>

Event Start Time.Time Zone is UTC.

endTime
string <date-time>

Event End Time.Time Zone is UTC.

status
string

can Set (NORMAL/STOP) to use for status by API Event Job

Responses

200

正常

put/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/events/{apiEventId}
https://api.ntt.com/apigw-x/v1/sdpfTenants/{sdpfTenantId}/axrossTenants/{axrossTenantId}/events/{apiEventId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "startTime": "2020-01-01T12:00:00.000Z",
  • "endTime": "2020-01-01T12:00:00.000Z",
  • "status": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "apiEventId": "13ee5389-de3b-4f76-9ba7-13a4b584d384",
  • "eventName": "string",
  • "createDate": "2020-01-01T12:00:00.000Z",
  • "deleteDate": "2020-01-01T12:00:00.000Z",
  • "lastUpdate": "2020-01-01T12:00:00.000Z",
  • "startTime": "2020-01-01T12:00:00.000Z",
  • "endTime": "2020-01-01T12:00:00.000Z",
  • "status": "string",
  • "apiNames":
    [
    ]
}