Ana içeriğe atla

Documentation Index

Fetch the complete documentation index at: https://docs.apinizer.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Endpoint

PATCH /apiops/projects/{projectName}/apiProxies/{apiProxyName}/settings/mtls/

​
Authentication

Requires a Personal API Access Token. 
Authorization: Bearer YOUR_TOKEN

​
Request

​
Headers

HeaderValueRequired
AuthorizationBearer Yes
Content-Typeapplication/jsonYes

​
Path Parameters

ParameterTypeRequiredDescription
projectNamestringYesProject name
apiProxyNamestringYesAPI Proxy name

​
Request Body

​
Full JSON Body Example

{
  "enabled": true,
  "keyStoreId": "keystore-id-123",
  "trustStoreId": "truststore-id-456",
  "supportedProtocolList": [
    "TLS_1_2",
    "TLS_1_3"
  ],
  "hostnameVerifierType": "STRICT",
  "disableSslValidation": false,
  "deploy": false,
  "deployTargetEnvironmentNameList": []
}

​
Request Body Fields

FieldTypeRequiredDefaultDescription
enabledbooleanNofalseEnable/disable mTLS
keyStoreIdstringNo*-KeyStore ID (required if enabled=true)
trustStoreIdstringNo-TrustStore ID (optional, for server certificate validation)
supportedProtocolListarrayNo[]List of supported TLS/SSL protocols
hostnameVerifierTypestringNoNOOPHostname verifier type
disableSslValidationbooleanNofalseDisable SSL/TLS certificate validation entirely
deploybooleanNofalseIf true, deploy the API proxy after saving changes
deployTargetEnvironmentNameListarray[string]No-List of environment names to deploy to (required when deploy=true)

​
EnumSSLContextProtocolType

  • TLS_1_3 - TLS 1.3 (Java name: “TLSv1.3”)
  • TLS_1_2 - TLS 1.2 (Java name: “TLSv1.2”)
  • TLS_1_1 - TLS 1.1 (Java name: “TLSv1.1”)
  • TLS_1_0 - TLS 1.0 (Java name: “TLSv1”)
  • SSL_3_0 - SSL 3.0 (Java name: “SSLv3”)
Note: If supportedProtocolList is empty, all protocols are supported.

​
EnumHostnameVerifierType

  • NOOP - No hostname verification (not recommended for production)
  • DEFAULT - Default hostname verification (RFC 2818, RFC 6125)
  • STRICT - Strict hostname verification (exact match required)
  • BROWSER_COMPAT - Browser-compatible hostname verification (allows wildcards)
Note: All fields are optional. Only provided fields are updated.

​
Response

​
Success Response (200 OK)

{
  "success": true
}

​
Response Fields

FieldTypeDescription
successbooleanIndicates if the request was successful
When deploy=true is specified: 
{
  "success": true,
  "deploymentResult": {
    "success": true,
    "deploymentResults": [
      {
        "environmentName": "production",
        "success": true,
        "message": "Deployment successful"
      }
    ]
  }
}
FieldTypeDescription
deploymentResultobjectOnly present when deploy=true
deploymentResult.successbooleanOverall deployment success status
deploymentResult.deploymentResultsarrayPer-environment deployment results

​
Error Response (400 Bad Request)

{
  "error": "bad_request",
  "error_description": "KeyStore ID is required when mTLS is enabled"
}

​
Error Response (401 Unauthorized)

{
  "error": "unauthorized_client",
  "error_description": "Invalid token"
}

​
Error Response (404 Not Found)

{
  "error": "not_found",
  "error_description": "ApiProxy (name: MyAPI) was not found!"
}

​
cURL Example

​
Example 1: Enable mTLS with KeyStore and TrustStore

curl -X PATCH \
  "https://demo.apinizer.com/apiops/projects/MyProject/apiProxies/MyAPI/settings/mtls/" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "enabled": true,
    "keyStoreId": "keystore-id-123",
    "trustStoreId": "truststore-id-456",
    "supportedProtocolList": ["TLS_1_2", "TLS_1_3"],
    "hostnameVerifierType": "STRICT"
  }'

​
Example 2: Enable mTLS with KeyStore Only

curl -X PATCH \
  "https://demo.apinizer.com/apiops/projects/MyProject/apiProxies/MyAPI/settings/mtls/" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "enabled": true,
    "keyStoreId": "keystore-id-123",
    "supportedProtocolList": ["TLS_1_2"],
    "hostnameVerifierType": "DEFAULT"
  }'

​
Example 3: Save and Deploy

curl -X PATCH \
  "https://demo.apinizer.com/apiops/projects/MyProject/apiProxies/MyAPI/settings/mtls/" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "enabled": true,
    "keyStoreId": "keystore-id-123",
    "supportedProtocolList": ["TLS_1_2", "TLS_1_3"],
    "hostnameVerifierType": "STRICT",
    "deploy": true,
    "deployTargetEnvironmentNameList": ["production"]
  }'

​
Notes and Warnings

  • KeyStore: Required when enabled=true. Contains client certificate and private key
  • TrustStore: Optional. Contains trusted server certificates for validation
  • Protocols: If empty, all protocols are supported. Recommended: ["TLS_1_2", "TLS_1_3"]
  • Hostname Verification: NOOP disables verification (security risk). Use STRICT or DEFAULT for production
  • Connection Pool: When mTLS is enabled, connection pools are disabled
  • SSL Validation: When disableSslValidation=true, the gateway skips SSL certificate verification when connecting to the backend. This is a security risk and should only be used in development/testing environments.
  • KeyStore/TrustStore: Must be created/uploaded before use (via KeyStore Management API)
  • Deploy: When deploy=true, the API proxy is automatically deployed to the specified environments after saving

​
Permissions

User must have API_MANAGEMENT + MANAGE permission in the project.