APapinizer
ApiProxy

Create an API Proxy from URL

Changed on

Create an API Proxy from Spec URL of OpenAPI, Swagger, WSDL or create a Reverse Proxy or a No-Spec API. For REVERSE_PROXY and EMPTY_API (No-Spec API) specUrl is not required. An EMPTY_API proxy is created as a REST API with an empty specification; its endpoints are added afterwards with POST /apiProxies/{apiProxyName}/endpoints/. The backend address of a request is routingInfo.routingAddressList address + endpoint backendResourceUrl, so the routing address must carry the host only and backendResourceUrl must carry the path only.

post/apiops/projects/{projectName}/apiProxies/url/

Request

Path parameters

projectNamestring required

Request body

deployboolean

If true, deploy the API Proxy after saving changes

deployTargetEnvironmentNameListstring[]

List of environment names to deploy to (required when deploy=true)

apiProxyCreationType'WSDL' | 'SWAGGER' | 'OPEN_API' | 'REVERSE_PROXY' | 'EMPTY_API'
soapToRestboolean
reParseboolean
apiProxyGroupNamestring
apiProxyNamestring
apiProxyDescriptionstring
backendApiVersionstring
enableWSAboolean
enableWSRMboolean
specUrlstring
specAuthUsernamestring
specAuthPasswordstring
useSpecAuthorizationboolean
skipSslVerificationboolean
trustStoreNamestring
uploadedTrustStoreContentstring
uploadedTrustStorePasswordstring
uploadedTrustStoreTypestring
certificateNamestring
connectionTimeoutinteger

Response

successful operation!

status'SUCCESS' | 'FAILURE'
resultMessagestring
resultListstring[]
resultCountinteger
unresolvedReferencesstring[]

Changes

  • d1a546deccf0Revision changes
    • breaking

      the request property /// became required

    This list may be incomplete.