Configuring Environment Specific Parameters¶
To allow easily configuring environment-specific details when there are multiple environments, ESB API Controller (apictl) supports an additional parameter file (will be referred to as the "parameters file" in this document) or an additional directory to store these deployment-related artifacts. It is recommended to store the parameters file inside the deployment directory if there are certificates and other details included. However, it can be stored somewhere else when certificates are not specified via this parameters file.
Generating the Deployment Directory¶
When there are multiple artifacts which needs to be added as deployment-related configurations, it is recommended to use a separate directory to store all these configurations. apictl provides the support to generate this deployment-specific directory using the following commands.
-
Command
apictl gen deployment-dir -s <path-to-source-directory-or-archive>apictl gen deployment-dir -s <path-to-source-directory-or-archive> -d <path-to-create-the-deployment-directory>apictl gen deployment-dir --source <path-to-source-directory-or-archive>apictl gen deployment-dir --source <path-to-source-directory-or-archive> --destination <path-to-create-the-deployment-directory>Info
Flags:
- Required :
--sourceor-s: File path of the source artifact to be used when generating the deployment directory. - Optional :
--destinationor-d: Path of the directory where the new deployment directory should be generated.
Example
apictl gen deployment-dir -s /desktop/source/Dev/PizzaShackAPI_1.0.0apictl gen deployment-dir -s /desktop/source/dev/PizzaShackAPI_1.0.0.zip -d /desktop/deployment/devapictl gen deployment-dir -s /desktop/source/dev/LeasingAPIProduct_1.0.0 -d /desktop/deployment/devapictl gen deployment-dir --source /desktop/source/dev/PizzaShackAPI_1.0.0apictl gen deployment-dir --source /desktop/source/Dev/PizzaShackAPI_1.0.0.zip --destination /desktop/deployment/devapictl gen deployment-dir --source /desktop/source/dev/LeasingAPIProduct_1.0.0 --destination /desktop/deployment/devNote
If the
--destinationflag is not provided, the deployment directory will be generated in the working directory by default.A project folder with the following default structure will be created in the given directory.
DeploymentArtifacts_<API_Name>-<API_Version> ├── api_meta.yaml (api_product_meta.yaml for API Products) ├── certificates └── params.yamlSub Directory/File Description params.yamlThe specification of the environment specific configurations. api_meta.yaml/api_product_meta.yamlThe meta-information file of the source artifact (This includes the name and the version of the source). certificates Contains the client certificates for Mutual SSL enabled APIs/API Products and endpoint certificates for endpoint security enabled APIs. - Required :
Bundling the generated directory before Import¶
After generating the deployment directory, you can use the bundle command to archive it without the need of external dependencies. This command will generate a .zip archive
file of a given directory. If api_meta.yaml file (or api_product_meta.yaml or application_meta.yaml) is included in
the project, the created archive file name will be the combination of the project name and the version.
-
Command
apictl bundle -s <path-to-source-directory>apictl bundle -s <path-to-source-directory> -d <path-to-the-archive-destination>apictl bundle --source <path-to-source-directory>apictl bundle --source <path-to-source-directory> --destination <path-to-the-archive-destination>Info
Flags:
- Required :
--sourceor-s: File path of the source directory to archive - Optional :
--destinationor-d: Path of the directory where the archive should be generated
Example
apictl bundle -s /Source/apis/dev/API1-1apictl bundle -s /Source/apis/dev/API1-1 -d /Deployment/apis/devapictl bundle --source /Source/apis/dev/API1-1apictl bundle --source /Source/apis/dev/API1-1 --destination /Deployment/apis/devNote
- If the
--destinationflag is not provided, the archive will be created in the working directory by default. - If the
api_meta.yaml(orapi_product_meta.yamlorapplication_meta.yaml) is not included in the project, source directory name would be used as the archived file name.
- Required :
Defining the parameters file for an API¶
The following is the structure of the parameters file of an API.
environments:
- name: <environment_name>
configs: <multiple_configurations_relevant_to_the_specific_environment>
endpoints:
production:
url: <production_endpoint_url>
config:
factor: <suspension_factor>
suspendMaxDuration: <maximum_suspend_time_duration>
suspendDuration: <suspend_time_duration>
suspendErrorCode:
- <suspend_error_code_1>
- <suspend_error_code_2>
- ......................
- <suspend_error_code_n>
retryTimeOut: <no_of_retries_before_suspension>
retryDelay: <retry_delay_in_ms>
retryErroCode:
- <retry_error_code_1>
- <retry_error_code_2>
- ....................
- <retry_error_code_n>
actionSelect: <action_discard_or_fault>
actionDuration: <action_time_duration>
sandbox:
url: <sandbox_endpoint_url>
config:
factor: <suspension_factor>
suspendMaxDuration: <maximum_suspend_time_duration>
suspendDuration: <suspend_time_duration>
suspendErrorCode:
- <suspend_error_code_1>
- <suspend_error_code_2>
- ......................
- <suspend_error_code_n>
retryTimeOut: <no_of_retries_before_suspension>
retryDelay: <retry_delay_in_ms>
retryErroCode:
- <retry_error_code_1>
- <retry_error_code_2>
- ....................
- <retry_error_code_n>
actionSelect: <action_discard_or_fault>
actionDuration: <action_time_duration>
security:
production:
enabled: <whether_security_is_enabled_for_production_endpoint>
type: <endpoint_authentication_for_production_endpoint>
username: <endpoint_username_for_production_endpoint>
password: <endpoint_password_for_production_endpoint>
tokenUrl: <token_url_for_production_endpoint_oauth_security>
clientId: <client_id_for_production_endpoint_oauth_security>
clientSecret: <client_secret_for_production_endpoint_oauth_security>
grantType: <grant_type_for_production_endpoint_oauth_security>
customParameters:
<custom_parameter_1_for_production_endpoint_oauth_security>: <custom_parameter_1_value_for_production_endpoint_oauth_security>
<custom_parameter_2_for_production_endpoint_oauth_security>: <custom_parameter_2_value_for_production_endpoint_oauth_security>
...........................................................: ................................................................
<custom_parameter_n_for_production_endpoint_oauth_security>: <custom_parameter_n_value_for_production_endpoint_oauth_security>
sandbox:
enabled: <whether_security_is_enabled_for_sandbox_endpoint>
type: <endpoint_authentication_for_sandbox_endpoint>
username: <endpoint_username_for_sandbox_endpoint>
password: <endpoint_password_for_sandbox_endpoint>
tokenUrl: <token_url_for_sandbox_endpoint_oauth_security>
clientId: <client_id_for_sandbox_endpoint_oauth_security>
clientSecret: <client_secret_for_sandbox_endpoint_oauth_security>
grantType: <grant_type_for_sandbox_endpoint_oauth_security>
customParameters:
<custom_parameter_1_for_sandbox_endpoint_oauth_security>: <custom_parameter_1_value_for_sandbox_endpoint_oauth_security>
<custom_parameter_2_for_sandbox_endpoint_oauth_security>: <custom_parameter_2_value_for_sandbox_endpoint_oauth_security>
........................................................: .............................................................
<custom_parameter_n_for_sandbox_endpoint_oauth_security>: <custom_parameter_n_value_for_sandbox_endpoint_oauth_security>
deploymentEnvironments:
- displayOnDevportal: <boolean>
deploymentEnvironment: <environment_name>
deploymentVhost : <vhost_name>
certs:
- hostName: <endpoint_url>
alias: <certificate_alias>
path: <certificate_name>
mutualSslCerts:
- tierName: <subscription_tier_name>
alias: <certificate_alias>
path: <certificate_name>
policies:
- <subscription_policy_1_name>
- <subscription_policy_2_name>
additionalProperties:
- name: <additional_property_name>
value: <additional_property_value>
display: <whether_additional_property_is_enabled_for_display_in_devportal>The following code snippet contains sample configuration of the parameters file of an API.
Example
environments:
- name: dev
configs:
endpoints:
production:
url: 'https://dev.wso2.com'
security:
production:
enabled: true
type: basic
username: admin
password: admin
certs:
- hostName: 'https://dev.wso2.com'
alias: Dev
path: dev.crt
deploymentEnvironments:
- displayOnDevportal: true
deploymentEnvironment: Label1
deploymentVhost : localhost
- displayOnDevportal: true
deploymentEnvironment: Label2
deploymentVhost : us.wso2.com
policies:
- Gold
- Silver
additionalProperties:
- name: property1
value: http://property.name1
display: true
- name: property2
value: http://property.name2
display: false
- name: test
configs:
endpoints:
production:
url: 'https://test.wso2.com'
config:
factor: 3
suspendMaxDuration: "25000"
suspendDuration: "45000"
suspendErrorCode:
- "101504"
- "101501"
retryTimeOut: $RETRY
retryDelay: "23000"
retryErroCode:
- "101503"
- "101504"
actionSelect: discard
actionDuration: "75000"
sandbox:
url: 'https://test.sandbox.wso2.com'
security:
production:
enabled: true
type: digest
username: admin
password: admin
sandbox:
enabled: true
type: basic
username: admin
password: admin
- name: production
configs:
endpoints:
production:
url: 'https://prod.wso2.com'
mutualSslCerts:
- tierName: Unlimited
alias: Prod1
path: prod1.crt
- tierName: Gold
alias: Prod2
path: prod2.crtYou can provide the parameters file using --params flag when importing an API. A sample command will be as follows.
Example
apictl import api -f dev/PhoneVerification_1.0.zip -e production --params /home/user/custom_params.yaml Note
apictl import-api command has been deprecated from the API Controller 4.0.0 onwards. Instead, use apictl import api as shown above.
- You can deploy an API project which does not include
deployment_environments.yaml(working copy of the API or a revision without deployment environments) by specifying thedeploymentEnvironmentsfields in the parameters file. - Production/Sandbox backends for each environment can be specified in the parameters file with additional configurations, such as timeouts.
- When defining passwords in parameters file, quotes are mandatory if
passwordcontains special characters. - The parameters file supports detecting environment variables during the API import process. You can use the usual notation as described here. For example,
url: ${DEV_PROD_URL}. If an environment variable is not set, the tool will fail. In addition, the system will also request for a set of required environment variables. - To learn about setting up different endpoint types such as HTTP/REST, HTTP/SOAP (with load balancing and failover), Dynamic and AWS Lambda, see Configuring Different Endpoint Types.
- To learn about setting up different endpoint security types such as Basic, Digest and OAuth 2.0, refer the section Configuring Different Endpoint Security Types.
- You can define the subscription level policies of an API using the field
policies. There you can specify one or more subscription level policies that is available in the particular environment where you are importing the API to. - Refer the section Handling the certificates using the parameters file to learn how to configure certificates using the parameters file.
Defining the parameters file for an API Product¶
The following is the structure of the parameters file of an API Product.
environments:
- name: <environment_name>
configs: <multiple_configurations_relevant_to_the_specific_environment>
dependentAPIs:
<api_1_name>-<api_1_version>:
endpoints:
production:
url: <production_endpoint_url_for_api_1>
config:
factor: <production_suspension_factor_for_api_1>
suspendMaxDuration: <production_maximum_suspend_time_duration_for_api_1>
suspendDuration: <production_suspend_time_duration_for_api_1>
suspendErrorCode:
- <production_suspend_error_code_1_for_api_1>
- <production_suspend_error_code_2_for_api_1>
- ..........................................
- <production_suspend_error_code_n_for_api_1>
retryTimeOut: <production_no_of_retries_before_suspension_for_api_1>
retryDelay: <production_retry_delay_in_ms_for_api_1>
retryErroCode:
- <production_retry_error_code_1_for_api_1>
- <production_retry_error_code_2_for_api_1>
- ........................................
- <production_retry_error_code_n_for_api_1>
actionSelect: <production_action_for_api_1_discard_or_fault>
actionDuration: <production_action_time_duration_for_api_1>
sandbox:
url: <sandbox_endpoint_url_for_api_1>
config:
factor: <sandbox_suspension_factor_for_api_1>
suspendMaxDuration: <sandbox_maximum_suspend_time_duration_for_api_1>
suspendDuration: <sandbox_suspend_time_duration_for_api_1>
suspendErrorCode:
- <sandbox_suspend_error_code_1_for_api_1>
- <sandbox_suspend_error_code_2_for_api_1>
- .......................................
- <sandbox_suspend_error_code_n_for_api_1>
retryTimeOut: <sandbox_no_of_retries_before_suspension_for_api_1>
retryDelay: <sandbox_retry_delay_in_ms_for_api_1>
retryErroCode:
- <sandbox_retry_error_code_1_for_api_1>
- <sandbox_retry_error_code_2_for_api_1>
- .....................................
- <sandbox_retry_error_code_n_for_api_1>
actionSelect: <sandbox_action_for_api_1_discard_or_fault>
actionDuration: <sandbox_action_time_duration_for_api_1>
security:
production:
enabled: <whether_security_is_enabled_for_production_endpoint_for_api_1>
type: <endpoint_authentication_for_production_endpoint_for_api_1>
username: <endpoint_username_for_production_endpoint_for_api_1>
password: <endpoint_password_for_production_endpoint_for_api_1>
tokenUrl: <token_url_for_production_endpoint_oauth_security_for_api_1>
clientId: <client_id_for_production_endpoint_oauth_security_for_api_1>
clientSecret: <client_secret_for_production_endpoint_oauth_security_for_api_1>
grantType: <grant_type_for_production_endpoint_oauth_security_for_api_1>
customParameters:
<custom_parameter_1_for_production_endpoint_oauth_security_for_api_1>: <custom_parameter_1_value_for_production_endpoint_oauth_security_for_api_1>
<custom_parameter_2_for_production_endpoint_oauth_security_for_api_1>: <custom_parameter_2_value_for_production_endpoint_oauth_security_for_api_1>
.....................................................................: ..........................................................................
<custom_parameter_n_for_production_endpoint_oauth_security_for_api_1>: <custom_parameter_n_value_for_production_endpoint_oauth_security_for_api_1>
sandbox:
enabled: <whether_security_is_enabled_for_sandbox_endpoint_for_api_1>
type: <endpoint_authentication_for_sandbox_endpoint_for_api_1>
username: <endpoint_username_for_sandbox_endpoint_for_api_1>
password: <endpoint_password_for_sandbox_endpoint_for_api_1>
tokenUrl: <token_url_for_sandbox_endpoint_oauth_security_for_api_1>
clientId: <client_id_for_sandbox_endpoint_oauth_security_for_api_1>
clientSecret: <client_secret_for_sandbox_endpoint_oauth_security_for_api_1>
grantType: <grant_type_for_sandbox_endpoint_oauth_security_for_api_1>
customParameters:
<custom_parameter_1_for_sandbox_endpoint_oauth_security_for_api_1>: <custom_parameter_1_value_for_sandbox_endpoint_oauth_security_for_api_1>
<custom_parameter_2_for_sandbox_endpoint_oauth_security_for_api_1>: <custom_parameter_2_value_for_sandbox_endpoint_oauth_security_for_api_1>
..................................................................: .......................................................................
<custom_parameter_n_for_sandbox_endpoint_oauth_security_for_api_1>: <custom_parameter_n_value_for_sandbox_endpoint_oauth_security_for_api_1>
deploymentEnvironments:
- displayOnDevportal: <boolean_for_api_1>
deploymentEnvironment: <environment_name_for_api_1>
deploymentVhost : <vhost_name_for_api_1>
certs:
- hostName: <endpoint_url_for_api_1>
alias: <certificate_alias_for_api_1>
path: <certificate_name_for_api_1>
mutualSslCerts:
- tierName: <subscription_tier_name_for_api_1>
alias: <certificate_alias_for_api_1>
path: <certificate_name_for_api_1>
policies:
- <subscription_policy_1_name_for_api_1>
- <subscription_policy_2_name_for_api_1>
additionalProperties:
- name: <additional_property_name>
value: <additional_property_value>
display: <whether_additional_property_is_enabled_for_display_in_devportal>
<api_2_name>-<api_2_version>:
endpoints:
production:
url: <production_endpoint_url_for_api_2>
config:
factor: <production_suspension_factor_for_api_2>
suspendMaxDuration: <production_maximum_suspend_time_duration_for_api_2>
suspendDuration: <production_suspend_time_duration_for_api_2>
suspendErrorCode:
- <production_suspend_error_code_1_for_api_2>
- <production_suspend_error_code_2_for_api_2>
- ..........................................
- <production_suspend_error_code_n_for_api_2>
retryTimeOut: <production_no_of_retries_before_suspension_for_api_2>
retryDelay: <production_retry_delay_in_ms_for_api_2>
retryErroCode:
- <production_retry_error_code_1_for_api_2>
- <production_retry_error_code_2_for_api_2>
- ........................................
- <production_retry_error_code_n_for_api_2>
actionSelect: <production_action_for_api_2_discard_or_fault>
actionDuration: <production_action_time_duration_for_api_2>
sandbox:
url: <sandbox_endpoint_url_for_api_2>
config:
factor: <sandbox_suspension_factor_for_api_2>
suspendMaxDuration: <sandbox_maximum_suspend_time_duration_for_api_2>
suspendDuration: <sandbox_suspend_time_duration_for_api_2>
suspendErrorCode:
- <sandbox_suspend_error_code_1_for_api_2>
- <sandbox_suspend_error_code_2_for_api_2>
- .......................................
- <sandbox_suspend_error_code_n_for_api_2>
retryTimeOut: <sandbox_no_of_retries_before_suspension_for_api_2>
retryDelay: <sandbox_retry_delay_in_ms_for_api_2>
retryErroCode:
- <sandbox_retry_error_code_1_for_api_2>
- <sandbox_retry_error_code_2_for_api_2>
- .....................................
- <sandbox_retry_error_code_n_for_api_2>
actionSelect: <sandbox_action_for_api_2_discard_or_fault>
actionDuration: <sandbox_action_time_duration_for_api_2>
security:
production:
enabled: <whether_security_is_enabled_for_production_endpoint_for_api_2>
type: <endpoint_authentication_for_production_endpoint_for_api_2>
username: <endpoint_username_for_production_endpoint_for_api_2>
password: <endpoint_password_for_production_endpoint_for_api_2>
tokenUrl: <token_url_for_production_endpoint_oauth_security_for_api_2>
clientId: <client_id_for_production_endpoint_oauth_security_for_api_2>
clientSecret: <client_secret_for_production_endpoint_oauth_security_for_api_2>
grantType: <grant_type_for_production_endpoint_oauth_security_for_api_2>
customParameters:
<custom_parameter_1_for_production_endpoint_oauth_security_for_api_2>: <custom_parameter_1_value_for_production_endpoint_oauth_security_for_api_2>
<custom_parameter_2_for_production_endpoint_oauth_security_for_api_2>: <custom_parameter_2_value_for_production_endpoint_oauth_security_for_api_2>
.....................................................................: ..........................................................................
<custom_parameter_n_for_production_endpoint_oauth_security_for_api_2>: <custom_parameter_n_value_for_production_endpoint_oauth_security_for_api_2>
sandbox:
enabled: <whether_security_is_enabled_for_sandbox_endpoint_for_api_2>
type: <endpoint_authentication_for_sandbox_endpoint_for_api_2>
username: <endpoint_username_for_sandbox_endpoint_for_api_2>
password: <endpoint_password_for_sandbox_endpoint_for_api_2>
tokenUrl: <token_url_for_sandbox_endpoint_oauth_security_for_api_2>
clientId: <client_id_for_sandbox_endpoint_oauth_security_for_api_2>
clientSecret: <client_secret_for_sandbox_endpoint_oauth_security_for_api_2>
grantType: <grant_type_for_sandbox_endpoint_oauth_security_for_api_2_>
customParameters:
<custom_parameter_1_for_sandbox_endpoint_oauth_security_for_api_2>: <custom_parameter_1_value_for_sandbox_endpoint_oauth_security_for_api_2>
<custom_parameter_2_for_sandbox_endpoint_oauth_security_for_api_2>: <custom_parameter_2_value_for_sandbox_endpoint_oauth_security_for_api_2>
..................................................................: .......................................................................
<custom_parameter_n_for_sandbox_endpoint_oauth_security_for_api_2>: <custom_parameter_n_value_for_sandbox_endpoint_oauth_security_for_api_2>
deploymentEnvironments:
- displayOnDevportal: <boolean_for_api_2>
deploymentEnvironment: <environment_name_for_api_2>
deploymentVhost : <vhost_name_for_api_2>
certs:
- hostName: <endpoint_url_for_api_2>
alias: <certificate_alias_for_api_2>
path: <certificate_name_for_api_2>
mutualSslCerts:
- tierName: <subscription_tier_name_for_api_2>
alias: <certificate_alias_for_api_2>
path: <certificate_name_for_api_2>
policies:
- <subscription_policy_1_name_for_api_2>
- <subscription_policy_2_name_for_api_2>
additionalProperties:
- name: <additional_property_name>
value: <additional_property_value>
display: <whether_additional_property_is_enabled_for_display_in_devportal>
deploymentEnvironments:
- displayOnDevportal: <boolean>
deploymentEnvironment: <environment_name>
deploymentVhost : <vhost_name>
mutualSslCerts:
- tierName: <subscription_tier_name>
alias: <certificate_alias>
path: <certificate_name>
policies:
- <subscription_policy_1_name>
- <subscription_policy_2_name>
additionalProperties:
- name: <additional_property_name>
value: <additional_property_value>
display: <whether_additional_property_is_enabled_for_display_in_devportal>The following code snippet contains sample configuration of the parameters file of an API Product.
Example
environments:
- name: dev
configs:
dependentAPIs:
PizzaShackAPI-1.0.0:
endpoints:
production:
url: https://prod1.wso2.com
config:
factor: 3
suspendMaxDuration: "25000"
suspendDuration: "45000"
suspendErrorCode:
- "101504"
- "101501"
retryTimeOut: $RETRY
retryDelay: "23000"
retryErroCode:
- "101503"
- "101504"
actionSelect: discard
actionDuration: "75000"
sandbox:
url: https://sand2.wso2.com
security:
production:
enabled: true
type: basic
username: admin
password: admin
certs:
- hostName: https://prod1.wso2.com
alias: alice
path: alice.crt
policies:
- Gold
- Silver
additionalProperties:
- name: property1
value: http://property.name1
display: true
- name: property2
value: http://property.name2
display: false
PetstoreAPI-1.0.5:
endpoints:
production:
url: https://prod1.wso2.com
sandbox:
url: https://sand2.wso2.com
security:
production:
enabled: true
type: digest
username: admin
password: admin
sandbox:
enabled: true
type: basic
username: admin
password: admin
certs:
- hostName: https://prod1.wso2.com
alias: bob
path: bob.crt
policies:
- Gold
- Silver
additionalProperties:
- name: property1
value: http://property.name1
display: true
- name: property2
value: http://property.name2
display: false
deploymentEnvironments:
- displayOnDevportal: true
deploymentEnvironment: Label1
deploymentVhost : localhost
- displayOnDevportal: true
deploymentEnvironment: Label2
deploymentVhost : us.wso2.com
policies:
- Gold
- Silver
additionalProperties:
- name: property1
value: http://property.name1
display: true
- name: property2
value: http://property.name2
display: false
mutualSslCerts:
- tierName: Unlimited
alias: Prod1
path: prod1.crt
- tierName: Gold
alias: Prod2
path: prod2.crt
- name: production
configs:
deploymentEnvironments:
- displayOnDevportal: true
deploymentEnvironment: Default
deploymentVhost : localhost
mutualSslCerts:
- tierName: Unlimited
alias: Prod1
path: prod1.crt
- tierName: Gold
alias: Prod2
path: prod2.crtYou can provide the parameters file using --params flag when importing an API Product. A sample command will be as follows.
Example
apictl import api product -f dev/LeasingAPIProduct.zip -e production --params /home/user/custom_params.yaml - The parameters file of an API Product does not support the fields
endpoints,securityandcertslike in the parameters file of an API. It only supports the fieldsdeploymentEnvironments,policies,mutualSslCertsand another special field nameddependentAPIs. - The field
dependentAPIscan be used to specify the parameters of dependent APIs. The parameters of a particular dependent API of an API Product is similar to the parameters of an API, but there is no use of specifying thedeploymentEnvironmentsfield under a dependent API. The reason for that is, the deployment environments of the API Product will be considered for dependent APIs as well. - You can deploy an API Product which does not include
deployment_environments.yaml(working copy of the API Product or a revision without deployment environments) by specifying thedeploymentEnvironmentsfields in the parameters file. - The parameters file supports detecting environment variables during the API Product import process. You can use the usual notation as described here. For example,
url: ${DEV_PROD_URL}. If an environment variable is not set, the tool will fail. In addition, the system will also request for a set of required environment variables. - Refer the section Handling the certificates using the parameters file to learn how to configure certificates using the parameters file.
Handling the certificates using the parameters file¶
Follow the below steps to override the certificates using the parameters file.
- Generate the deployment directory for the particular API or API Product as explained in Generating the Deployment Directory.
- Move all the certificates (Endpoint certificates and MutualSSL certificates) to the certificates directory that is inside the generated deployment directory.
- Open the
params.yamlfile inside the generated deployment directory and add your parameters content inside it. - Provide the name of the certificate file at the
pathfield under the fieldcerts(to override endpoint certificates) andmutualSslCerts(to override client/MutualSSL certificates) in the parameters file as shown in the earlier topics.
Now, after you import the API or API Product with the --params flag pointed to the deployment directory that you generated, the configurations will be applied to the imported API or API Product.
Note
Special note about the certificates of API Products
- You can follow the same steps mentioned above to configure MutualSSL (Client) certificates for an API Product (That is, by copying the certificates to the certificates directory and by specifying the certificate file names in the
pathfield under themutualSslCertsin the params file) - You cannot configure Endpoint certificates for API Products, since API Products do not have endpoints itself. Instead, an API Product will be using the endpoints of its dependent APIs.
- To configure the Endpoint certificates of dependent APIs, you can add those to the certificates directory as we did before. Then, specify the certificate file name in the
pathfields under thecertsfield of the corresponding dependent API listed in the fielddependentAPIsof the params file of the API Product.