Wasabi Gateway API Reference (v2.0)
Download OpenAPI specification:Download
apiToken
Please refer to https://sdpf.ntt.com/about-sss/api-references/first-step/ for instructions on obtaining the authentication token.
Security Scheme Type | API Key |
---|---|
Header parameter name: | X-Auth-Token |
List Wasabi Gateways
Authorizations:
query Parameters
common_function_gateway_id | string <uuid> The Common Function Gateway ID to associate with this Wasabi Gateway |
description | string Description of the Wasabi Gateway resource |
id | string Unique ID of the Wasabi Gateway resource |
name | string Name of the Wasabi Gateway resource |
status | string Enum: "ACTIVE" "DOWN" "PENDING_CREATE" "PENDING_UPDATE" "PENDING_DELETE" "MONITORING_UNAVAILABLE" "ERROR" The Wasabi Gateway status |
tenant_id | string <uuid> Tenant ID of the owner (UUID) |
Responses
OK
Bad Request (400)
Unauthorized (401)
Not Found (404)
Internal Server Error (500)
JP7 Region
JP8 Region
JP9 Region
Response samples
- 200
- 400
- 401
- 404
- 500
{- "wasabi_gateways": [
- {
- "common_function_gateway_id": "string",
- "description": "",
- "id": "string",
- "name": "jp7-test-member-user-wasabi-gateway",
- "status": "ACTIVE",
- "tenant_id": "string"
}
]
}
Create Wasabi Gateway
Authorizations:
Request Body schema: application/json
wasabi_gateway | object (WasabiGatewayCreate) |
Responses
Created
Bad Request (400)
Unauthorized (401)
Not Found (404)
Conflict (409)
Internal Server Error (500)
JP7 Region
JP8 Region
JP9 Region
Request samples
- Payload
{- "wasabi_gateway": {
- "common_function_gateway_id": "44c60703-b879-4758-9ddc-13a4cdc430d2",
- "description": "",
- "name": "jp7-test-member-user-wasabi-gateway",
- "tenant_id": "string"
}
}
Response samples
- 201
- 400
- 401
- 404
- 409
- 500
{- "wasabi_gateway": {
- "common_function_gateway_id": "string",
- "description": "",
- "id": "string",
- "name": "jp7-test-member-user-wasabi-gateway",
- "status": "ACTIVE",
- "tenant_id": "string"
}
}
Show Wasabi Gateway
Authorizations:
path Parameters
wasabi_gateway_id required | string <uuid> |
Responses
OK
Bad Request (400)
Unauthorized (401)
Not Found (404)
Internal Server Error (500)
JP7 Region
JP8 Region
JP9 Region
Response samples
- 200
- 400
- 401
- 404
- 500
{- "wasabi_gateway": {
- "common_function_gateway_id": "string",
- "description": "",
- "id": "string",
- "name": "jp7-test-member-user-wasabi-gateway",
- "status": "ACTIVE",
- "tenant_id": "string"
}
}
Update Wasabi Gateway
Authorizations:
path Parameters
wasabi_gateway_id required | string <uuid> |
Request Body schema: application/json
wasabi_gateway required | object (WasabiGatewayUpdate) |
Responses
OK
Bad Request (400)
Unauthorized (401)
Not Found (404)
Conflict (409)
Internal Server Error (500)
JP7 Region
JP8 Region
JP9 Region
Request samples
- Payload
{- "wasabi_gateway": {
- "description": "",
- "name": "jp7-test-member-user-wasabi-gateway"
}
}
Response samples
- 200
- 400
- 401
- 404
- 409
- 500
{- "wasabi_gateway": {
- "common_function_gateway_id": "string",
- "description": "",
- "id": "string",
- "name": "jp7-test-member-user-wasabi-gateway",
- "status": "ACTIVE",
- "tenant_id": "string"
}
}
Delete Wasabi Gateway
Authorizations:
path Parameters
wasabi_gateway_id required | string <uuid> |
Responses
No Content (204)
Bad Request (400)
Unauthorized (401)
Not Found (404)
Conflict (409)
Internal Server Error (500)
JP7 Region
JP8 Region
JP9 Region
Response samples
- 400
- 401
- 404
- 409
- 500
{- "error": "string"
}