API Gateway

Overview

Provides an Application Programming Interface (API) that supports programmatic use of IaaS/PaaS products provided by SCP.

This guide provides a brief description of API Gateway service and how to call API. The API is provided as a RESTful API, and it responds in JSON format.

Version

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

OpenAPI URL

https://apigateway.{region}.{environment}.samsungsdscloud.com

Environment and Region List

API Version History

1.3

The Resource‑Policy feature has been added.
The response of the List Resources API has been changed.
The response of the Get Resource API has been changed.
The response of the List Methods API has been changed.
The request of the Create Method API has been changed.
The request of the Set Method API has been changed.
The response of the Get Method API has been changed.
The response of the List Stages API has been changed.
The response of the Get Stage API has been changed.

Changes

• [New] GET /apis/{api_id}/resource-policies - Show Resource Policy API has been added.
• [New] PUT /apis/{api_id}/resource-policies - Set Resource Policy API has been added.
• [New] DELETE /apis/{api_id}/resource-policies - Delete Resource Policy API has been added.
• [Updated] GET /apis/{api_id}/resources - The following field has been added to the response.
  • iam_enabled
• [Updated] GET /apis/{api_id}/resources/{resource_id} - The following field has been added to the response.
  • iam_enabled
• [Updated] GET /apis/{api_id}/resources/{resource_id}/methods - The following field has been added to the response.
  • iam_enabled
• [Updated] POST /apis/{api_id}/resources/{resource_id}/methods - The following field has been added to the request.
  • iam_enabled
• [Updated] PUT /apis/{api_id}/resources/{resource_id}/methods/{method_type} - The following field has been added to the request.
  • iam_enabled
• [Updated] GET /apis/{api_id}/resources/{resource_id}/methods/{method_type} - The following field has been added to the response.
  • iam_enabled
• [Updated] GET /apis/{api_id}/stages - The following field has been added to the response.
  • description
  • api_key_required
  • usage_plan_name
  • uesage_plan_id
  • usage_plan_rate
  • usage_plan_limit
  • usage_plan_api_keys
• [Updated] GET /apis/{api_id}/stages - The following field has been removed to the response.
  • api_key_required
