# This is an automatically generated code sample.
# To make this code sample work in your Oracle Cloud tenancy,
# please replace the values for any parameters whose current values do not fit
# your use case (such as resource IDs, strings containing ‘EXAMPLE’ or ‘unique_id’, and
# boolean, number, and enum parameters with values not fitting your use case).
require 'oci'
# Create a default config using DEFAULT profile in default location
# Refer to https://docs.cloud.oracle.com/en-us/iaas/Content/API/Concepts/sdkconfig.htm#SDK_and_CLI_Configuration_File for more info
config = OCI::ConfigFileLoader.load_config
# Initialize service client with default config file
apigateway_client = OCI::Apigateway::DeploymentClient.new(config: config)
# Send the request to service, some parameters are not required, see API doc for more info
create_deployment_response =
apigateway_client.create_deployment(
OCI::Apigateway::Models::CreateDeploymentDetails.new(
gateway_id: 'ocid1.test.oc1..<unique_ID>EXAMPLE-gatewayId-Value',
compartment_id: 'ocid1.test.oc1..<unique_ID>EXAMPLE-compartmentId-Value',
path_prefix: 'EXAMPLE-pathPrefix-Value',
specification:
OCI::Apigateway::Models::ApiSpecification.new(
request_policies:
OCI::Apigateway::Models::ApiSpecificationRequestPolicies.new(
authentication:
OCI::Apigateway::Models::CustomAuthenticationPolicy.new(
type: 'CUSTOM_AUTHENTICATION',
function_id:
'ocid1.test.oc1..<unique_ID>EXAMPLE-functionId-Value',
is_anonymous_access_allowed: true,
token_header: 'EXAMPLE-tokenHeader-Value',
token_query_param: 'EXAMPLE-tokenQueryParam-Value',
parameters: {
'EXAMPLE_KEY_uTdR1' => 'EXAMPLE_VALUE_Dk1SpZEvNAeZBPWvFJy2'
},
cache_key: %w[EXAMPLE--Value],
validation_failure_policy:
OCI::Apigateway::Models::OAuth2ResponseValidationFailurePolicy
.new(
type: 'OAUTH2',
client_details:
OCI::Apigateway::Models::CustomClientAppDetails.new(
type: 'CUSTOM',
client_id:
'ocid1.test.oc1..<unique_ID>EXAMPLE-clientId-Value',
client_secret_id:
'ocid1.test.oc1..<unique_ID>EXAMPLE-clientSecretId-Value',
client_secret_version_number: 105
),
source_uri_details:
OCI::Apigateway::Models::ValidationBlockSourceUriDetails
.new(type: 'VALIDATION_BLOCK'),
scopes: %w[EXAMPLE--Value],
response_type: 'CODE',
max_expiry_duration_in_hours: 5,
use_cookies_for_session: false,
use_cookies_for_intermediate_steps: false,
use_pkce: false,
fallback_redirect_path:
'EXAMPLE-fallbackRedirectPath-Value',
logout_path: 'EXAMPLE-logoutPath-Value',
login_path: 'EXAMPLE-loginPath-Value'
)
),
rate_limiting:
OCI::Apigateway::Models::RateLimitingPolicy.new(
rate_in_requests_per_second: 348, rate_key: 'CLIENT_IP'
),
cors:
OCI::Apigateway::Models::CorsPolicy.new(
allowed_origins: %w[EXAMPLE--Value],
allowed_methods: %w[EXAMPLE--Value],
allowed_headers: %w[EXAMPLE--Value],
exposed_headers: %w[EXAMPLE--Value],
is_allow_credentials_enabled: true,
max_age_in_seconds: 381
),
mutual_tls:
OCI::Apigateway::Models::MutualTlsDetails.new(
is_verified_certificate_required: false,
allowed_sans: %w[EXAMPLE--Value]
),
usage_plans:
OCI::Apigateway::Models::UsagePlansPolicy.new(
token_locations: %w[EXAMPLE--Value]
),
dynamic_authentication:
OCI::Apigateway::Models::DynamicAuthenticationPolicy.new(
selection_source:
OCI::Apigateway::Models::SingleSelectionSourcePolicy.new(
type: 'SINGLE', selector: 'EXAMPLE-selector-Value'
),
authentication_servers: [
OCI::Apigateway::Models::AuthenticationServerPolicy.new(
key:
OCI::Apigateway::Models::WildcardSelectionKey.new(
type: 'WILDCARD',
name: 'EXAMPLE-name-Value',
expression: 'EXAMPLE-expression-Value',
is_default: false
),
authentication_server_detail:
OCI::Apigateway::Models::CustomAuthenticationPolicy.new(
type: 'CUSTOM_AUTHENTICATION',
function_id:
'ocid1.test.oc1..<unique_ID>EXAMPLE-functionId-Value',
is_anonymous_access_allowed: false,
token_header: 'EXAMPLE-tokenHeader-Value',
token_query_param: 'EXAMPLE-tokenQueryParam-Value',
parameters: {
'EXAMPLE_KEY_A9r5W' =>
'EXAMPLE_VALUE_5nVqpWEUQywPe6YRVy6w'
},
cache_key: %w[EXAMPLE--Value],
validation_failure_policy:
OCI::Apigateway::Models::ModifyResponseValidationFailurePolicy
.new(
type: 'MODIFY_RESPONSE',
response_code: 'EXAMPLE-responseCode-Value',
response_message: 'EXAMPLE-responseMessage-Value',
response_header_transformations:
OCI::Apigateway::Models::HeaderTransformationPolicy
.new(
set_headers:
OCI::Apigateway::Models::SetHeaderPolicy
.new(
items: [
OCI::Apigateway::Models::SetHeaderPolicyItem
.new(
name: 'EXAMPLE-name-Value',
values: %w[EXAMPLE--Value],
if_exists: 'OVERWRITE'
)
]
),
rename_headers:
OCI::Apigateway::Models::RenameHeaderPolicy
.new(
items: [
OCI::Apigateway::Models::RenameHeaderPolicyItem
.new(
_from: 'EXAMPLE-from-Value',
to: 'EXAMPLE-to-Value'
)
]
),
filter_headers:
OCI::Apigateway::Models::FilterHeaderPolicy
.new(
type: 'ALLOW',
items: [
OCI::Apigateway::Models::FilterHeaderPolicyItem
.new(name: 'EXAMPLE-name-Value')
]
)
)
)
)
)
]
)
),
logging_policies:
OCI::Apigateway::Models::ApiSpecificationLoggingPolicies.new(
access_log:
OCI::Apigateway::Models::AccessLogPolicy.new(is_enabled: false),
execution_log:
OCI::Apigateway::Models::ExecutionLogPolicy.new(
is_enabled: false, log_level: 'ERROR'
)
),
routes: [
OCI::Apigateway::Models::ApiSpecificationRoute.new(
path: 'EXAMPLE-path-Value',
backend:
OCI::Apigateway::Models::OAuth2LogoutBackend.new(
type: 'OAUTH2_LOGOUT_BACKEND',
allowed_post_logout_uris: %w[EXAMPLE--Value],
post_logout_state: 'EXAMPLE-postLogoutState-Value'
),
methods: %w[OPTIONS],
request_policies:
OCI::Apigateway::Models::ApiSpecificationRouteRequestPolicies
.new(
authorization:
OCI::Apigateway::Models::AnyOfRouteAuthorizationPolicy.new(
type: 'ANY_OF', allowed_scope: %w[EXAMPLE--Value]
),
cors:
OCI::Apigateway::Models::CorsPolicy.new(
allowed_origins: %w[EXAMPLE--Value],
allowed_methods: %w[EXAMPLE--Value],
allowed_headers: %w[EXAMPLE--Value],
exposed_headers: %w[EXAMPLE--Value],
is_allow_credentials_enabled: false,
max_age_in_seconds: 289
),
query_parameter_validations:
OCI::Apigateway::Models::QueryParameterValidationRequestPolicy
.new(
parameters: [
OCI::Apigateway::Models::QueryParameterValidationItem
.new(name: 'EXAMPLE-name-Value', required: true)
],
validation_mode: 'PERMISSIVE'
),
header_validations:
OCI::Apigateway::Models::HeaderValidationRequestPolicy.new(
headers: [
OCI::Apigateway::Models::HeaderValidationItem.new(
name: 'EXAMPLE-name-Value', required: true
)
],
validation_mode: 'ENFORCING'
),
body_validation:
OCI::Apigateway::Models::BodyValidationRequestPolicy.new(
content: {
'EXAMPLE_KEY_X2IQF' => { 'validationType' => 'NONE' }
},
required: false,
validation_mode: 'DISABLED'
),
header_transformations:
OCI::Apigateway::Models::HeaderTransformationPolicy.new(
set_headers:
OCI::Apigateway::Models::SetHeaderPolicy.new(
items: [
OCI::Apigateway::Models::SetHeaderPolicyItem.new(
name: 'EXAMPLE-name-Value',
values: %w[EXAMPLE--Value],
if_exists: 'SKIP'
)
]
),
rename_headers:
OCI::Apigateway::Models::RenameHeaderPolicy.new(
items: [
OCI::Apigateway::Models::RenameHeaderPolicyItem.new(
_from: 'EXAMPLE-from-Value',
to: 'EXAMPLE-to-Value'
)
]
),
filter_headers:
OCI::Apigateway::Models::FilterHeaderPolicy.new(
type: 'ALLOW',
items: [
OCI::Apigateway::Models::FilterHeaderPolicyItem.new(
name: 'EXAMPLE-name-Value'
)
]
)
),
query_parameter_transformations:
OCI::Apigateway::Models::QueryParameterTransformationPolicy
.new(
set_query_parameters:
OCI::Apigateway::Models::SetQueryParameterPolicy.new(
items: [
OCI::Apigateway::Models::SetQueryParameterPolicyItem
.new(
name: 'EXAMPLE-name-Value',
values: %w[EXAMPLE--Value],
if_exists: 'OVERWRITE'
)
]
),
rename_query_parameters:
OCI::Apigateway::Models::RenameQueryParameterPolicy.new(
items: [
OCI::Apigateway::Models::RenameQueryParameterPolicyItem
.new(
_from: 'EXAMPLE-from-Value',
to: 'EXAMPLE-to-Value'
)
]
),
filter_query_parameters:
OCI::Apigateway::Models::FilterQueryParameterPolicy.new(
type: 'BLOCK',
items: [
OCI::Apigateway::Models::FilterQueryParameterPolicyItem
.new(name: 'EXAMPLE-name-Value')
]
)
),
response_cache_lookup:
OCI::Apigateway::Models::SimpleLookupPolicy.new(
type: 'SIMPLE_LOOKUP_POLICY',
is_enabled: false,
is_private_caching_enabled: false,
cache_key_additions: %w[EXAMPLE--Value]
)
),
response_policies:
OCI::Apigateway::Models::ApiSpecificationRouteResponsePolicies
.new(
header_transformations:
OCI::Apigateway::Models::HeaderTransformationPolicy.new(
set_headers:
OCI::Apigateway::Models::SetHeaderPolicy.new(
items: [
OCI::Apigateway::Models::SetHeaderPolicyItem.new(
name: 'EXAMPLE-name-Value',
values: %w[EXAMPLE--Value],
if_exists: 'SKIP'
)
]
),
rename_headers:
OCI::Apigateway::Models::RenameHeaderPolicy.new(
items: [
OCI::Apigateway::Models::RenameHeaderPolicyItem.new(
_from: 'EXAMPLE-from-Value',
to: 'EXAMPLE-to-Value'
)
]
),
filter_headers:
OCI::Apigateway::Models::FilterHeaderPolicy.new(
type: 'BLOCK',
items: [
OCI::Apigateway::Models::FilterHeaderPolicyItem.new(
name: 'EXAMPLE-name-Value'
)
]
)
),
response_cache_store:
OCI::Apigateway::Models::FixedTTLResponseCacheStorePolicy
.new(
type: 'FIXED_TTL_STORE_POLICY',
time_to_live_in_seconds: 626
)
),
logging_policies:
OCI::Apigateway::Models::ApiSpecificationLoggingPolicies.new(
access_log:
OCI::Apigateway::Models::AccessLogPolicy.new(
is_enabled: false
),
execution_log:
OCI::Apigateway::Models::ExecutionLogPolicy.new(
is_enabled: true, log_level: 'ERROR'
)
)
)
]
),
display_name: 'EXAMPLE-displayName-Value',
locks: [
OCI::Apigateway::Models::AddResourceLockDetails.new(
type: 'DELETE', message: 'EXAMPLE-message-Value'
)
],
freeform_tags: {
'EXAMPLE_KEY_Yw2ry' => 'EXAMPLE_VALUE_hM27W2cSR62NOCEQUXVC'
},
defined_tags: {
'EXAMPLE_KEY_Ox8zx' => { 'EXAMPLE_KEY_HMo2p' => 'EXAMPLE--Value' }
}
)
)
# Get the data from response
puts "#{create_deployment_response.data}"