profile-template.yaml•1.47 kB
# API Profile Template
# Copy this file and customize for your API
api_name: MyAPI # Name for the deployment (alphanumeric, dots allowed)
api_base_url: https://api.example.com/v1 # Base URL for API requests
api_spec_url: https://api.example.com/openapi.json # OpenAPI spec URL
# Authentication configuration
# Options: none, basic, bearer, api_key, cognito, zoho
auth_type: none
# Local development configuration
local_port: 8082 # Port for local Docker container (use unique port per API)
# Authentication credentials (optional, based on auth_type)
# Uncomment and configure based on your auth type:
# For bearer token authentication:
# auth_token: ${MY_API_TOKEN} # Use environment variable
# For basic authentication:
# auth_username: ${MY_API_USERNAME}
# auth_password: ${MY_API_PASSWORD}
# For API key authentication:
# auth_api_key: ${MY_API_KEY}
# auth_api_key_name: X-API-Key # Header/query param name
# auth_api_key_in: header # Options: header, query
# For AWS Cognito:
# auth_cognito_user_pool_id: ${COGNITO_USER_POOL_ID}
# auth_cognito_client_id: ${COGNITO_CLIENT_ID}
# auth_cognito_username: ${COGNITO_USERNAME}
# auth_cognito_password: ${COGNITO_PASSWORD}
# For Zoho OAuth:
# auth_token: ${ZOHO_OAUTH_TOKEN} # Access or refresh token
# Notes:
# - Use ${ENV_VAR} syntax to reference environment variables
# - Store sensitive credentials in environment variables or AWS Secrets Manager
# - Stack name will be: openapi-mcp-{api_name_lowercase}