• [Updated] GET /apis/{api_id}/stages - The following field has been changed to the response.
  • Before "methods": [{"type": GET", "api_key_required": true}]
  • After "methods": [{"type": GET", "api_key_required": true, "iam_enabled": true}]
• [Updated] GET /apis/{api_id}/stages/{stage_name} - The following field has been removed to the response.
  • api_key_required

1.2

The PrivateLink feature has been added.
The response of the List APIs API has been changed.
The request of the Create APi API has been changed.
The response of the Get APi API has been changed.
The response of the List Resources API has been changed.
The response of the Get Resource API has been changed.
The response of the List Methods API has been changed.
The request of the Create Method API has been changed.
The request of the Set Method API has been changed.
The response of the Get Method API has been changed.

Changes

• [New] GET /apis/{api_id}/connected-endpoints - List Connected PrivateLink Endpoints API has been added.
• [New] GET /privatelink-endpoints - List PrivateLink Endpoints API has been added.
• [New] POST /privatelink-endpoints - Create PrivateLink Endpoint API has been added.
• [New] DELETE /privatelink-endpoints/{privatelink_endpoint_id} - Delete PrivateLink Endpoint API has been added.
• [New] PUT /privatelink-endpoints/{privatelink_endpoint_id} - Set PrivateLink Endpoint API has been added.
• [New] PUT /privatelink-endpoints/{privatelink_endpoint_id}/approval - Approve PrivateLink Endpoint API has been added.
• [New] PUT /privatelink-endpoints/{privatelink_endpoint_id}/connection - Connect PrivateLink Endpoint API has been added.
• [New] PUT /privatelink-endpoints/{privatelink_endpoint_id}/request - Request PrivateLink Endpoint API has been added.
• [New] GET /privatelink-endpoints/{privatelink_endpoint_id} - Show PrivateLink Endpoint API has been added.
• [Updated] GET /apis - The following field has been added to the response.
  • endpoint_type
• [Updated] POST /apis - The following field has been added to the request.
  • endpoint_type
• [Updated] GET /apis/{api_id} - The following field has been added to the response.
  • endpoint_type
  • privatelink_service_id
• [Updated] GET /apis/{api_id}/resources - The following field has been added to the response.
  • privatelink_endpoint_id
• [Updated] GET /apis/{api_id}/resources/{resource_id} - The following field has been added to the response.
  • privatelink_endpoint_id
• [Updated] GET /apis/{api_id}/resources/{resource_id}/methods - The following field has been added to the response.
  • privatelink_endpoint_id
• [Updated] POST /apis/{api_id}/resources/{resource_id}/methods - The following field has been added to the request.
  • privatelink_endpoint_id
• [Updated] PUT /apis/{api_id}/resources/{resource_id}/methods/{method_type} - The following field has been added to the request.
  • privatelink_endpoint_id
• [Updated] GET /apis/{api_id}/resources/{resource_id}/methods/{method_type} - The following field has been added to the response.
  • privatelink_endpoint_id

1.1

The Usage‑Policy feature has been added.
The API‑Key Management feature has been added.
The Report feature has been added.
The response of the List Resources API has been changed.
The response of the Get Resource API has been changed.
The response of the List Methods API has been changed.
The request of the Create Method API has been changed.
The request of the Set Method API has been changed.
The response of the Get Method API has been changed.
The response of the List Stages API has been changed.
The request of the Set Stage Configuration API has been changed.
The response of the Get Stage API has been changed.

Changes

• [New] GET /apis/{api_id}/usage-palns - List Usage Plans API has been added.
• [New] POST /apis/{api_id}/usage-palns - Create Usage Plan API has been added.
• [New] PUT /apis/{api_id}/usage-plans/{usage_plan_id}/description - Set Usage Plan Description API has been added.
• [New] PUT /apis/{api_id}/usage-plans/{usage_plan_id}/quota - Set Usage Plan Quota API has been added.
• [New] DELETE /apis/{api_id}/usage-plans/{usage_plan_id} - Delete Usage Plan API has been added.
• [New] GET /apis/{api_id}/usage-plans/{usage_plan_id} - Show Usage Plan API has been added.
• [New] GET /apis/{api_id}/usage-palns/{usage_plan_id}/api-keys - List Api Keys API has been added.
• [New] POST /apis/{api_id}/usage-palns/{usage_plan_id}/api-keys - Create APi Key API has been added.
• [New] PUT /apis/{api_id}/usage-plans/{usage_plan_id}/api-keys/{api_key_id}/description - Set Api Key Description API has been added.
• [New] DELETE /apis/{api_id}/usage-plans/{usage_plan_id}/api-keys/{api_key_id} - Delete Api Key API has been added.
• [New] GET /apis/{api_id}/reports - List Reports API has been added.
• [Updated] GET /apis/{api_id}/resources - The following field has been added to the response.
  • function_name
  • api_key_required
• [Updated] GET /apis/{api_id}/resources/{resource_id} - The following field has been added to the response.
  • function_name
  • api_key_required
• [Updated] GET /apis/{api_id}/resources/{resource_id}/methods - The following field has been added to the response.
  • function_name
  • api_key_required
• [Updated] POST /apis/{api_id}/resources/{resource_id}/methods - The following field has been added to the request.
  • api_key_required
• [Updated] PUT /apis/{api_id}/resources/{resource_id}/methods/{method_type} - The following field has been added to the request.
  • api_key_required
  • endpoint_url
  • function_id
  • integration_type
• [Updated] GET /apis/{api_id}/resources/{resource_id}/methods/{method_type} - The following field has been added to the response.
  • function_name
  • api_key_required
• [Updated] GET /apis/{api_id}/stages - The following field has been added to the response.
  • description
  • api_key_required
  • usage_plan_name
  • uesage_plan_id
  • usage_plan_rate
  • usage_plan_limit
  • usage_plan_api_keys
• [Updated] GET /apis/{api_id}/stages - The following field has been removed to the response.
  • ip_restriction_enabled
• [Updated] GET /apis/{api_id}/stages - The following field has been changed to the response.
  • Before "methods": ["GET", "POST"]
  • After "methods": [{"type": GET", "api_key_required": true}]
• [Updated] PUT /apis/{api_id}/stages/{stage_name}/config - The following field has been added to the request.
  • description
  • usage_plan_id
  • connected_api_keys
• [Updated] PUT /apis/{api_id}/stages/{stage_name}/config - The following field has been removed to the request.
  • ip_restriction_enabled
• [Updated] GET /apis/{api_id}/stages/{stage_name} - The following field has been added to the response.
  • description
  • api_key_required
  • usage_plan_name
  • uesage_plan_id
  • usage_plan_rate
  • usage_plan_limit
  • usage_plan_api_keys
• [Updated] GET /apis/{api_id}/stages/{stage_name} - The following field has been removed to the response.
  • ip_restriction_enabled

1.0

Initial API release for API Gateway

Changes

• [New] GET /apis - List APis API has been added.
• [New] POST /apis - Create Api API has been added.
• [New] PUT /apis/{api_id}/description - Set Api Description API has been added.
• [New] DELETE /apis/{api_id} - Delete Api API has been added.
• [New] GET /apis/{api_id} - Show Api API has been added.
• [New] GET /apis/{api_id}/deployments - List Api Deployments API has been added.
• [New] POST /apis/{api_id}/deployments - Create Api Deployment API has been added.
• [New] GET /apis/{api_id}/resources - List Resources API has been added.
• [New] POST /apis/{api_id}/resources/{parent_id} - Create Resource API has been added.
• [New] DELETE /apis/{api_id}/resources/{resource_id} - Delete Resource API has been added.
• [New] GET /apis/{api_id}/resources/{resource_id} - Show Resource API has been added.
• [New] GET /apis/{api_id}/resources/{resource_id}/methods - List Methods API has been added.
• [New] POST /apis/{api_id}/resources/{resource_id}/methods - Create Method API has been added.
• [New] PUT /apis/{api_id}/resources/{resource_id}/methods/{method_type} - Set Method API has been added.
• [New] DELETE /apis/{api_id}/resources/{resource_id}/methods/{method_type} - Delete Method API has been added.
• [New] GET /apis/{api_id}/resources/{resource_id}/methods/{method_type} - Show Method API has been added.
• [New] GET /apis/{api_id}/stages - List Stages API has been added.
• [New] POST /apis/{api_id}/stages - Create Stage API has been added.
• [New] DELETE /apis/{api_id}/stages/{stage_name} - Delete Stage API has been added.
• [New] GET /apis/{api_id}/stages/{stage_name} - Show Stage API has been added.
• [New] PUT /apis/{api_id}/stages/{stage_name}/deployment - Set Stage Active Deployment API has been added.
• [New] PUT /apis/{api_id}/stages/{stage_name}/config - Set Stage Configuration API has been added.
• [New] GET /apis/{api_id}/auths - List Auths API has been added.
• [New] POST /apis/{api_id}/auths - Create Auth API has been added.
• [New] PUT /apis/{api_id}/auths/{auth_id} - Set Auth API has been added.
• [New] DELETE /apis/{api_id}/auths/{auth_id} - Delete Auth API has been added.
• [New] GET /apis/{api_id}/auths/{auth_id} - Show Auth API has been added.
• [New] GET /apis/{api_id}/access-controls - List AccessControls API has been added.
• [New] POST /apis/{api_id}/access-controls - Create AccessControl API has been added.
• [New] PUT /apis/{api_id}/access-controls/{access_control_id} - Set AccessControl API has been added.
• [New] DELETE /apis/{api_id}/access-controls/{access_control_id} - Delete AccessControl API has been added.
• [New] GET /apis/{api_id}/access-controls/{access_control_id} - Show AccessControl API has been added.