Package io.github.primelib.webmethodsapigateway4j.api

Schnittstelle APIGatewayApi

@Generated("io.github.primelib.primecodegen.javafeign.JavaFeignGenerator") public interface APIGatewayApi

  • Methodendetails

    • activateAPI

      ModelAPIResponse activateAPI(@NotNull @NotNull String apiId)

      Activate an API so that API is exposed to consumers

      Parameter:
      apiId - API Id for the API to be activated (required)

    • activateDC

      String activateDC(@NotNull @NotNull String body)

      The method is used to activate the datacenter configuration in API Gateway.

      Parameter:
      body - Mode to activate (required)

    • activateGlobalPolicyByPolicyID

      Policy activateGlobalPolicyByPolicyID(@NotNull @NotNull String policyId)

      This REST request is used to activate a global policy and this request doesn't require any request body. This request will try to activate the global policy and if any error occurs during activation it will be reported as response or if the global policy is activated then its policy details active flag set to true will be sent as response. If the global policy have any conflicts then it cannot be activated the conflicts are manually resolved.

      Parameter:
      policyId - The path parameter should be the policy id of global policy that needs to be activated. If the policy id is not belongs to a global policy then error will be reported (required)

    • activateNodes

      Object activateNodes(@NotNull @NotNull Object body)

      The method is used to activate all the datacenters configuration in API Gateway.

      Parameter:
      body - Activate all nodes (required)

    • activatePackageByPackageId

      PackageResponseContainer activatePackageByPackageId(@NotNull @NotNull String packageId)

      This endpoint is used to activate the package. Once activated it will insert new Authentication policy for all associated APIs with API key as application identification condition. If the authentication policy already available or added to an API after activating the package, the package will add API key to that authentication policy if it is not there. It also make the condition as OR for application identification condition available in the authentication policy

      Parameter:
      packageId - package id which needs to be activated (required)

    • activateRule

      Rule activateRule(@NotNull @NotNull String ruleId)

      This REST request is used to activate a rule and this request doesn't require any request body.

      Parameter:
      ruleId - The path parameter should be the id of rule that needs to be activated. (required)

    • adminGet

      HealthCheckAdminResult adminGet()
      Perform administration health check

      Perform health check for administration parts of API Gateway, such as the UI accessibility and Kibana health.

    • aggregations

      Map<String,Object> aggregations(@NotNull @NotNull SearchContext body)

      This REST call is intent to get the aggregation results for the specified scope and types. Supported aggregations are grouping, metrics and timeseries. Grouping aggregation is used to find the count based on grouping of certain fields. Metrics aggregation is used to find the average, minimum, maximum and sum of a field. Timeseries aggregation is used to find the interval based and allowed intervals are second, minute, hour, day, week, month, quarter and year. In addition to the /search payload, aggregations fields like 'name', 'type' and 'fields'. Except types, scope, condition and aggregations other attributes are not considered during the REST API call.

      Parameter:
      body - Search Parameters to search for specific set of results on specified types (required)

    • allGet

      HealthCheckAllResult allGet()
      Perform health check for all components of API Gateway

      Perform health check for all components of API Gateway.

    • apiTransactionsArchiveBasedOnDuration

      void apiTransactionsArchiveBasedOnDuration(@NotNull @NotNull String from, @NotNull @NotNull String until, @NotNull @NotNull String eventType, @Nullable @Nullable String olderThan)

      This method is used to archive the runtime events and metrics. Data to be archived is filtered based on the input parameters. This method returns the job id as the response which is used to know the job status. Use GET /apitransactions/jobs/{jobId} method to know the status and file name, use POST /apitransactions/archives/{fileName} method to restore. The user must either be a part of the API-Gateway-Administrators group or must have the 'Manage purge and restore runtime events' privilege to perform this operation.

      Parameter:
      from - This is a date parameter. All the api transactions of specified type, from the given date, are archived. Ex: from=2017-12-18 00:00:00. Either one of from or duration is a mandatory parameter (required)
      until - This is a date parameter. All the api transactions of specified type, until the given date, are archived. Ex: until=2017-12-18 00:00:00. Either one of until or duration is a mandatory parameter (required)
      eventType - This parameter is used to specify the api transaction type.Specify eventType=ALL to archive all the events. To archive a specific event type, specify the required event type. Ex: eventType=transactionalEvents. The available event types are as follows 1.transactionalEvents 2.monitorEvents 3.errorEvents 4.performanceMetrics 5.threatProtectionEvents 6.lifecycleEvents 7.policyViolationEvents 8.auditlogs 9.applicationlogs 10.mediatorTraceSpan 11.serverLogTraceSpan (required)
      olderThan - All the api transactions of specified type that are older than the value specified are archived. Ex: olderThan='2d'. Possible types are d(days),M(months),y(years), For Example a) 2d means 2days b) 1M means 1 month c) 1y means 1 year (optional)

    • appendRingConfiguration

      RemotePortConfig appendRingConfiguration(@NotNull @NotNull RemotePortConfig body)

      The method is used to update the patch configuration in the datacenter in API Gateway.

      Parameter:
      body - Ring configuration payload (required)

    • approveorrejectApprovalRequest

      ApprovalPutResponse approveorrejectApprovalRequest(@NotNull @NotNull String approvalId, @NotNull @NotNull String action, @Nullable @Nullable ApprovalPutRequest body)

      Request payload for the approval request.

      Parameter:
      approvalId - ApprovalId for the Approval Request to be approved (required)
      action - Action for the Approval Request to be approved/rejected (required)
      body - Approval Request payload (optional)

    • archiveTraceInfo

      void archiveTraceInfo(@NotNull @NotNull ArchiveTraceInfoRequest body)

      Request payload to archive tracer events.

      Parameter:
      body - Request payload to archive tracer events. (required)

    • authorize

      User authorize(@NotNull @NotNull User body)

      This HTTP request authenticates an User in API Gateway.

      Parameter:
      body - This parameter describes the request payload of a user that is to be created in API Gateway. (required)

    • authorizeUser

      User authorizeUser(@NotNull @NotNull User body)

      This HTTP request authenticates an User in API Gateway.

      Parameter:
      body - This parameter describes the request payload of a user that is to be created in API Gateway. (required)

    • changeOwner

      ChangeOwnerResponse changeOwner(@NotNull @NotNull ChangeOwnerRequest body)

      This resource is used to change the owner of APIGateway asset

      Parameter:
      body - (required)

    • changeTeam

      ChangeOwnerResponse changeTeam(@NotNull @NotNull ChangeOwnerRequest body)

      This resource is used to change the team of APIGateway asset

      Parameter:
      body - (required)

    • checkConflictForGlobalPolicy

      Policy checkConflictForGlobalPolicy(@NotNull @NotNull String policyId, @Nullable @Nullable String active)

      This REST Request is used to get the conflicts for a global policy. Conflicts between the policies/APIs can arise if the policies contain the conflicting policy actions. For example, a global policy that contains the Identity and Access Policy with "API Key" will conflict with another global policy that contains the Identity and Access Policy with "OAuth2". If an API satisfy more than one global policy, then all the policy actions of all applicable global policy will be added for effective policy calculation. If any policy validation error occurred it will be reported as conflict. This REST request doesn't require request body. By Default it will return the conflicts for all applicable APIs and conflicts between the specified global policy and other active global policies. Additionally, we can use the query parameter to get the conflicts for active or all applicable APIs. If there is conflict, status 500 is returned along with the details on conflicting scenarios and if there is no conflict then status 200 is returned

      Parameter:
      policyId - This path parameter is used to specify the global policy id to which we need to conflicting case for a global policy (required)
      active - This is a query parameter. It is used to get conflicting case for a global policy. If the value for this parameter is 'false' then it will return conflicting scenario for all the APIs whether it is active or not for the specified global policy. If the value for this flag is 'true' then it will return conflicting case only for the list of applicable active APIs alone (optional)

    • configureNodes

      Object configureNodes(@NotNull @NotNull Object body)

      The method is used to configure the datacenters in API Gateway.

      Parameter:
      body - Dataspace configuration payload (required)

    • countByType

      Map<String,Integer> countByType(@NotNull @NotNull SearchContext body)

      This REST call is intent to get the total number of records for the specified scope and types. If the scope is not specified it returns total number of assets for the specified type. Both /search and /search/_count shares the same payload. Except types,scope and condition other attributes are not considered during the REST API call.

      Parameter:
      body - Search Parameters to search for specific set of results on specified types (required)

    • createAPI

      APIResponseCreate createAPI(@NotNull @NotNull CreateAPIRequest body)

      This REST operation is used to create an API by importing a file, url or from scratch

      Parameter:
      body - (required)

    • createAPIPortalConfiguration

      PortalGateway createAPIPortalConfiguration(@NotNull @NotNull PortalGateway body)

      This method allows you to create the API Portal configuration in API Gateway.

      Parameter:
      body - API Portal configuration payload (required)

    • createAccessMode

      AccessModeType createAccessMode(@NotNull @NotNull String listenerKey, @NotNull @NotNull AccessModeType body)

      The POST defines the access mode for an API Gateway port configuration

      Parameter:
      listenerKey - The listenerKey parameter uniquely identifies a port configuration within the WmRoot package. (required)
      body - The request contains the access mode information. (required)

    • createAccessProfile

      AccessProfile createAccessProfile(@NotNull @NotNull AccessProfile body)

      The method creates a team in API Gateway. The API request body must contain the payload for the team. Each bit infers the applicability of the functional privilege permission. Value 1 implies permission granted for that functional privilege. Value 0 implies denied permission. Function Privileges and its positions from left most bit to the right most bit. 1.Manage APIs2.Activate / Deactivate APIs3.Manage applications4.Manage aliases5.Manage global policies6.Activate / Deactivate global policies7.Manage policy templates8.Manage threat protection configurations9.Manage packages and plans10.Activate / Deactivate packages11.Publish to API Portal12.Import assets13.Export assets14.View administration configurations15.Manage general administration configurations16.Manage security configurations17.Manage destination configurations18.Manage system settings19.Manage user administration20.Manage purge and restore runtime events21.Execute service result cache APIs22.Manage Promotion23.Publish API to Service Registry24.Manage Service Registries

      Parameter:
      body - This parameter describes the request payload of a accessProfile that is to be created in API Gateway. (required)

    • createAlias

      Alias createAlias(@NotNull @NotNull Alias body)

      Use this method to create an alias. There are different types of alias like Endpoint, Simple etc. Refer to the Alias schema for different type of alias that you can create. If you want to create an alias for a specific type (say Endpoint alias), refer to the corresponding schema (EndpointAlias)

      Parameter:
      body - (required)

    • createApplication

      Application createApplication(@NotNull @NotNull Application body)

      The method creates an application in API Gateway. If you want to use JWT/Oauth/OpenID credentials in your application, you can create a JWT/Oauth/OpenID auth strategy using the resource /strategies POST. You can associate the created strategies to the application using /applications/{applicationId} PUT request using the property authStrategyIds in application. To associate the application to one or more APIs, refer the resource /applications/{applicationId}/apis PUT.

      Parameter:
      body - This parameter describes the request payload of an application that is to be created in API Gateway. (required)

    • createApprovalConfiguration

      ApprovalConfiguration createApprovalConfiguration(@NotNull @NotNull ApprovalConfiguration body)

      The method creates an approval configuration in API Gateway.

      Parameter:
      body - This parameter describes the request payload of an approval configuration that is to be created in API Gateway. (required)

    • createAssertion

      AssertionConfiguration createAssertion(@NotNull @NotNull AssertionConfiguration body)

      Custom assertions allow the API providers to extend and provide additional security policies that are not available by default in API Gateway. In WS-Security, custom assertions are used for expressing individual security requirements, constraints, or both. The individual policy assertions can be combined to create security policies that ensure secure and reliable exchanges of SOAP messages between a client and a SOAP API. This REST service is used to create a assertion. Below are the request payloads for different types of assertions. bindingAssertion: &quot;{ &quot;configurationElement&quot;: &quot;&lt;sp:AsymmetricBinding xmlns:sp=&quot;http://docs.oasis-open.org/ws-sx/ws-securitypolicy/200702&quot;&gt; &lt;wsp:Policy xmlns:wsp=&quot;http://schemas.xmlsoap.org/ws/2004/09/policy&quot;&gt; &lt;sp:InitiatorToken&gt; &lt;wsp:Policy&gt; &lt;sp:X509Token sp:IncludeToken=&quot;http://docs.oasis-open.org/ws-sx/ws-securitypolicy/200702/IncludeToken/Never&quot;&gt; &lt;wsp:Policy&gt; &lt;sp:WssX509V3Token10/&gt; &lt;/wsp:Policy&gt; &lt;/sp:X509Token&gt; &lt;/wsp:Policy&gt; &lt;/sp:InitiatorToken&gt; &lt;sp:RecipientToken&gt; &lt;wsp:Policy&gt; &lt;sp:X509Token sp:IncludeToken=&quot;http://docs.oasis-open.org/ws-sx/ws-securitypolicy/200702/IncludeToken/Never&quot;&gt; &lt;wsp:Policy&gt; &lt;sp:WssX509V3Token10/&gt; &lt;/wsp:Policy&gt; &lt;/sp:X509Token&gt; &lt;/wsp:Policy&gt; &lt;/sp:RecipientToken&gt; &lt;sp:AlgorithmSuite&gt; &lt;wsp:Policy&gt; &lt;sp:Basic256 /&gt; &lt;/wsp:Policy&gt; &lt;/sp:AlgorithmSuite&gt; &lt;sp:Layout&gt; &lt;wsp:Policy&gt; &lt;sp:LaxTimestampFirst/&gt; &lt;/wsp:Policy&gt; &lt;/sp:Layout&gt; &lt;sp:ProtectTokens/&gt; &lt;/wsp:Policy&gt; &lt;/sp:AsymmetricBinding&gt;&quot;, &quot;configurationName&quot;:&quot;CustomBindingAssertion1&quot;, &quot;assertionType&quot;:&quot;bindingAssertion&quot;}&quot; tokenAssertion: &quot;{ &quot;configurationElement&quot;: &quot;&lt;sp:SupportingTokens xmlns:sp=&quot;http://docs.oasis-open.org/ws-sx/ws-securitypolicy/200702&quot;&gt; &lt;wsp:Policy xmlns:wsp=&quot;http://schemas.xmlsoap.org/ws/2004/09/policy&quot;&gt; &lt;sp:UsernameToken sp:IncludeToken=&quot;http://docs.oasis-open.org/ws-sx/ws-securitypolicy/200702/IncludeToken/AlwaysToRecipient&quot;/&gt; &lt;/wsp:Policy&gt; &lt;/sp:SupportingTokens&gt;&quot;, &quot;configurationName&quot;:&quot;UsernameToken&quot;, &quot;assertionType&quot;:&quot;tokenAssertion&quot;}&quot; policyAssertion: &quot;{ &quot;configurationElement&quot;: &quot;&lt;wsp:Policy wsu:Id=&quot;CustomBinding_IWSTrust13Async_policy&quot; xmlns:wsu=&quot;http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd&quot; xmlns:wsp=&quot;http://schemas.xmlsoap.org/ws/2004/09/policy&quot; xmlns:wsaw=&quot;http://www.w3.org/2006/02/addressing/wsdl&quot; xmlns:sp=&quot;http://schemas.xmlsoap.org/ws/2005/07/securitypolicy&quot;&gt; &lt;wsp:ExactlyOne&gt; &lt;wsp:All&gt; &lt;sp:TransportBinding xmlns:sp=&quot;http://docs.oasis-open.org/ws-sx/ws-securitypolicy/200702&quot;&gt; &lt;wsp:Policy&gt; &lt;sp:TransportToken&gt; &lt;wsp:Policy&gt; &lt;sp:HttpsToken/&gt; &lt;/wsp:Policy&gt; &lt;/sp:TransportToken&gt; &lt;sp:AlgorithmSuite&gt; &lt;wsp:Policy&gt; &lt;sp:Basic128/&gt; &lt;/wsp:Policy&gt; &lt;/sp:AlgorithmSuite&gt; &lt;sp:Layout&gt; &lt;wsp:Policy&gt; &lt;sp:Strict/&gt; &lt;/wsp:Policy&gt; &lt;/sp:Layout&gt; &lt;sp:IncludeTimestamp/&gt; &lt;/wsp:Policy&gt; &lt;/sp:TransportBinding&gt; &lt;sp:EndorsingSupportingTokens xmlns:sp=&quot;http://docs.oasis-open.org/ws-sx/ws-securitypolicy/200702&quot;&gt; &lt;wsp:Policy&gt; &lt;sp:KerberosToken sp:IncludeToken=&quot;http://docs.oasis-open.org/ws-sx/ws-securitypolicy/200702/IncludeToken/Once&quot;&gt; &lt;wsp:Policy&gt; &lt;sp:WssGssKerberosV5ApReqToken11/&gt; &lt;/wsp:Policy&gt; &lt;/sp:KerberosToken&gt; &lt;sp:KeyValueToken sp:IncludeToken=&quot;http://docs.oasis-open.org/ws-sx/ws-securitypolicy/200702/IncludeToken/Never&quot; wsp:Optional=&quot;true&quot;/&gt; &lt;!-- &lt;sp:SignedParts&gt; &lt;sp:Header Name=&quot;To&quot; Namespace=&quot;http://www.w3.org/2005/08/addressing&quot;/&gt; &lt;/sp:SignedParts&gt; --&gt; &lt;/wsp:Policy&gt; &lt;/sp:EndorsingSupportingTokens&gt; &lt;sp:Wss11 xmlns:sp=&quot;http://docs.oasis-open.org/ws-sx/ws-securitypolicy/200702&quot;&gt; &lt;wsp:Policy&gt; &lt;sp:MustSupportRefKeyIdentifier/&gt; &lt;sp:MustSupportRefIssuerSerial/&gt; &lt;sp:MustSupportRefThumbprint/&gt; &lt;sp:MustSupportRefEncryptedKey/&gt; &lt;/wsp:Policy&gt; &lt;/sp:Wss11&gt; &lt;sp:Trust13 xmlns:sp=&quot;http://docs.oasis-open.org/ws-sx/ws-securitypolicy/200702&quot;&gt; &lt;wsp:Policy&gt; &lt;sp:MustSupportIssuedTokens/&gt; &lt;sp:RequireClientEntropy/&gt; &lt;sp:RequireServerEntropy/&gt; &lt;/wsp:Policy&gt; &lt;/sp:Trust13&gt; &lt;wsaw:UsingAddressing/&gt; &lt;/wsp:All&gt; &lt;/wsp:ExactlyOne&gt; &lt;/wsp:Policy&gt;&quot; &quot;configurationName&quot;:&quot;KerberosOverTransport&quot;, &quot;assertionType&quot;:&quot;policyAssertion&quot;}&quot;

      Parameter:
      body - assertion request payload (required)

    • createGroup

      Group createGroup(@NotNull @NotNull Group body)

      The method creates a group in API Gateway. The API request body must contain the payload for the group.

      Parameter:
      body - This parameter describes the request payload of a group that is to be created in API Gateway. (required)

    • createIPAccessMode

      IPAccessModeType createIPAccessMode(@NotNull @NotNull String listenerKey, @NotNull @NotNull IPAccessModeType body)

      The POST creates the ipAccessMode for an API Gateway port configuration

      Parameter:
      listenerKey - The listenerKey parameter uniquely identifies a port configuration within the WmRoot package. (required)
      body - The request contains the ip access mode type information. (required)

    • createJMSConnection

      JMSConnectionAlias createJMSConnection(@NotNull @NotNull JMSConnectionAlias body)

      The method creates a JMS connection in API Gateway. The API request body must contain the payload for the JMS connection

      Parameter:
      body - (required)

    • createJNDI

      JNDIProviderAlias createJNDI(@NotNull @NotNull JNDIProviderAlias body)

      The method creates a JNDI configuration in API Gateway. The API request body must contain the payload for the JNDI configuration

      Parameter:
      body - (required)

    • createKeystore

      KeyStore createKeystore(@NotNull @NotNull String keyStoreName, @NotNull @NotNull String keyStoreType, @NotNull @NotNull String keyStorePassword, @NotNull @NotNull String uploadFileName, @NotNull @NotNull File fileContent, @Nullable @Nullable String keyStoreDescription, @Nullable @Nullable String pkAliasesList, @Nullable @Nullable String pkPasswordsList, @Nullable @Nullable String nullPKpasswds, @Nullable @Nullable String isPwdBase64Encoded)

      Creates a keystore in API Gateway.

      Parameter:
      keyStoreName - The name of the keystore. It cannot contain spaces or special characters. The name of the key store must be unique across all the keystores created in API Gateway. (required)
      keyStoreType - The certificate file format of the keystore. (required)
      keyStorePassword - The keystore password that is defined at the time of keystore creation using a keystore utility. (required)
      uploadFileName - The name of the keystore file that will be used to save the keystore internally in API Gateway. (required)
      fileContent - The contents of the truststore file. (required)
      keyStoreDescription - The description for the keystore. (optional)
      pkAliasesList - Comma separated list of alias names in the uploaded keystore file. (optional)
      pkPasswordsList - Comma separated list of passwords in the same order as the aliases specified in pkAliasesList. If a particular key alias does not have a password, it is denoted by space. (optional)
      nullPKpasswds - Comma separated list of boolean values (true/false) indicating whether the particular alias has a password or not in the same order as the aliases specified in pkAliasesList. For each key alias, true indicates that the key alias does not have a password and false indicates that it does have a password. (optional)
      isPwdBase64Encoded - Specifies whether password is base 64 encoded. (optional)

    • createOAuthScope

      GatewayScope createOAuthScope(@NotNull @NotNull GatewayScope body)

      Use this method to create an OAuth scope mapping

      Parameter:
      body - This parameter describes the request payload of an OAuth scope that is to be created in API Gateway. (required)

    • createOutboundProxy

      void createOutboundProxy(@NotNull @NotNull OutboundProxySettings body)
      Parameter:
      body - The request payload of an outbound proxy server that is to be created in API Gateway. (required)

    • createPackage

      PackageResponseContainer createPackage(@Nullable @Nullable ModelPackage body)

      This endpoint is used to create a package in API Gateway.

      Parameter:
      body - (optional)

    • createPlan

      PlanResponseContainer createPlan(@Nullable @Nullable Plan body)

      This request is used to create the plan. During the creation of plan we can specify meta data of the plans. The rate limit and quota needs to created using a separate rest call to /policyActions. Also they need to be associated to corresponding policies created during the plan. You can also enable notifications in quota to trigger some actions such as billing or any other custom actions based on the consumption of an user. The notification can be either email or a custom destination. To receive email notification you should configure Email destination. To enable custom destination you need to create custom destination in API gateway. The link https://github.com/SoftwareAG/webmethods-api-gateway/tree/master/docs/articles/features/Custom%20Destinations contains the details on how to configure and use it. If you want to block the consumer after consuming allocated quota you should create throttle policy action as mentioned in the below example associate that to quota policy created for plan. If you want to just notify the destination with blocking the customer then you need to create monitorSLA policy action and associate that to quota policy created for plan. If you enable block on breach (throttle policy) you can receive both the policy violation event and monitor event with eventSource field as Enforce-HardLimit in custom destination. Please make sure that custom destination is enabled to receive events for policy violations events. If you dont enable block on breach (monitorSLA) in quota then monitor event with eventSource field as MonitorPolicy is sent to destinations configured. Below are the examples to create rate limit in API gateway using endpoint /policyActions and associate it to the policy created for the plan. curl -X POST -u 'Administrator:manage' -H 'Accept: application/json' -H 'Content-Type: application/json' http://localhost:5555/rest/apigateway/policyActions -d '{"policyAction":{"names":[{"value":"Traffic Optimization","locale":"en"}],"templateKey":"throttle","parameters":[{"templateKey":"throttleRule","parameters":[{"templateKey":"throttleRuleName","values":["requestCount"]},{"templateKey":"monitorRuleOperator","values":["GT"]},{"templateKey":"value","values":["10"]}]},{"templateKey":"destination","parameters":[{"templateKey":"destinationType","values":["GATEWAY"]}]},{"templateKey":"alertInterval","values":["2"]},{"templateKey":"alertIntervalUnit","values":["minutes"]},{"templateKey":"alertFrequency","values":["once"]},{"templateKey":"alertMessage","values":["10 requests in 2 minutes breached for rate limit"]},{"templateKey":"consumerIds","values":["AnyConsumers"]}],"active":false}}'. The above command will create a throttling policy action and its id in the response which you need to associate to the policy using the below example. curl -X PUT -u 'Administrator:manage' -H 'Accept: application/json' -H 'Content-Type: application/json' http://localhost:5555/rest/apigateway/policies/2429ece2-96c2-4bd6-b8dc-9c13eedac42f -d '{"policy":{"id":"2429ece2-96c2-4bd6-b8dc-9c13eedac42f","policyEnforcements":[{"enforcements":[{"enforcementObjectId":"f3753917-30ef-438c-99f5-adcc204ac7b6","order":null}],"stageKey":"throttle"}]}}'. To create throttle policy for quota use the below example. curl -X POST -u 'Administrator:manage' -H 'Accept: application/json' -H 'Content-Type: application/json' http://localhost:5555/rest/apigateway/policyActions -d '{"policyAction":{"names":[{"value":"Traffic Optimization","locale":"en"}],"templateKey":"throttle","parameters":[{"templateKey":"throttleRule","parameters":[{"templateKey":"throttleRuleName","values":["requestCount"]},{"templateKey":"monitorRuleOperator","values":["GT"]},{"templateKey":"value","values":["150"]}]},{"templateKey":"destination","parameters":[{"templateKey":"destinationType","values":["GATEWAY"]}]},{"templateKey":"alertInterval","values":["30"]},{"templateKey":"alertIntervalUnit","values":["minutes"]},{"templateKey":"alertFrequency","values":["once"]},{"templateKey":"alertMessage","values":["150 requests breached in 30 minutes for quota"]},{"templateKey":"consumerIds","values":["AnyConsumers"]},{"templateKey":"destination","parameters":[{"templateKey":"destinationType","values":["SMTP"]},{"templateKey":"emailTo","values":["[email protected]"]}]},{"templateKey":"destination","parameters":[{"templateKey":"destinationType","values":["CUSTOM"]},{"templateKey":"ids","values":["customDestiantion1"]}]},{"templateKey":"destination","parameters":[{"templateKey":"destinationType","values":["DES"]}]}],"active":false}}'. To create monitorSLA policy action for quota use the below example. curl -X POST -u 'Administrator:manage' -H 'Accept: application/json' -H 'Content-Type: application/json' http://localhost:5555/rest/apigateway/policyActions -d '{"policyAction":{"names":[{"value":"Monitor SLA","locale":"en"}],"templateKey":"monitorSLA","parameters":[{"templateKey":"monitorRules","parameters":[{"templateKey":"monitorRuleName","values":["requestCount"]},{"templateKey":"monitorRuleOperator","values":["GT"]},{"templateKey":"value","values":["120.0"],"extendedProperties":[{"key":"quota","value":"150"},{"key":"notifyPercent","value":"80"}]}]},{"templateKey":"destination","parameters":[{"templateKey":"destinationType","values":["GATEWAY"]}]},{"templateKey":"alertInterval","values":["30"]},{"templateKey":"alertIntervalUnit","values":["minutes"]},{"templateKey":"alertFrequency","values":["once"]},{"templateKey":"alertMessage","values":["80% vioalted for quota"]},{"templateKey":"consumerIds","values":["AnyConsumers"]},{"templateKey":"destination","parameters":[{"templateKey":"destinationType","values":["SMTP"]},{"templateKey":"emailTo","values":["[email protected]"]}]},{"templateKey":"destination","parameters":[{"templateKey":"destinationType","values":["CUSTOM"]},{"templateKey":"ids","values":["customDestiantion1"]}]},{"templateKey":"destination","parameters":[{"templateKey":"destinationType","values":["DES"]}]}],"active":false}}'. To associate create throttle and monitor policy to quota. curl -X PUT -u 'Administrator:manage' -H 'Accept: application/json' -H 'Content-Type: application/json' http://localhost:5555/rest/apigateway/policies/f6e80784-d82e-491c-abda-d492ee037c2c -d {"policy":{"id":"f6e80784-d82e-491c-abda-d492ee037c2c","policyEnforcements":[{"enforcements":[{"enforcementObjectId":"2083ce29-8f4a-4e5e-b8bc-cbaaf18e4780","order":null}],"stageKey":"throttle"},{"enforcements":[{"enforcementObjectId":"7d143518-1058-4f4c-8ee1-66dd75b4c08d","order":null}],"stageKey":"monitorSLA"}]}}

      Parameter:
      body - (optional)

    • createPolicyAction

      PolicyAction createPolicyAction(@NotNull @NotNull PolicyAction body)

      This REST request is used to create policy action. The result of this request is a policy action payload and is available in the response. To know about the policy action template and to create it you can use the policyActionTemplates/{templateKey} to get the template structure of a policy action. The template key will be available in policyStage resource. It's also used to create the custom destination using the templateKey 'customDestination'. For more information on custom destination, please refer the postman collections here - https://github.com/SoftwareAG/webmethods-api-gateway/blob/master/apigatewayservices/postmancollections/apis/custom-destination/CustomDestination.json

      Parameter:
      body - Contains the policy action details of the newly created policy action (required)

    • createPort

      Port createPort(@Nullable @Nullable Port body)

      The POST method creates a new port configuration

      Parameter:
      body - (optional)

    • createPromotion

      Promotion createPromotion(@NotNull @NotNull Promotion body, @Nullable @Nullable String fixingMissingVersions, @Nullable @Nullable Boolean overwrite, @Nullable @Nullable Boolean overwriteAlias)

      This REST operation is used to promote the API Gateway assets from the source machine to destination machine where the destination machine is configured as a stage

      Parameter:
      body - Promotion request payload (required)
      fixingMissingVersions - Option to fix the API version history. The discrepancy between the asset versions in the source and target stages, if any, are fixed. The default value is false (optional)
      overwrite - Option to overwrite the assets except aliases in the destination stage during asset promotion. The default value is false (optional)
      overwriteAlias - Option to overwrite the asset type 'alias' in the destination stage during asset promotion. The default value is 'false'. This parameter takes precedence over the 'overwrite' parameter. (optional)

    • createRule

      Rule createRule(@NotNull @NotNull Rule body)

      The method creates a conditional rule in API Gateway. The API request body must contain the payload for the rule.

      Parameter:
      body - (required)

    • createStage

      Stage createStage(@NotNull @NotNull Stage body)

      This REST operation is used to configure a stage in the source API Gateway where promotion will be initiated. A stage is just another API Gateway instance. When the stage url is https, then keystore and keystore alias will also be expected while configuring a stage

      Parameter:
      body - Stage request payload (required)

    • createStrategy

      OneOfStrategyModel createStrategy(@NotNull @NotNull StrategyRequest body)

      The method creates a strategy in API Gateway. The API request body must contain the payload for the strategy

      Parameter:
      body - This parameter describes the request payload of a strategy that is to be created in API Gateway. (required)

    • createSubscription

      Application createSubscription(@Nullable @Nullable SubscriptionRequest body)

      This endpoint is used to create subscription for specified package and plan in the request. If the approval is enabled, the response will not contain the API key but the application id will be available to retrieve the API key later. A approval request will be created in API gateway to approve the subscription. Once the request is approved the application will be provided with an API key. Then you can use subscriptions/{applicationId} GET HTTP method to get the API key

      Parameter:
      body - (optional)

    • createTruststore

      TrustStore createTruststore(@NotNull @NotNull String keyStoreName, @NotNull @NotNull String keyStoreType, @NotNull @NotNull String keyStorePassword, @NotNull @NotNull String uploadFileName, @NotNull @NotNull File fileContent, @Nullable @Nullable String keyStoreDescription, @Nullable @Nullable String isPwdBase64Encoded)

      Creates a truststore in API Gateway.

      Parameter:
      keyStoreName - The name of the truststore. It cannot contain spaces or special characters. The name of the trust store must be unique across all the truststores created in API Gateway. (required)
      keyStoreType - The certificate file format of the truststore. (required)
      keyStorePassword - The truststore password that is defined at the time of truststore creation using a keystore utility. (required)
      uploadFileName - The name of the truststore file that will be used to save the truststore internally in API Gateway. (required)
      fileContent - The contents of the truststore file. (required)
      keyStoreDescription - The description for the truststore. (optional)
      isPwdBase64Encoded - Specifies whether password is base 64 encoded. (optional)

    • createURLALias

      URLAliasSettings createURLALias(@NotNull @NotNull URLAliasSettings body)

      Creates a new URL Alias in API Gateway.

      Parameter:
      body - The request body for creating a new URL Alias in API Gateway. (required)

    • createUser

      User createUser(@NotNull @NotNull User body)

      The method creates an user in API Gateway. The API request body must contain the payload for the user.

      Parameter:
      body - This parameter describes the request payload of a user that is to be created in API Gateway. (required)

    • createVersion

      ModelAPIResponse createVersion(@NotNull @NotNull String apiId, @NotNull @NotNull InputVersion body)

      Create a new version of an API and retain applications if required

      Parameter:
      apiId - API Id for the API to be versioned (required)
      body - Create version request payload (required)

    • createWebhook

      Webhook createWebhook(@NotNull @NotNull Webhook body)

      The method creates a webhook in API Gateway. The API request body must contain the payload of the webhook that needs to be saved.

      Parameter:
      body - (required)

    • createWebserviceEndpoint

      WebserviceEndpointAlias createWebserviceEndpoint(@NotNull @NotNull WebserviceEndpointAlias body)

      The method creates a Webservice endpoint in API Gateway. The API request body must contain the payload for the Webservice endpoint

      Parameter:
      body - (required)

    • deactivateAPI

      ModelAPIResponse deactivateAPI(@NotNull @NotNull String apiId)

      Deactivate an API so that API is not exposed to consumers

      Parameter:
      apiId - API Id for the API to be deactivated (required)

    • deactivateGlobalPolicyByPolicyID

      Policy deactivateGlobalPolicyByPolicyID(@NotNull @NotNull String policyId)

      This REST request is used to deactivate a global policy and it doesn't require any request body. This request tries to deactivate the global policy and if any error occurs during deactivation will be reported as response or if the global policy deactivated the policy details of a global policy with active flag set to false is sent as response. An active global policy cannot have conflicts with other active global policy and hence the deactivation fails only when the conflict occurs between active global policy that is specified and one or more applicable active APIs. This can happen when the applicable active API policy action might depend on one or more policy action from the specified global policy. If you deactivate this policy, it would cause the active API to have an unstable state. Hence the deactivation is reported as failed in this case.

      Parameter:
      policyId - The path parameter should be the policy id of global policy that needs to be deactivated. If the policy id is not belongs to a global policy then error will be reported (required)

    • deactivatePackageByPackageId

      PackageResponseContainer deactivatePackageByPackageId(@NotNull @NotNull String packageId)

      This request is used to deactivate the package. Once the package is deactivated, it will remove the authentication policy added or revert the authentication policy to original state in the API. If there are multiple packages associated to an API then the IAM policy will have the behaviour of having API key as application identification condition along with other application identification condition if any selected till last associated package is deactivated.

      Parameter:
      packageId - package id which needs to be deactivated (required)

    • deactivateRule

      Rule deactivateRule(@NotNull @NotNull String ruleId)

      This REST request is used to deactivate a rule and it doesn't require any request body.

      Parameter:
      ruleId - The path parameter should be the id of rule that needs to be deactivated. (required)

    • deleteAPI

      APIResponseDelete deleteAPI(@NotNull @NotNull String apiId, @Nullable @Nullable Boolean forceDelete)

      Delete the inactive API

      Parameter:
      apiId - API Id for the API to be deleted (required)
      forceDelete - Flag for force delete. Required when API is associated with some applications (optional, defaults to true)

    • deleteAPIPortalConfiguration

      void deleteAPIPortalConfiguration(@NotNull @NotNull String portalGatewayId)

      This API allows you to delete an API Portal configuration in API Gateway.

      Parameter:
      portalGatewayId - Id of the API Portal configuration for delete. (required)

    • deleteAPIs

      List<APIResponseDelete> deleteAPIs(@NotNull @NotNull String apiIds, @Nullable @Nullable Boolean forceDelete)

      Delete the inactive APIs

      Parameter:
      apiIds - API Ids for the APIs to be deleted. Multiple API ids combined by comma (required)
      forceDelete - Flag for force delete. Required when API is associated with some applications (optional, defaults to true)

    • deleteAccessProfile

      void deleteAccessProfile(@NotNull @NotNull String accessProfileId)

      The method deletes a team from API Gateway.

      Parameter:
      accessProfileId - This parameter specifies the ID of a team that is to be deleted in API Gateway. (required)

    • deleteAlias

      void deleteAlias(@NotNull @NotNull String aliasId)

      The method deletes an alias from API Gateway.

      Parameter:
      aliasId - The path parameter specifies the id of an alias that is to be deleted from API Gateway. (required)

    • deleteApplic

      void deleteApplic(@NotNull @NotNull String applicationId)

      The method deletes the specified application in API Gateway.

      Parameter:
      applicationId - This parameter specifies the ID of an application to be deleted. (required)

    • deleteApplications

      void deleteApplications(@Nullable @Nullable String ids)

      The method deletes the specified applications in API Gateway.

      Parameter:
      ids - You can delete multiple applications using the query parameter 'ids' by providing the ids as comma-separated values. Example: /applications?ids=375db639-01f7-4488-b14f-09daae622e18,afb0b5c0-0b0e-4d44-b139-e64d0dbf028c (optional)

    • deleteApprovalConfiguration

      void deleteApprovalConfiguration(@NotNull @NotNull String id)

      The method deletes the specified approval configuration in API Gateway.

      Parameter:
      id - This parameter specifies the ID of an approval configuration that is to be deleted in API Gateway. (required)

    • deleteApprovalRequest

      void deleteApprovalRequest(@NotNull @NotNull String approvalId)

      Delete the Approval Request with the given approvalId

      Parameter:
      approvalId - Approval Request Id for the Approval Request to be deleted (required)

    • deleteAssertion

      void deleteAssertion(@NotNull @NotNull String assertionId)

      This delete request will delete the assertion based on the assertion id which is specified in path

      Parameter:
      assertionId - This path parameter is used to specify the assertion id for which assertion needs to deleted. (required)

    • deleteCacheDetailsByapiNameAndVersion

      void deleteCacheDetailsByapiNameAndVersion(@NotNull @NotNull String apiName, @NotNull @NotNull String apiVersion)

      This REST Request is used to request for deletion of Service Result cache for the API using apiName and apiVersion

      Parameter:
      apiName - This query parameter is used to specify the API name for which the service result cache deletion is requsted. (required)
      apiVersion - The version of the apiName parameter specified (required)

    • deleteCacheDetailsbyAPIId

      void deleteCacheDetailsbyAPIId(@NotNull @NotNull String apiId)

      This REST Request is used to request for deletion of Service Result Cache for the API using api id

      Parameter:
      apiId - The id of API for which the Service Result Cache deletion is requested (required)

    • deleteDeniedIPs

      void deleteDeniedIPs(@NotNull @NotNull String IP)

      This DELETE method is used to remove the IP from Denied IPs list. Once removed the request from IP will be processed.

      Parameter:
      IP - (required)

    • deleteDocument

      void deleteDocument(@NotNull @NotNull String documentId)

      Deletes the stored document from API Gateway

      Parameter:
      documentId - Id of the document for deletion (required)

    • deleteGroup

      void deleteGroup(@NotNull @NotNull String groupId)

      The method deletes a group from API Gateway.

      Parameter:
      groupId - The path parameter specifies the id of a group that is to be deleted from API Gateway. (required)

    • deleteJMSConnection

      void deleteJMSConnection(@NotNull @NotNull String jmsConnId)

      This delete request will delete the JMS connection based on the JMS connection id which is specified in path

      Parameter:
      jmsConnId - This path parameter is used to specify the JMS connection id for which JMS connection needs to deleted. (required)

    • deleteJNDI

      void deleteJNDI(@NotNull @NotNull String jndiId)

      This delete request will delete the JNDI configuration based on the JNDI id which is specified in path

      Parameter:
      jndiId - This path parameter is used to specify the JNDI id for which JNDI configuration needs to deleted. (required)

    • deleteKeystore

      List<KeyStore> deleteKeystore(@NotNull @NotNull String keyStoreName)

      Deletes keystore matching the specified name in API Gateway.

      Parameter:
      keyStoreName - Keystore name to identify the corresponding Keystore (required)

    • deleteOAuthScope

      void deleteOAuthScope(@NotNull @NotNull String oauthScopeId)

      This method deletes the requested OAuth scope mapping.

      Parameter:
      oauthScopeId - The path parameter specifies the id of an OAuth scope mapping that is to be deleted from API Gateway. (required)

    • deleteOutboundProxy

      void deleteOutboundProxy(@NotNull @NotNull String outboundproxyAlias)

      Deletes the specified outbound proxy server alias from API Gateway.

      Parameter:
      outboundproxyAlias - The outbound proxy server alias to be deleted (required)

    • deletePackageById

      void deletePackageById(@NotNull @NotNull String packageId)

      Deletes package from API gateway. Also deletes the association of plans and APIs to that package.

      Parameter:
      packageId - Id of the Package (required)

    • deletePlanById

      void deletePlanById(@NotNull @NotNull String planId)

      This request is used to delete the plan by plan id. Before deleting the plan, the plan should removed from all of its associated packages else API gateway will not allow the plan to be deleted. You can use /packages/{packageId} resource dis associate the plan from its corresponding packages. The associated rate limit and quota policy will be deleted automatically when the plan is deleted.

      Parameter:
      planId - Id of a Plan (required)

    • deletePolicyAction

      void deletePolicyAction(@NotNull @NotNull String policyActionId)

      This delete request will delete the policy action based on the policy action id which is specified in path

      Parameter:
      policyActionId - Policy Action ID (required)

    • deletePolicyByID

      void deletePolicyByID(@NotNull @NotNull String policyId)

      This REST request is used to delete the policy from API gateway. This request will automatically delete the associated policy action for this policy

      Parameter:
      policyId - This path parameter is used to specify the policy id that needs to be deleted. If the policy id specified is global policy then it needs to be in inactive state to delete. Active global policy and global policy with systemPolicy property set to true cannot be deleted. (required)

    • deletePort

      void deletePort(@Nullable @Nullable String pkg, @Nullable @Nullable String listenerKey)

      The DELETE method removes a port configuration

      Parameter:
      pkg - The pkg parameter points to the IS package the port is pointing to. The pkg of port configurations is restricted to the package WmRoot. (optional)
      listenerKey - The listenerKey parameter uniquely identifies a port configuration within a package. (optional)

    • deletePromotion

      void deletePromotion(@NotNull @NotNull String promotionId)

      Delete the promotion

      Parameter:
      promotionId - Promotion Id for the promotion to be deleted (required)

    • deleteRollback

      void deleteRollback(@NotNull @NotNull String rollbackId)

      Delete the rollback

      Parameter:
      rollbackId - Rollback Id for the rollback to be deleted (required)

    • deleteRule

      void deleteRule(@NotNull @NotNull String ruleId)

      The method deletes a rule from API Gateway.

      Parameter:
      ruleId - The path parameter specifies the id of a rule that is to be deleted from API Gateway. (required)

    • deleteStage

      void deleteStage(@NotNull @NotNull String stageId)

      Delete the stage

      Parameter:
      stageId - Stage Id for the stage to be deleted (required)

    • deleteStrategy

      void deleteStrategy(@Nullable @Nullable String ids)

      The method deletes the specified strategy in API Gateway.

      Parameter:
      ids - This parameter specifies the ID of a strategy that is to be deleted in API Gateway. (optional)

    • deleteSubscriptionBySubscriptionID

      void deleteSubscriptionBySubscriptionID(@NotNull @NotNull String applicationId)

      This endpoint is used to deleted subscriptions created in API Gateway. If approval is enabled for deletion of subscription then the a request will be created to approve. Till the request get approved the application will be suspended. If the delete request is approved then the application will be deleted and if the delete request is rejected then the application will be resumed from suspend state.

      Parameter:
      applicationId - Application id to delete the application (required)

    • deleteTruststore

      void deleteTruststore(@NotNull @NotNull String trustStoreName)

      Deletes an already existing truststore matching the name in API Gateway.

      Parameter:
      trustStoreName - Truststore name to identify the corresponding trust store to delete in API Gateway (required)

    • deleteURLAlias

      void deleteURLAlias(@NotNull @NotNull String alias)

      The method deletes an URL alias in API Gateway.

      Parameter:
      alias - The name of the URL alias to be deleted. (required)

    • deleteUser

      void deleteUser(@NotNull @NotNull String userId)

      This HTTP request deletes the specified application in API Gateway.

      Parameter:
      userId - This parameter specifies the ID of an application that is to be deleted in API Gateway. (required)

    • deleteWebhook

      void deleteWebhook(@NotNull @NotNull String id)

      The method deletes a webhook resource from API Gateway.

      Parameter:
      id - This parameter specifies the id of the webhook that is to be deleted in API Gateway. (required)

    • deleteWebserviceEndpoint

      void deleteWebserviceEndpoint(@NotNull @NotNull String webserviceEndpointId)

      This delete request will delete the Webservice endpoint based on the Webservice endpoint id which is specified in path

      Parameter:
      webserviceEndpointId - This path parameter is used to specify the Webservice endpoint id for which Webservice endpoint needs to deleted. (required)

    • disableJMSConnection

      void disableJMSConnection(@NotNull @NotNull String jmsConnId)

      The method disables the specified JMS connections in API Gateway.

      Parameter:
      jmsConnId - This path parameter is used to specify the JMS connection id which JMS connection needs to be disabled. (required)

    • disableJMSTrigger

      void disableJMSTrigger(@NotNull @NotNull String jmsTriggerId)

      The method disables the specified JMS trigger in API Gateway.

      Parameter:
      jmsTriggerId - This path parameter is used to specify the JMS trigger id which JMS trigger needs to be disabled. (required)

    • disableMockAPI

      ModelAPIResponse disableMockAPI(@NotNull @NotNull String apiId)

      Once API is disabled from mocking capability, at runtime all the API invocations are redirected to the native service instead of sending the mocked response

      Parameter:
      apiId - API Id for the API to be deactivated (required)

    • disableOutboundProxy

      void disableOutboundProxy(@NotNull @NotNull String outboundproxyAlias)

      Disables an already existing outbound proxy server alias in API Gateway.

      Parameter:
      outboundproxyAlias - The outbound proxy server alias to be disabled (required)

    • disablePort

      MessageWithPortReference disablePort(@NotNull @NotNull PortReference body)

      The PUT disables the referenced port configuration. A disabled port can not be contacted.

      Parameter:
      body - The request body references the existing port configuration to be disabled. (required)

    • disableThreatProtectionRuleByPolicyID

      Policy disableThreatProtectionRuleByPolicyID(@NotNull @NotNull String policyId)

      This REST request is used to disable the Threat protection rule created in API Gateway. This request does not require any request body. If the threat protection policy is disabled successfully then the policy details of specified policy will be sent as response.

      Parameter:
      policyId - This path parameter is used to specify the policy id of the threat protection policy which needs to be disabled (required)

    • disableTracing

      GatewayAPI disableTracing(@NotNull @NotNull String apiId)

      Disable tracing for an API

      Parameter:
      apiId - API Id for the API for which tracing is disabled (required)

    • doRollback

      Rollback doRollback(@NotNull @NotNull String rollbackId)

      This REST operation is used to rollback the assets to the previous state i.e the state prior to promotion. Rollback should be initiated from the local gateway instance.

      Parameter:
      rollbackId - Rollback Id for the promotion to be rollbacked (required)

    • downloadAPITransaction

      void downloadAPITransaction(@NotNull @NotNull String startDate, @NotNull @NotNull String endDate, @NotNull @NotNull String eventType, @Nullable @Nullable String duration)

      The GET method is used to download the api transactions of the specified type. Data to be downloaded is filtered based on the input parameters. The user must either be a part of API-Gateway-Administrators group or must have the 'Manage purge and restore runtime events' privilege to perform this operation.

      Parameter:
      startDate - This is a date parameter. All the api transactions of the specified type which satisfies the startDate and endDate criteria are downloaded. Ex: startDate=2017-12-18 00:00:00 and endDate=2017-12-19 00:00:00. Either one of (startDate and endDate) or duration is a mandatory parameter (required)
      endDate - This is a date parameter. All the api transactions of the specified type which satisfies the startDate and endDate criteria are downloaded. Ex: startDate=2017-12-18 00:00:00 and endDate=2017-12-19 00:00:00. Either one of (startDate and endDate) or duration is a mandatory parameter (required)
      eventType - This parameter is used to specify the event type to be downloaded. Specify eventType=ALL to download all the events. To download events of a specific type, specify the required event type Ex: eventType=transactionalEvents. The available event types are as follows 1.transactionalEvents 2.monitorEvents 3.errorEvents 4.performanceMetrics 5.threatProtectionEvents 6.lifecycleEvents 7.policyViolationEvents 8.auditlogs 9.applicationlogs 10.mediatorTraceSpan 11.serverLogTraceSpan (required)
      duration - All the api transactions of the specified type that are older than the value specified are downloaded. Ex: duration='2d'. Possible types are d(days),M(months),y(years), For Example a) 2d means 2days b) 1M means 1 month c) 1y means 1 year. Either one of (startDate&endDate) or duration is a mandatory parameter (optional)

    • downloadLogs

      void downloadLogs()

      This resource is used to download logs from different components used by APIGateway, server configurations and thread dumps.

    • downloadProviderSpecification

      APIResponseGetAPI downloadProviderSpecification(@NotNull @NotNull String apiId, @NotNull @NotNull String format)

      Downloads the provider specification of REST, SOAP and GraphQL based APIs. Provider specification is nothing but, the specification file (in swagger, graphql or wsdl format) with out the concrete API Gateway endpoint and contains all resources/methods/operation irrespective of whether they are exposed to consumer

      Parameter:
      apiId - API Id for the API to retrieve the versions (required)
      format - Output format of the API specification. For REST APIs the value is 'swagger'; for SOAP APIs use the value as 'wsdl';for GraphQL APIs use the value as 'graphql' (required)

    • enableJMSConnection

      void enableJMSConnection(@NotNull @NotNull String jmsConnId)

      The method enables the specified JMS connections in API Gateway.

      Parameter:
      jmsConnId - This path parameter is used to specify the JMS connection id which JMS connection needs to be enabled. (required)

    • enableJMSTrigger

      void enableJMSTrigger(@NotNull @NotNull String jmsTriggerId)

      The method enables the specified JMS trigger in API Gateway.

      Parameter:
      jmsTriggerId - This path parameter is used to specify the JMS trigger id which JMS trigger needs to be enabled. (required)

    • enableMockAPI

      ModelAPIResponse enableMockAPI(@NotNull @NotNull String apiId, @Nullable @Nullable Boolean retainDefaultMockResponses)

      In API Gateway, you can mock an API implementation. API Gateway lets you mock an API by simulating the native service. API Mocking is useful feature in API first approach, where in the provider may choose to expose the mocked API to the consumers when the actual API doesn't exist or isn't complete. In API Gateway, when you enable mocking for an API, a default mock response is created for each combination of resource, operation, status code and content-type based on the example and schema set in the API definition. As an API Provider, you can add or modify the default mock responses. You can specify conditions at the operation level and configure IS services at the API level for a mocked API in the update API operation. At runtime, when the mocked API is invoked instead of calling the native service, API Gateway returns the mocked response to the consumer based on the below priorities: 1. If any of the conditions for the invoked operation satisfies, API Gateway returns the associated mocked response. 2. If no condition is specified or none of the condition for the invoked operation is satisfied, then API Gateway will return a. the response from an IS service, if an IS service is configured b. default mocked response, if no IS services are configured

      Parameter:
      apiId - API Id for the API to be activated (required)
      retainDefaultMockResponses - Flag to retain generated mocked responses. When this is set to true, default mocked responses will be retained. If it's set to false, new default mocked responses will be generated using the examples, schema in the API (optional, defaults to false)

    • enableOutboundProxy

      void enableOutboundProxy(@NotNull @NotNull String outboundproxyAlias)

      Enables an already existing outbound proxy server alias in API Gateway.

      Parameter:
      outboundproxyAlias - The outbound proxy server alias to be enabled (required)

    • enablePort

      PortReference enablePort(@Nullable @Nullable PortReference body)

      The PUT enables the referenced port configuration. Only enabled ports can be contacted and serve requests.

      Parameter:
      body - The request body references the existing port configuration to be enabled. (optional)

    • enableThreatProtectionRuleByPolicyID

      Policy enableThreatProtectionRuleByPolicyID(@NotNull @NotNull String policyId)

      This REST request is used to enable the Threat protection rule created in API Gateway. This request does not require any request body. If the threat protection policy is enabled successfully then the policy details of specified policy is sent as response

      Parameter:
      policyId - This path parameter is used to specify the policy id of the threat protection policy which needs to be enabled (required)

    • engineGet

      HealthCheckEngineResult engineGet()
      Perform core health check

      Perform health check for core parts of API Gateway, such as Elasticsearch store, cluster environment and Integration Server health.

    • exchangeIDToken

      ServiceOutput exchangeIDToken(@NotNull @NotNull ServiceInput body)

      Generate an access token for the given ID Token

      Parameter:
      body - This parameter describes the request payload of an application that is to be created in API Gateway. (required)

    • exportApiGatewayAssets

      void exportApiGatewayAssets(@Nullable @Nullable String includeApplications, @Nullable @Nullable String includeUsers, @Nullable @Nullable String includeGroups, @Nullable @Nullable String includeTruststores, @Nullable @Nullable List<String> policies, @Nullable @Nullable List<String> apis, @Nullable @Nullable List<String> aliases, @Nullable @Nullable List<String> applications, @Nullable @Nullable List<String> policyActions, @Nullable @Nullable List<String> approvalConfigurations, @Nullable @Nullable List<String> outboundProxies, @Nullable @Nullable List<String> urlAliases, @Nullable @Nullable List<String> keyStores, @Nullable @Nullable List<String> trustStores, @Nullable @Nullable List<String> jnDIProviderAliases, @Nullable @Nullable List<String> jmSConnectionAliases, @Nullable @Nullable List<String> jmSTriggers, @Nullable @Nullable List<String> webserviceEndpointAliases, @Nullable @Nullable List<String> users, @Nullable @Nullable List<String> groups, @Nullable @Nullable List<String> accessProfiles, @Nullable @Nullable String kerberosSetting, @Nullable @Nullable List<String> plans, @Nullable @Nullable List<String> packages, @Nullable @Nullable List<String> portalGateways, @Nullable @Nullable List<String> configurations, @Nullable @Nullable List<String> gatewayScopes)

      The GET method exports an archive. The result of the GET request is an archive in a ZIP format. This Method supports exporting API, Application, Alias,Policy, Policy Action, Keystore, Truststore, Kerberos, User, Group, Team, JMS Connection, JNDI Provider, JMS Trigger, Webservice Endpoint Alias, Approval Configuration, Outbound Proxy, URL alias, Plan and Package. This GET method can be used for exporting specific type of assets and its optional/soft dependant assets by specifying the asset name and corresponding include options in query parameter. For example, for an API, the Application assets (used by the API) are soft dependant of that API. To export the dependant applications of an API use the query param 'include-applications'.If 'include-applications' is not provided, the export archive will contains only the APIs. Refer 'Parameters' section for the usage of each include parameters. Use the POST /archive method to export all the assets in API Gateway.

      Parameter:
      includeApplications - This parameter indicates whether you want to export the applications associated with the APIs (optional)
      includeUsers - This parameter indicates whether you want to export users associated with the groups and/or with the password expiry settings (optional)
      includeGroups - This parameter indicates whether you want to export groups associated with the teams (optional)
      includeTruststores - This parameter indicates whether you want to export truststore alias associated with the email configuration (optional)
      policies - This parameter identifies the policies to be exported. The wildcard "*" selects all the policies. For example a single policy can be exported with its id using the following request: GET /rest/apigateway/archive?policies=07b8d7b7-20b7-422e-8464-4b19d405c41a Whereas, all the policies can be exported using the following request: GET /rest/apigateway/archive?policies=* (optional)
      apis - This parameter identifies the APIs to be exported. The wildcard "*" selects all the APIs. For example a single API can be exported using the following request: GET /rest/apigateway/archive?apis=e2996867-af49-4ac6-98e7-cba48837c13e Whereas, all the APIs can be exported using the following request: GET /rest/apigateway/archive?apis=* (optional)
      aliases - This parameter identifies the aliases to be exported. The wildcard "*" selects all aliases. For example, a single alias can be exported using the following requrest: GET /rest/apigateway/archive?aliases=d1885756-9e38-39b5-87d6-ba937726b02d Whereas, all the APIs can be exported using the following request: GET /rest/apigateway/archive?alias=* (optional)
      applications - This parameter identifies the applications to be exported. The wildcard "*" selects all applications. For example, a single application can be exported using the following requrest: GET /rest/apigateway/archive?applications=d1885756-9e38-39b5-87d6-ba937726b02d Whereas, all the applications can be exported using the following request: GET /rest/apigateway/archive?applications=* (optional)
      policyActions - This parameter identifies the policy actions to be exported. The wildcard "*" selects all policy actions. For example, a single policy action can be exported using the following request: GET /rest/apigateway/archive?policyActions=20ca1e24-d6b2-430d-adf8-7a53a6cbaa53 Whereas, all the policy actions can be exported using the following request: GET /rest/apigateway/archive?policyActions=* (optional)
      approvalConfigurations - This parameter identifies the approval configurations to be exported. The wildcard "*" selects all approval configurations. For example, a single approval configuration can be exported using the following request: GET /rest/apigateway/archive?approvalConfigurations=createApplication Whereas, all the approval configurations can be exported using the following request: GET /rest/apigateway/archive?approvalConfigurations=* (optional)
      outboundProxies - This parameter identifies the outbound proxy aliases to be exported. outbound proxy aliases are identified with it's name. The wildcard "*" selects all the outbound proxy aliases. For example a single outbound proxy alias can be exported using the following request: GET /rest/apigateway/archive?outboundProxies=testOutboundProxyAlias Whereas, all the outbound proxy aliases can be exported using the following request: GET /rest/apigateway/archive?outboundProxies=* (optional)
      urlAliases - This parameter identifies the URL aliases to be exported. URL aliases are identified with it's name. The wildcard "*" selects all the URL aliases. For example, a single URL alias can be exported using the following request: GET /rest/apigateway/archive?urlAliases=testUrlAlias Whereas, all the URL aliases can be exported using the following request: GET /rest/apigateway/archive?testUrlAlias=* (optional)
      keyStores - This parameter identifies the keystore aliases to be exported. Keystore aliases are identified with it's name. The wildcard "*" selects all the keystore aliases. For example, a single keystore alias can be exported using the following request: GET /rest/apigateway/archive?keyStores=test_keystore Whereas, all the keystore aliases can be exported using the following request: GET /rest/apigateway/archive?keyStores=* (optional)
      trustStores - This parameter identifies the truststore aliases to be exported. Truststore aliases are identified with it's name. The wildcard "*" selects all the truststore aliases. For example, a single truststore alias can be exported using the following request: GET /rest/apigateway/archive?trustStores=test_truststore Whereas, all the truststore aliases can be exported using the following request: GET /rest/apigateway/archive?trustStores=* (optional)
      jnDIProviderAliases - This parameter identifies the JNDI provider aliases to be exported. JNDI provider aliases are identified with it's name. The wildcard "*" selects all the JNDI provider aliases. For example, a single JNDI provider alias can be exported using the following request: GET /rest/apigateway/archive?JNDIProviderAliases=test_jndiProviderAlias Whereas, all the JNDI provider aliases can be exported using the following request: GET /rest/apigateway/archive?JNDIProviderAliases=* (optional)
      jmSConnectionAliases - This parameter identifies the JMS connection aliases to be exported. JMS connection aliases are identified with it's name. The wildcard "*" selects all the JNDI provider aliases. For example, a single JNDI provider alias can be exported using the following request: GET /rest/apigateway/archive?JMSConnectionAliases=test_jmsConnectionAlias Whereas, all the JMS connection aliases can be exported using the following request: GET /rest/apigateway/archive?JMSConnectionAliases=* (optional)
      jmSTriggers - This parameter identifies the JMS triggers to be exported. JMS triggers are identified with it's name. The wildcard "*" selects all the JMS triggers. For example, a single JMS trigger can be exported using the following request: GET /rest/apigateway/archive?JMSTriggers=test_jmsTrigger Whereas, all the JMS triggers can be exported using the following request: GET /rest/apigateway/archive?JMSTriggers=* (optional)
      webserviceEndpointAliases - This parameter identifies the 'web service endpoint' aliases to be exported. Web service endpoint aliases are identified with it's name. The wildcard "*" selects all the web service endpoint aliases. For example, a single web service endpoint alias can be exported using the following request: GET /rest/apigateway/archive?webserviceEndpointAliases=test_wsEndpointAlias Whereas, all the JMS triggers can be exported using the following request: GET /rest/apigateway/archive?webserviceEndpointAliases=* (optional)
      users - This parameter identifies the users to be exported. The wildcard "*" selects all the users. For example, a single user can be exported using the following request: GET /rest/apigateway/archive?users=7a6d3d40-44d8-4ab1-83df-5be63cdbae54 Whereas, all the users can be exported using the following request: GET /rest/apigateway/archive?users=* (optional)
      groups - This parameter identifies the groups to be exported. The wildcard "*" selects all the groups. For example, a single group can be exported using the following request: GET /rest/apigateway/archive?groups=d6b38ff8-59a8-47bf-9fba-0bdb24ee5b48 Whereas, all the groups can be exported using the following request: GET /rest/apigateway/archive?groups=* (optional)
      accessProfiles - This parameter identifies the teams to be exported. The wildcard "*" selects all the teams. For example, a single team can be exported using the following request: GET /rest/apigateway/archive?accessProfiles=d6b38ff8-59a8-47bf-9fba-0bdb24ee5b48 Whereas, all the teams can be exported using the following request: GET /rest/apigateway/archive?accessProfiles=* (optional)
      kerberosSetting - This parameter identifies the kerberos configuration to be exported. The kerberos configuration can be exported using the following request: GET /rest/apigateway/archive?kerberosSetting=kerberosSetting (optional)
      plans - This parameter identifies the plans to be exported. The wildcard "*" selects all the plans. For example, a single plan can be exported using the following request: GET /rest/apigateway/archive?plans=86d58023-be4b-4735-a08f-14e78131ce4a Whereas, all the plans can be exported using the following request: GET /rest/apigateway/archive?plans=* (optional)
      packages - This parameter identifies the packages to be exported. The wildcard "*" selects all the packages. For example, a single package can be exported using the following request: GET /rest/apigateway/archive?packages=73c93393-1477-4a99-9e44-c9b3e679de0c Whereas, all the packages can be exported using the following request: GET /rest/apigateway/archive?packages=* (optional)
      portalGateways - This parameter identifies the portal configurations to be exported. The wildcard "*" selects all portal configurations. For example, a single portal configuration can be exported using the following requrest: GET /rest/apigateway/archive?portalGateways=ae196583-d109-4e9e-b593-dd7b984fe8ca Whereas, all the portal configurations can be exported using the following request: GET /rest/apigateway/archive?portalGateways=* (optional)
      configurations - This parameter identifies the configurations to be exported. The wildcard "*" selects all the configurations. For example, a single configuration can be exported using the following request: GET /rest/apigateway/archive?configurations=loadBalancer,customContentTypes Whereas, all the configurations can be exported using the following request: GET /rest/apigateway/archive?configurations=* (optional)
      gatewayScopes - This parameter identifies the oauth scopes to be exported. The wildcard "*" selects all the oauth scopes. For example, a single oauth scope can be exported using the following request: GET /rest/apigateway/archive?gatewayScopes=73c93393-1477-4a99-9e44-c9b3e679de0c Whereas, all the oauth scopes can be exported using the following request: GET /rest/apigateway/archive?gatewayScopes=* (optional)

    • externalServicesGet

      HealthCheckExternalResult externalServicesGet()
      Perform health check on all external destinations and resources

      Perform health check for configured external resources.

    • fetchJNDITemplates

      void fetchJNDITemplates()

      The method retrieves list of all JNDI templates in API Gateway.

    • gatewayEndpoints

      ModelAPIResponse gatewayEndpoints(@NotNull @NotNull String apiId, @NotNull @NotNull InputGatewayEndpoints body)

      This operation can be used to create / update / delete a custom gateway endpoing of an API

      Parameter:
      apiId - API Id for the API to be updated (required)
      body - API Gateway endpoints request payload (required)

    • getAPI

      APIResponseGetAPI getAPI(@NotNull @NotNull String apiId, @Nullable @Nullable String format, @Nullable @Nullable String url)

      Retrieve an API based on the API id.

      Parameter:
      apiId - API Id for the API to be retrieved (required)
      format - Output format of the API. If the value is 'swagger', you get a API definition in swagger format. If the value is 'raml', you get a raml document. If the value is 'openapi', you get a open API document. If the value is 'odata', you get a zip file holding the OData metadata and service document. (optional)
      url - User selected endpoint for API definition in swagger/raml format. (optional)

    • getAPICallbackProcessorSettings

      CallbackProcessorSettings getAPICallbackProcessorSettings()

      This method retrieves the API callback processor settings from API Gateway.

    • getAPIPortalAsDestination

      Destination getAPIPortalAsDestination()

      The method retrieves the details of the API Portal destination configurations. API Gateway can publish events and performance metrics data. By default, error events, lifecycle events, policy violation event, and performance data are published to API Portal.

    • getAPIPortalConfiguration

      PortalGateway getAPIPortalConfiguration(@NotNull @NotNull String portalGatewayId)

      This API allows you to retrieve an API Portal configuration in API Gateway.

      Parameter:
      portalGatewayId - Id of the API Portal configuration for retrieval (required)

    • getAPIPortalMetadata

      PortalGatewayCommunitiesData getAPIPortalMetadata(@NotNull @NotNull String portalGatewayId, @NotNull @NotNull String apiId)

      This API allows you to retrieve the details about communities in API Portal. An API can be published from API Gateway to any of the communities available in API Portal

      Parameter:
      portalGatewayId - Id of the API Portal configuration for retrieval of the community information (required)
      apiId - Id of the API published from API Gateway to API Portal (required)

    • getAPIs

      APIResponsesModel getAPIs(@Nullable @Nullable String apiIds, @Nullable @Nullable Integer from, @Nullable @Nullable Integer size)

      Get all APIs or subset of APIs

      Parameter:
      apiIds - API Ids for the API to be retrieved (optional)
      from - Starting index from the list of APIs to be retrieved (optional)
      size - Number of APIs to be retrieved (optional)

    • getAPIsForPackageById

      PackageAPIsResponseContainer getAPIsForPackageById(@NotNull @NotNull String packageId)

      To get list of all APIs associated for a given package id

      Parameter:
      packageId - Id of the Package (required)

    • getAccessProfile

      AccessProfile getAccessProfile(@NotNull @NotNull String accessProfileId)

      The method retrieves the details of a team in API Gateway.

      Parameter:
      accessProfileId - The path parameter specifies the id of a team whose details are to be retrieved. (required)

    • getAccessProfiles

      AccessProfile getAccessProfiles()

      The method retrieves list of all teams in API Gateway.

    • getAccessTokenEndpoints

      void getAccessTokenEndpoints(@NotNull @NotNull String applicationId)

      The method retrieves a map of access token endpoints for all the authorization servers configured

      Parameter:
      applicationId - This parameter specifies the ID of an application whose access token endpoints are to be retrieved from API Gateway. (required)

    • getAccountLockSettings

      AccountLockSettings getAccountLockSettings()

      Retrieves the account lock settings configured in API Gateway

    • getAlias

      Alias getAlias(@NotNull @NotNull String aliasId)

      The method retrieves the details of an alias in API Gateway.

      Parameter:
      aliasId - The path parameter specifies the id of an alias whose details are to be retrieved. (required)

    • getAllAPIPortalConfiguration

      PortalGateway getAllAPIPortalConfiguration()

      This API allows you to retrieve API Portal configurations available in API Gateway.

    • getAllAlias

      List<Alias> getAllAlias()

      The method retrieves a list of all aliases in API Gateway.

    • getAllAssertions

      AssertionConfiguration getAllAssertions()

      This request will return all the assertions from API Gateway

    • getAllJMSConnections

      void getAllJMSConnections()

      The method retrieves list of all the JMS connections in API Gateway.

    • getAllJMSTriggers

      void getAllJMSTriggers()

      The method retrieves list of all JMS triggers in API Gateway.

    • getAllPackages

      PackageGetAllResponseContainer getAllPackages()

      To get all package details from API Gateway

    • getAllPlans

      PlanGetAllResponse getAllPlans()

      This REST request is used to retrieve list of all plans from API Gateway along with its rate limit and quota as policies. Also it will list down the associated packageIds for each plan in the response. You can use /policies/{policyId} to retrieve the rate limit and quota policy details and /packages/{packageId} to retrieve the package details

    • getAllPolicyActions

      List<PolicyAction> getAllPolicyActions(@Nullable @Nullable String policyActionIds)

      This request will return all the policy actions from API Gateway

      Parameter:
      policyActionIds - This is a query parameter. Provide comma separated Policy Action ids to get the policy action details for specified policy action ids (optional)

    • getAllRule

      List<Rule> getAllRule(@Nullable @Nullable String ruleType, @Nullable @Nullable String active)

      The method retrieves list of all rules in API Gateway.

      Parameter:
      ruleType - ruleType : if supplied, returns the rules of this particular ruleType only (optional)
      active - active : if supplied, returns the active rules only (optional)

    • getAllSubscriptionUsage

      List<Usage> getAllSubscriptionUsage(@Nullable @Nullable String name, @Nullable @Nullable String _package, @Nullable @Nullable String plan, @Nullable @Nullable Integer from, @Nullable @Nullable Integer size, @Nullable @Nullable String count)

      This endpoint is used to list the aggregated details of each active subscription for current cycle. This can be used with filters mentioned as query parameter to fine grain the result. For example, if you want to fetch the list of usage of active subscription for package GoldPackage, then you can specify package=GoldPackage in query parameter. The result will contain usage details of subscription belongs to GoldPackage alone. You can either fetch all the records at once or use the from and size query parameter to fetch subset of details.

      Parameter:
      name - Subscription name to search for usage (optional)
      _package - Package name to search for usage (optional)
      plan - Plan name to search for usage (optional)
      from - Starting index number of the usage result to fetch (optional)
      size - Number of results to be fetched for the usage result (optional)
      count - true to get the count for the search or all the usages available (optional, defaults to false)

    • getAllSubscriptions

      List<Application> getAllSubscriptions(@Nullable @Nullable String packageId, @Nullable @Nullable String planId)

      The method retrieves all subscriptions or set of subscriptions for the specified package id and plan id specified. The response will contain the list of application details. The API key inside all the application will be masked even though the API invoker have permission to view the key.

      Parameter:
      packageId - Specify the package id for which the subscription details is requested (optional)
      planId - Specify the plan id for which the subscription details is requested (optional)

    • getAllWebhooks

      List<Webhook> getAllWebhooks()

      The method retrieves the list of all webhooks in API Gateway.

    • getAllWebserviceEndpoints

      void getAllWebserviceEndpoints()

      The method retrieves list of all Webservice endpoints in API Gateway.

    • getAnalyticsDataStoreAsDestination

      AnalyticsDataStoreDestination getAnalyticsDataStoreAsDestination()

    • getApiApplications

      List<Application> getApiApplications(@NotNull @NotNull String apiId)

      Retrieves the list of registered applications of an API

      Parameter:
      apiId - API Id for the API to find the associated applications (required)

    • getApplicableAPIsForGlobalPolicyByID

      List<APIResponseGetAPIs> getApplicableAPIsForGlobalPolicyByID(@NotNull @NotNull String policyId, @Nullable @Nullable String active)

      This REST request is used to get the list of applicable APIs for a global policy. An API become applicable API for a global policy only if it satisfies the scope specified in the global policy. By default it will return the basic API details of all the applicable APIs either if the API is active or inactive for a global policy. User can use the query parameter "active" to retrieve all active APIs for a global policy or all applicable APIs regardless of its status for a global policy.

      Parameter:
      policyId - This path parameter is used to specify the global policy id for which we need the list of applicable APIs (required)
      active - This is a query parameter. It is used to retrieve the list of applicable APIs for a global policy. If the value for this parameter is 'false' then it will return all the APIs whether it is active or not for the specified global policy. If the value for this flag is 'true' then it will return only the list of applicable active APIs alone for the specified global policy (optional)

    • getApplication

      Application getApplication(@NotNull @NotNull String applicationId)

      The method retrieves the details of a specified application in API Gateway

      Parameter:
      applicationId - This parameter specifies the ID of an application whose details are to be retrieved in API Gateway. (required)

    • getApplications

      Application getApplications()

      The method retrieves a list of available applications in API Gateway.

    • getApproval

      ApprovalRequest getApproval(@NotNull @NotNull String approvalId)

      Retrieve an Approval Request based on the approvalId.

      Parameter:
      approvalId - approvalId for the Approval Request to be retrieved (required)

    • getApprovalConfiguration

      ApprovalConfiguration getApprovalConfiguration(@NotNull @NotNull String id)

      The method retrieves the details of a specified approval configuration in API Gateway

      Parameter:
      id - This parameter specifies the ID of an approval configuration whose details are to be retrieved in API Gateway. (required)

    • getApprovalConfigurations

      ApprovalConfiguration getApprovalConfigurations()

      The method retrieves a list of available approval configurations in API Gateway.

    • getApprovals

      List<ApprovalResponsePayload> getApprovals()

      Retrieve all the approval requests waiting for the user. If the user is part of one or more approval team, then he/she will get the approval requests assigned for those teams.

    • getAssertion

      AssertionConfiguration getAssertion(@NotNull @NotNull String assertionId)

      This request will return assertion element

      Parameter:
      assertionId - This path parameter is used to specify the assertion id which assertion details needs to retrieved. (required)

    • getAssociatedGlobalPolicies

      APIResponseGetGlobalPolicies getAssociatedGlobalPolicies(@NotNull @NotNull String apiId)

      Retrieves the list of active global policies applicable to this API

      Parameter:
      apiId - API Id for the API to find the list of applicable global policies (required)

    • getAuditLogAsDestination

      AuditLogDestination getAuditLogAsDestination()

      The method retrieves the details of the Transaction Logger destination in API Gateway. Transaction Logger captures the API runtime invocations performed in API Gateway. The transaction logger data is written to a file or a database based on the configurations. Transactions events are written to the transaction logger only when the Transaction Logger is selected as a destination in Log Invocation Policy.

    • getCacheConfig

      GatewayCacheConfig getCacheConfig()

    • getCacheDetailsByapiId

      void getCacheDetailsByapiId(@NotNull @NotNull String apiId)

      This REST Request is used to get the Service Result cache size for the API using apiID. An alternative REST API call for /serviceResultCache. Instead of specifying name and version, if you know API id you can directly use that id to get the number of cached responses for that API

      Parameter:
      apiId - The id of API for which the cached response size is requested (required)

    • getCacheDetailsByapiNameAndVersion

      void getCacheDetailsByapiNameAndVersion(@NotNull @NotNull String apiName, @NotNull @NotNull String apiVersion)

      You can enable API caching in API Gateway to cache your native service's response. With caching, you can reduce the number of calls made to your endpoint and also improve the latency of the requests to your API. When you enable caching for a stage, API Gateway caches responses from your endpoint for a specified time to live period. API Gateway then responds to the request by looking up the endpoint response from the cache instead of making a request to your endpoint. Service Result cache can be configured for a API or Resource/method or Operation. This REST Request is used to get the Service Result cache size for an API using apiName and apiVersion.

      Parameter:
      apiName - This query parameter is used to specify the API name for which the service result cache element size needs to be fetched. (required)
      apiVersion - The version of the apiName parameter specified (required)

    • getCentraSiteCommunicationAsDestination

      CSCommunicationDestination getCentraSiteCommunicationAsDestination()

      The method retrieves the communication details of the CentraSite destination in API Gateway. API Gateway can publish events and metrics to the configured CentraSite destination.

    • getCentraSiteSNMPAsDestination

      CSSNMPDestination getCentraSiteSNMPAsDestination()

      The method retrieves the SNMP details of the CentraSite destination in API Gateway. API Gateway can publish events and metrics to the configured CentraSite destination.

    • getClusterSetting

      ClusterInfo getClusterSetting()

      Retrieves the configured cluster settings from API Gateway.

    • getCustomContentTypes

      Object getCustomContentTypes()

      This REST method is used to get the configured custom content types in API Gateway. Custom content types can be defined for base types XML,JSON and Text.These Custom types can be then used for payload processing in policies like Content based routing,Identify and access and Conditional error processing

    • getDatabaseAsDestination

      Destination getDatabaseAsDestination()

      The method retrieves the details of the Database destination in API Gateway. API Gateway can publish runtime events(example: policy violation, log invocation, error events etc), design time events (example: audit log events) and metrics to the configured Database destination.

    • getDataspaceConfiguration

      RemotePortConfig getDataspaceConfiguration()

      This method returns the cross dc configuration associated with the datacenter.

    • getDeniedIPs

      List<String> getDeniedIPs()

      This GET method is used to retrieve the list of IPs are denied ( IPs that violated the threat protection rules configured).

    • getDenyByIPForFailedAuthConfig

      DenyByIPForFailedAuthConfig getDenyByIPForFailedAuthConfig()

      Retrieves the configuration of gloabal IP access setting for authentication based restrictions in API Gateway

    • getDigitalEventsAsDestination

      Destination getDigitalEventsAsDestination()

      The method retrieves the details of the Digital Events destination in API Gateway. Digital Event Services (DES) enables API Gateway to communicate by exchanging digital events. API Gateway can publish runtime events(example: policy violation,log invocation, error events etc), design time events (example: audit log events) and metrics to the configured DES destination.

    • getDocument

      Document getDocument(@NotNull @NotNull String documentId)

      Retrieves the requested document from API Gateway

      Parameter:
      documentId - The unique identifier of the document for retrieving from API Gateway. (required)

    • getElasticsearchAsDestination

      ElasticsearchDestination getElasticsearchAsDestination()

      The method retrieves the details of the Elasticsearch destination in API Gateway. API Gateway can publish runtime events(example: policy violation, log invocation, error events etc), design time events (example: audit log events) and metrics to the configured Elasticsearch destination.

    • getEmailAsDestination

      EmailDestination getEmailAsDestination()

      The method retrieves the details of the Email destination in API Gateway. API Gateway can send alerts to the email ID specified either in the Log Invocation, Monitor Service Performance, Monitor Service Level Agreement, (or) Throttling Traffic Optimization policies through the configured Email destination.

    • getErrorProcessingDetails

      ErrorProcessing getErrorProcessingDetails()

      This REST method is used to get the configured error template and the value of the property - sendNativeProviderFault,which enables the server to forward the native error as it is.

    • getGatewayAsDestination

      Destination getGatewayAsDestination()

      The method retrieves the details of the API Gateway destination. API Gateway can publish runtime events(example: policy violation, log invocation, error events etc), design time events (example: audit log events) and metrics data. By default, error events, lifecycle events, policy violation event, audit logs and performance data are published to API Gateway.

    • getGroup

      Group getGroup(@NotNull @NotNull String groupId)

      The method retrieves the details of a group in API Gateway.

      Parameter:
      groupId - The path parameter specifies the id of a group whose details are to be retrieved. (required)

    • getGroups

      Group getGroups()

      The method retrieves list of all groups in API Gateway.

    • getIPAccessMode

      IPAccessMode getIPAccessMode(@NotNull @NotNull String listenerKey, @NotNull @NotNull IPAccessMode body)

      The GET method retrieves the ipAccessMode for an API Gateway port configuration

      Parameter:
      listenerKey - The listenerKey parameter uniquely identifies a port configuration within the WmRoot package. (required)
      body - The request contains the IP access mode information. (required)

    • getInstalledLanguages

      List<String> getInstalledLanguages()

      The method retrieves list of installed language packs in API Gateway.

    • getIntegrationServerPublishInfo

      ServiceRegistryPublishGetResponse getIntegrationServerPublishInfo(@NotNull @NotNull String apiId)

      Retrieve the integration server publish information for the API. Only REST and SOAP APIs are supported.

      Parameter:
      apiId - API Id of the API for which IntegrationServerPublishInfo is to be fetched (required)

    • getJMSConnection

      JMSConnectionAlias getJMSConnection(@NotNull @NotNull String jmsConnId)

      The method retrieves the specified JMS connection in API Gateway.

      Parameter:
      jmsConnId - This path parameter is used to specify the JMS connection id which JMS connection needs to be retrived. (required)

    • getJMSTrigger

      JMSTrigger getJMSTrigger(@NotNull @NotNull String jmsTriggerId)

      The method retrieves the specified JMS trigger in API Gateway.

      Parameter:
      jmsTriggerId - This path parameter is used to specify the JMS trigger id which JMS trigger needs to be retrieved. (required)

    • getJsonWebToken

      JWT getJsonWebToken(@Nullable @Nullable String appId)

      This operation fetches JWT from APIGateway.To obtain the JWT from APIGateway the client has to has to pass the basic authentication credentials.

      Parameter:
      appId - This parameter is used to specify an application id for which APIGateway generates a JWT (optional)

    • getJsonWebTokenNew

      JWTServiceOutput getJsonWebTokenNew(@NotNull @NotNull JWTServiceInput body)

      Generate JWT token with custom claims supplied in the request

      Parameter:
      body - This parameter describes the request payload of an application that is to be created in API Gateway. (required)

    • getKerberosSetting

      KerberosSettings getKerberosSetting()

      Retrieves the configured Kerberos settings from API Gateway.

    • getKeyStoreTrustore

      KeystoreTruststore getKeyStoreTrustore()

      The method retrieves the details of the default keystore, truststore and alias settings in API Gateway. You might want to configure API Gateway to refer to a default keystore, truststore, or both, before deploying any SOAP message flows that require signature, encryption, X.509 authentication, and so on, as configured in the Inbound Authentication - Message policy. The default keystore and truststore are that you want API Gateway to use for the incoming secured messages

    • getKeystore

      List<KeyStore> getKeystore(@NotNull @NotNull String keyStoreName)

      The method gets keystore matching the name in API Gateway.

      Parameter:
      keyStoreName - Keystore name to identify the corresponding Keystore (required)

    • getKeystores

      List<KeyStore> getKeystores()

      The method gets all keystores available in API Gateway.

    • getLdapConfig

      InputLdapConfiguration getLdapConfig()

      Retrieves the LDAP configuration settings configured in the API Gateway

    • getLicenseDetails

      LicenseDetail getLicenseDetails()

      Retrieves the license details from API Gateway.

    • getListenerConfiguration

      ListenerConfig getListenerConfiguration()

      This method returns the grpc listener configuration associated with the datacenter.

    • getLoadBalancers

      LoadBalancer getLoadBalancers()

      The method retrieves the details of the Load Balancer configuration in API Gateway.

    • getLockedAccounts

      LockedAccounts getLockedAccounts()

      Retrieves the locked accounts in API Gateway

    • getLogConfig

      LogConfiguration getLogConfig()

      APIGateway has log files from different components.This method is used to retrieve the log settings of various components used by APIGateway.

    • getMappings

      void getMappings()

      Returns the list of runtime event types. The available event types are as follows 1.transactionalEvents 2.monitorEvents 3.errorEvents 4.performanceMetrics 5.threatProtectionEvents 6.lifecycleEvents 7.policyViolationEvents 8.auditlogs 9.applicationlogs. You can use these eventType to scope the archive/purge operation. The user should be part of API-Gateway-Administrators group or else should have 'Manage purge and restore runtime events' privilege to perform this operation.

    • getMasterPasswordProperties

      MasterPasswordProperties getMasterPasswordProperties()

      This retrieves the master password properties in API Gateway.

    • getMigrationStatus

      void getMigrationStatus(@NotNull @NotNull String action)

      RRetrieves the current status of the migration action which is invoked in API Gateway.

      Parameter:
      action - The migration action for which the status to be sent (required)

    • getMobileApplicationConfigurations

      MobileApplicationConfiguration getMobileApplicationConfigurations()

      You can use API Gateway to disable access for certain mobile application versions on a predefined set of mobile platforms. By registering the required devices and applications and disabling access to these versions, you ensure that all users use the latest versions of the applications and take advantage of the latest security and functional updates.

    • getOAuthScope

      GatewayScope getOAuthScope(@NotNull @NotNull String oauthScopeId)

      This method retrieves the requested OAuth scope mapping. OAuth scope mappings map the authorization server scope with APIs or API scopes

      Parameter:
      oauthScopeId - The path parameter specifies the id of an OAuth scope mapping that is to be retrieved from API Gateway. (required)

    • getOAuthScopes

      GatewayScope getOAuthScopes()

      This method retrieves a list of available OAuth scope mappings in API Gateway. OAuth scope mappings map the authorization server scope with APIs or API scopes

    • getOutboundProxies

      OutboundProxyGetResponse getOutboundProxies()

      Retrieves the list of all available outbound proxy server aliases in API Gateway.

    • getPackageById

      PackageGetResponseContainer getPackageById(@NotNull @NotNull String packageId)

      To get details for a given package id

      Parameter:
      packageId - Id of the Package (required)

    • getPackagesForAPI

      List<ModelPackage> getPackagesForAPI(@NotNull @NotNull String apiId)

      Retrieves the list of packages of an API

      Parameter:
      apiId - API Id for the API to find the associated packages (required)

    • getPasswordExpirySettings

      PasswordExpirySettings getPasswordExpirySettings()

      Retrieves the password expiry settings configured in API Gateway

    • getPasswordRestrictions

      PasswordRestrictions getPasswordRestrictions()

      Retrieves the password restrictions settings configured in API Gateway

    • getPlanById

      PlanGetResponse getPlanById(@NotNull @NotNull String planId)

      This request is used to retrieve the details of particular plan along with rate limit and quota policy ids along with associated package meta data.

      Parameter:
      planId - Id of a Plan (required)

    • getPlansForPackageById

      PackagePlansResponseContainer getPlansForPackageById(@NotNull @NotNull String packageId)

      To get list of all plans associated to the given package id

      Parameter:
      packageId - Id of the Package (required)

    • getPolicies

      List<Policy> getPolicies(@Nullable @Nullable String policyIds, @Nullable @Nullable String stage, @Nullable @Nullable String policyType)

      This REST request is used to retrieve list of all policies from API Gateway. This can also be used to retrieve details for particular set of policies by specifying the policy ids in the query string.

      Parameter:
      policyIds - This query parameter is used to retrieve policy details of particular set of policies. The policy IDs need to be separated using ',' to specify more than one policy id (optional)
      stage - This query parameter is used to retrieve the Threat Protection policies created in API Gateway. The value of this query parameter should be threat protection, if other values specified it wont respect that value and return all the policies in the API Gateway (optional)
      policyType - This query parameter is used to retrieve policy details for a list of policies of a particular policy type. The policy type can be template or global. If the policy type is template then policy details of all the policy templates is returned. If the policy type is global then the policy details of global policies is returned.If any other policy type is specified all policies are returned (optional)

    • getPolicyAction

      PolicyActionWrapper getPolicyAction(@NotNull @NotNull String policyActionId)

      This request will return policy action details of the policy action based on the id specified in path

      Parameter:
      policyActionId - This path parameter is used to specify the policy action id which policy action details needs to retrieved. (required)

    • getPolicyById

      Policy getPolicyById(@NotNull @NotNull String policyId)

      This REST request is used to retrieve the policy details for a specified policy in API Gateway. If policy id is available then the policy details is sent in response.

      Parameter:
      policyId - This path parameter is used to specify the policy id for which the policy details needs to be retrieved (required)

    • getPolicyStages

      List<PolicyEnforcementStage> getPolicyStages()

      This REST Request is used to get the list of policy stages available in API gateway. It will also show the list of policies (template key of each policy) associated with each stage.

    • getPort

      Port getPort(@NotNull @NotNull String listenerKey)

      The GET method retrieves an API Gateway port configuration

      Parameter:
      listenerKey - The listenerKey parameter uniquely identifies a port configuration within the WmRoot package. (required)

    • getPortAccessMode

      Port getPortAccessMode(@NotNull @NotNull String listenerKey)

      The GET method retrieves the accessMode for an API Gateway port configuration

      Parameter:
      listenerKey - The listenerKey parameter uniquely identifies a port configuration within the WmRoot package. (required)

    • getPorts

      Listeners getPorts(@Nullable @Nullable String pkg, @Nullable @Nullable String listenerKey)

      The GET method retrieves port configurations

      Parameter:
      pkg - The pkg parameter points to the IS package the port is pointing to. The pkg of port configurations is restricted to the package WmRoot. (optional)
      listenerKey - The listenerKey parameter uniquely identifies a port configuration within a package. (optional)

    • getPrimaryPort

      MessageWithPortReference getPrimaryPort()

      The GET method retrieves the definition of the primary port.

    • getPromotion

      Promotion getPromotion(@NotNull @NotNull String promotionId)

      Retrieve a promotion based on the promotion id.

      Parameter:
      promotionId - Promotion Id for the promotion to be retrieved (required)

    • getPromotions

      List<Promotion> getPromotions()

      This REST operation is used to retrieve the promotions history with each promotion entry provides the promotion name, promoted by whom, when it's promoted and the promoted assets status

    • getProxyBypass

      ProxyBypass getProxyBypass()

      The method retrieves a list of all hostlists for which outbound proxy servers are skipped. Note: proxyBypass Id is always proxyBypass

    • getPublishedPackages

      Set<Object> getPublishedPackages(@NotNull @NotNull String portalGatewayId, @NotNull @NotNull String apiId)

      This API allows you to retrieve the details of the published packages that the API is part of

      Parameter:
      portalGatewayId - Id of the API Portal configuration for retrieval of published packages information (required)
      apiId - Id of the API published from API Gateway to API Portal (required)

    • getQuiesceMode

      QuiesceMode getQuiesceMode()

      Returns the quiesce mode setting in API Gateway

    • getRegisteredApis

      void getRegisteredApis(@NotNull @NotNull String applicationId)

      The method retrieves a list of registered APIs for the specified application in API Gateway.

      Parameter:
      applicationId - This parameter specifies the ID of an application whose registered APIs are to be retrieved in API Gateway. (required)

    • getRingConfiguration

      RemotePortConfig getRingConfiguration()

      This method returns the remotes (other datacenters) configuration associated with the datacenter.

    • getRollback

      Rollback getRollback(@NotNull @NotNull String rollbackId)

      Retrieve a rollback based on the rollback id.

      Parameter:
      rollbackId - Rollback Id for the rollback to be retrieved (required)

    • getRollbacks

      List<Rollback> getRollbacks()

      This REST operation is used to retrieve the list of possible rollbacks a user can do from the local (target) API Gateway instance. Each rollback entry was created when a promotion of assets to the local (target) API Gateway instance from another stage

    • getRule

      Rule getRule(@NotNull @NotNull String ruleId)

      The method retrieves the details of a rule in API Gateway.

      Parameter:
      ruleId - The path parameter specifies the id of a rule that is to be retrieved. (required)

    • getSNMPAsDestination

      SNMPDestination getSNMPAsDestination()

      The method retrieves the details of the SNMP destination in API Gateway. API Gateway can publish events and performance metrics data to the configured 3rd party SNMP server.

    • getSSOConfiguration

      SSOConfiguration getSSOConfiguration()

      Retrieves the SSO configuration in API Gateway

    • getScopeByScopeName

      List<ScopeResourceIndex> getScopeByScopeName(@NotNull @NotNull String apiId, @NotNull @NotNull String scopeName)

      Retrieve scopes of an API based on the scope name

      Parameter:
      apiId - API Id for the API to retrieve the versions (required)
      scopeName - Name of the scope (required)

    • getScopes

      List<ScopeResourceIndex> getScopes(@NotNull @NotNull String apiId)

      An API Scope is a collection of resources or operations in an API. Users can create multiple scopes for a single API. Policies can be attached to an API level or scope level. This method retrieves the scopes of an API. You can create, modify or delete the scopes in the update API operation using PUT /api/{apiId}

      Parameter:
      apiId - API Id for the API to retrieve the versions (required)

    • getServiceRegistryPublishInfo

      ServiceRegistryPublishGetResponse getServiceRegistryPublishInfo(@NotNull @NotNull String apiId)

      Retrieve the service registry publish information for the API

      Parameter:
      apiId - API Id of the API for which ServiceRegistryPublishInfo is to be fetched (required)

    • getSettings

      ExtendedSettingsOutput getSettings()

      This method retrieves the list of extended settings and watt properties from API Gateway.

    • getSource

      List<Multipart> getSource(@NotNull @NotNull String apiId)

      Download the API definition that was used to create the API. This is applicable only for SOAP APIs.

      Parameter:
      apiId - API Id for the API to download the source content (required)

    • getStage

      Stage getStage(@NotNull @NotNull String stageId)

      This REST operation is used to retrieve a particular stage object based on a stage id

      Parameter:
      stageId - Stage Id for the stage to be retrieved (required)

    • getStages

      List<Stage> getStages()

      This REST operation is used to retrieve all the configured stages

    • getStrategies

      OneOfStrategyModel getStrategies()

      The method retrieves a list of all strategies in API Gateway.

    • getStrategy

      OneOfStrategyModel getStrategy(@NotNull @NotNull String strategyId)

      The method retrieves the details of a specified strategy in API Gateway

      Parameter:
      strategyId - This parameter specifies the ID of a strategy whose details are to be retrieved in API Gateway. (required)

    • getSubscriptionBySubscriptionID

      Application getSubscriptionBySubscriptionID(@NotNull @NotNull String applicationId)

      This endpoint is used to fetch the application details of the subscription.

      Parameter:
      applicationId - Application id to view the details of the application (required)

    • getTracer

      Map<String,List<TraceLog>> getTracer(@NotNull @NotNull String correlationID)

      Retrieve trace information for an API invocation event specified by its correlationID.

      Parameter:
      correlationID - Correlation ID of the request. Correlation ID can be retrieved from the transaction event of the request. (required)

    • getTransactions

      TransactionEvent getTransactions(@NotNull @NotNull LocalDate fromDate, @NotNull @NotNull LocalDate toDate, @Nullable @Nullable String apiName, @Nullable @Nullable String apiVersion, @Nullable @Nullable String apiId, @Nullable @Nullable String applicationName, @Nullable @Nullable String applicationId, @Nullable @Nullable String packageName, @Nullable @Nullable String packageId, @Nullable @Nullable String planName, @Nullable @Nullable String planId, @Nullable @Nullable Integer from, @Nullable @Nullable Integer size)

      This method can be used to retrieve the transaction events for a given API/Application/Plan/Package for a specific period of time. Multiple request parameters of this method provide options to specify the request criteria to match the expected result and most of these input parameters supports regular expression in their values. Along with the mandatory parameters - fromDate and toDate, any one of the other filter criteria should be passed in the request.

      Parameter:
      fromDate - This is the date from which the invocation details has to be retrieved for the matching filter criteria.It is a mandatory parameter and it should be of the format YYYY-MM-DD. Regular expression support is not available for this parameter (required)
      toDate - This is the date to which the invocation details has to be retrieved for the matching filter criteria.It is a mandatory parameter and it should be of the format YYYY-MM-DD. Regular expression support is not available for this parameter (required)
      apiName - The name of the API for which the invocation details is required.The exact name must be provided or regular expressions can be used like API_.* (optional)
      apiVersion - The version of the API (optional)
      apiId - The system generated id for an API.The id of an can be retrieved from the API details screen (optional)
      applicationName - The name of the Application for which the invocation details is required.The exact name must be provided or regular expressions can be used like APP_.* (optional)
      applicationId - The system generated id for an Application.The id of an can be retrieved from the Application details screen (optional)
      packageName - The name of the Package for which the invocation details is required.The exact name must be provided or regular expressions can be used like Package_.* (optional)
      packageId - The system generated id for a Package.The id of an can be retrieved from the Package details screen (optional)
      planName - The name of the Plan for which the invocation details is required.The exact name must be provided or regular expressions can be used like Plan_.* (optional)
      planId - The system generated id for a Plan.The id of an can be retrieved from the Plan details screen (optional)
      from - This parameter specifies the index from which the data has to be retrieved from the store. It is mainly used during pagination where the data is retrieved in batches (optional)
      size - This parameter specifies the number of records that should be present in the response. This can be combined with the parameter - from to get the records in batches during pagination. (optional)

    • getTransactionsCount

      TransactionResponse getTransactionsCount(@NotNull @NotNull LocalDate fromDate, @NotNull @NotNull LocalDate toDate, @Nullable @Nullable String apiName, @Nullable @Nullable String apiVersion, @Nullable @Nullable String apiId, @Nullable @Nullable String applicationName, @Nullable @Nullable String applicationId, @Nullable @Nullable String packageName, @Nullable @Nullable String packageId, @Nullable @Nullable String planName, @Nullable @Nullable String planId)

      This method can be used to retrieve the number of transaction events for a given API/Application/Plan/Package for a specific period of time. Multiple request parameters of this method provide options to specify the request criteria to match the expected result and most of these input parameters supports regular expression in their values. Along with the mandatory parameters - fromDate and toDate, any one of the other filter criteria should be passed in the request.

      Parameter:
      fromDate - This is the date from which the count has to be retrieved for the matching filter criteria.It is a mandatory parameter and it should be of the format YYYY-MM-DD. Regular expression support is not available for this parameter (required)
      toDate - This is the date to which the count has to be retrieved for the matching filter criteria.It is a mandatory parameter and it should be of the format YYYY-MM-DD. Regular expression support is not available for this parameter (required)
      apiName - The name of the API for which the invocation count is required.The exact name must be provided or regular expressions can be used like API_.* (optional)
      apiVersion - The version of the API (optional)
      apiId - The system generated id for an API.The id of an can be retrieved from the API details screen (optional)
      applicationName - The name of the Application for which the invocation count is required.The exact name must be provided or regular expressions can be used like APP_.* (optional)
      applicationId - The system generated id for an Application.The id of an can be retrieved from the Application details screen (optional)
      packageName - The name of the Package for which the invocation count is required.The exact name must be provided or regular expressions can be used like Package_.* (optional)
      packageId - The system generated id for a Package.The id of an can be retrieved from the Package details screen (optional)
      planName - The name of the Plan for which the invocation count is required.The exact name must be provided or regular expressions can be used like Plan_.* (optional)
      planId - The system generated id for a Plan.The id of an can be retrieved from the Plan details screen (optional)

    • getTruststore

      List<TrustStore> getTruststore(@NotNull @NotNull String trustStoreName)

      Retrieves an existing truststore matching the given name from API Gateway.

      Parameter:
      trustStoreName - Truststore name to identify the corresponding trust store in API Gateway (required)

    • getTruststores

      List<TrustStore> getTruststores()

      Retrieves all available truststores from API Gateway.

    • getURLALias

      URLAliasesGetResponse getURLALias(@Nullable @Nullable String alias)

      Retrieves all URL Aliases or a URL Alias with a particular ID in API Gateway (if the query parameter alias is provided).

      Parameter:
      alias - The name of the URL alias to be retrieved. If this query parameter is provided, then it retrieves the URL Aliases identified by the given alias. (optional)

    • getUsageBySubscriptionID

      Usage getUsageBySubscriptionID(@NotNull @NotNull String applicationId)

      This end point is used to fetch the aggregated usage of the application id for current cycle. This will return the usage only if the subscription is active. For the historic or detailed transaction wise usage details use /transactionalEvents/_search API.

      Parameter:
      applicationId - Application id to view the usage details of the application (required)

    • getUser

      User getUser(@NotNull @NotNull String userId)

      The method retrieves the details of an user in API Gateway.

      Parameter:
      userId - The path parameter specifies the id of an user whose details are to be retrieved. (required)

    • getUsers

      User getUsers()

      The method retrieves list of all users in API Gateway.

    • getVersions

      APIResponseGetAPIs getVersions(@NotNull @NotNull String apiId)

      Retrieve all the versions of the API

      Parameter:
      apiId - API Id for the API to retrieve the versions (required)

    • getWebhook

      Webhook getWebhook(@NotNull @NotNull String id)

      The method retrieves the details of a webhook in API Gateway.

      Parameter:
      id - The path parameter specifies the id of a webhook whose details are to be retrieved. (required)

    • getWebserviceEndpoint

      WebserviceEndpointAlias getWebserviceEndpoint(@NotNull @NotNull String webserviceEndpointId)

      The method retrieves the specified Webservice endpoint in API Gateway.

      Parameter:
      webserviceEndpointId - This path parameter is used to specify the Webservice endpoint id which Webservice endpoint needs to be retrived. (required)

    • getWhiteListedIPs

      WhiteListedIPs getWhiteListedIPs()

      The method retrieves the details of the whitelisting IPs configuration in API Gateway.

    • importExportAPIGatewayAssets

      void importExportAPIGatewayAssets(@Nullable @Nullable String overwrite, @Nullable @Nullable String fixingMissingVersions, @Nullable @Nullable String preserveAssetState, @Nullable @Nullable List<String> policies, @Nullable @Nullable List<String> apis, @Nullable @Nullable List<String> aliases, @Nullable @Nullable List<String> applications, @Nullable @Nullable List<String> approvalConfigurations, @Nullable @Nullable List<String> outboundProxies, @Nullable @Nullable List<String> urlAliases, @Nullable @Nullable List<String> keyStores, @Nullable @Nullable List<String> trustStores, @Nullable @Nullable List<String> jnDIProviderAliases, @Nullable @Nullable List<String> jmSConnectionAliases, @Nullable @Nullable List<String> jmSTriggers, @Nullable @Nullable List<String> webserviceEndpointAliases, @Nullable @Nullable List<String> users, @Nullable @Nullable List<String> groups, @Nullable @Nullable List<String> accessProfiles, @Nullable @Nullable String kerberosSetting, @Nullable @Nullable List<String> plans, @Nullable @Nullable List<String> packages, @Nullable @Nullable List<String> configurations, @Nullable @Nullable List<String> gatewayScopes, @Nullable @Nullable String xHTTPMethodOverride, @Nullable @Nullable File zipFile)

      This method can be used for importing the API Gateway archive as well as exporting the assets as an archive. If the request is made with x-HTTP-Method-Override HTTP header with value as GET, then this method will export asset. It will require the body param using which you can specify the filtering criteria and include options for the API Gateway assets that need to be exported. If the HTTP header is not specified, then this method can be used to import the API Gateway archive. You can control the import settings with overwrite and preserveAssetState query parameters. Here are some sample payloads for different export scenarios. 1. Export all API Gateway assets. Payload: {} 2. Export all APIs Payload: { "types": ["api"] } 3. Export all APIs with registered Application Payload: { "types" : ["api"], "includeOptions" :{ "includeApplications" :false } } 4. Export only APIs with name contains "API Gateway" Payload: { "types" : ["api"], "scope" : [ {"attributeName" : "apiName", "keyword" : ".*API Gateway.*" }], "includeOptions" :{ "includeApplications" :false } } 5. Export API with specific ids only Payload: { "types" : ["api"], "scope" : [ {"attributeName" : "id", "keyword" : "1c36033a-ecb6-41ce-ad66-bada5cebe85e|8d505388-5524-4df5-bd3c-62c4bb5f41d0" }], "includeOptions" :{ "includeApplications" :true } } 6. Export API with name starts with API Gateway and description contains search Payload: { "types" : ["api"], "scope" : [ {"attributeName" : "apiName", "keyword" : "API Gateway.*" }, { "attributeName" : "apiDescription", "keyword" : ".*search.*" }], "condition" : "and", "includeOptions" :{ "includeApplications" :false } } 7. Export all Policy Payload: { "types" : ["policy"] } 8. Global Policy Alone Payload: { "types" : ["policy"], "scope":[ { "attributeName" : "policyScope", "keyword" : "GLOBAL" }] } 9. Export Threat Protection Rule Payload: { "types" : ["policy"], "scope":[ { "attributeName" : "policyEnforcements.stageKey", "keyword" : "threatProtection" }] } 10. Export All Policy Actions Payload: { "types" : ["policy_action"] } 11. Export All Threat Protection rules and policy Payload: { "types" : ["policy_action", "policy"], "scope":[ { "attributeName" : "policyEnforcements.stageKey", "keyword" : "threatProtection" }, { "attributeName" : "id", "keyword" : "globalipdos|ipdos" }], "condition" : "or" } 12. Export all aliases Payload: { "types" : ["alias"] } 13. Export all applications Payload: { "types" : ["application"] } 14. Export all application with out including associated APIs Payload: { "types" : ["application"], "includeOptions" : { "includeApis": false } } 15. Export All Assertions Payload: { "types" : ["assertion"] } 16. Export all API Plans Payload: { "types" : ["plan"] } 17. Export all API Packages Payload: { "types" : ["package"] } 18. Export all packages along with subscription but with out the registered Applications for the associated APIs. Payload: { "types" : ["package"], "includeOptions":{ "includeApis" : false, "includeApplications" : false, "includeSubscriptions" : true } } 19. Export all subscriptions Payload: { "types" : ["subscription"] } 20. Export all Administrator Settings Payload: { "types" : ["administrator_setting"] } 21. Export specific Administrator Settings Payload: { "types" : ["administrator_setting"] , "scope" : [ { "attributeName": "configId", "keyword": "loadBalancer|gatewayDestinationConfig" } ] }. Available settings: loadBalancer, keystore, mobileApp, extended, samlsso, misc, dashboard, customContentTypes, errorProcessing, auditlogDestinationConfig, gatewayDestinationConfig, jdbcDestinationConfig, desDestinationConfig, elasticsearchDestinationConfig, snmpDestinationConfig, emailDestinationConfig, apiPortalDestinationConfig, samlIssuer, logConfig, passwordRestrictions, passwordExpiry, accountLockSettings, ldapConfig, settings, cache, apiCallBackSettings 22. Export all approval configurations Payload: { "types" : ["approval_configuration"] } 23. Export all outbound proxy aliases Payload: { "types" : ["outbound_proxy"] } 24. Export all URL aliases Payload: { "types" : ["url_alias"] } 25. Export all keystore aliases Payload: { "types" : ["keystore"] } 26. Export all truststore aliases Payload: { "types" : ["truststore"] } 27. Export all kerberos settings Payload: { "types" : ["kerberos_setting"] } 28. Export all JNDI provider aliases Payload: { "types" : ["jndi_provider_alias"] } 29. Export all JMS connection aliases Payload: { "types" : ["jms_connection_alias"] } 30. Export all JMS triggers Payload: { "types" : ["jms_trigger"] } 31. Export all web service endpoint aliases Payload: { "types" : ["web_service_endpoint_alias"] } 32. Export all users Payload: { "types" : ["users"] } 33. Export all groups Payload: { "types" : ["groups"] } 34. Export all teams Payload: { "types" : ["accessprofiles"] }

      Parameter:
      overwrite - This parameter specifies the import option to define the artifact types that can be overwritten during import. The parameter enables you to specify overwriting of APIs, policies, policy actions, aliases, applications, configurations, approval configurations, outbound proxies, URL aliases, keyStores, trustStores, JNDI provider aliases, JMS connection aliases, JMS triggers, webservice endpoint aliases, users, groups, teams, kerberos settings, plans and packages. The wildcard "*" enables you to specify all types. For example, the following request enables you to overwrite APIs during import: POST /rest/apigateway/archive?overwrite=apis Whereas, overwriting all asset types during import can be specified as follows: POST /rest/apigateway/archive?overwrite=* (optional)
      fixingMissingVersions - (optional)
      preserveAssetState - This parameter is used to specify whether the asset state needs to be preserved after importing the assets in to API Gateway. By default this value will be true. If false specified the assets will be imported and wont preserve asset state after importing asset. (optional)
      policies - This parameter identifies the policies to be imported. The wildcard "*" selects all the policies. For example a single policy can be imported with its id using the following request: POST /rest/apigateway/archive?policies=07b8d7b7-20b7-422e-8464-4b19d405c41a Whereas, all the policies can be imported using the following request: POST /rest/apigateway/archive?policies=* (optional)
      apis - This parameter identifies the APIs to be imported. The wildcard "*" selects all the APIs. For example a single API can be imported using the following request: POST /rest/apigateway/archive?apis=e2996867-af49-4ac6-98e7-cba48837c13e Whereas, all the APIs can be imported using the following request: POST /rest/apigateway/archive?apis=* (optional)
      aliases - This parameter identifies the aliases to be imported. The wildcard "*" selects all aliases. For example, a single alias can be imported using the following requrest: POST /rest/apigateway/archive?aliases=d1885756-9e38-39b5-87d6-ba937726b02d Whereas, all the APIs can be imported using the following request: POST /rest/apigateway/archive?alias=* (optional)
      applications - This parameter identifies the applications to be imported. The wildcard "*" selects all applications. For example, a single application can be imported using the following requrest: POST /rest/apigateway/archive?applications=d1885756-9e38-39b5-87d6-ba937726b02d Whereas, all the applications can be imported using the following request: POST /rest/apigateway/archive?applications=* (optional)
      approvalConfigurations - This parameter identifies the approval configurations to be imported. The wildcard "*" selects all approval configurations. For example, a single approval configuration can be imported using the following request: POST /rest/apigateway/archive?approvalConfigurations=createApplication Whereas, all the approval configurations can be imported using the following request: POST /rest/apigateway/archive?approvalConfigurations=* (optional)
      outboundProxies - This parameter identifies the outbound proxy aliases to be imported. outbound proxy aliases are identified with it's name. The wildcard "*" selects all the outbound proxy aliases. For example a single outbound proxy alias can be imported using the following request: POST /rest/apigateway/archive?outboundProxies=testOutboundProxyAlias Whereas, all the outbound proxy aliases can be imported using the following request: POST /rest/apigateway/archive?outboundProxies=* (optional)
      urlAliases - This parameter identifies the URL aliases to be imported. URL aliases are identified with it's name. The wildcard "*" selects all the URL aliases. For example, a single URL alias can be imported using the following request: POST /rest/apigateway/archive?urlAliases=testUrlAlias Whereas, all the URL aliases can be imported using the following request: POST /rest/apigateway/archive?testUrlAlias=* (optional)
      keyStores - This parameter identifies the keystore aliases to be imported. Keystore aliases are identified with it's name. The wildcard "*" selects all the keystore aliases. For example, a single keystore alias can be imported using the following request: POST /rest/apigateway/archive?keyStores=test_keystore Whereas, all the keystore aliases can be imported using the following request: POST /rest/apigateway/archive?keyStores=* (optional)
      trustStores - This parameter identifies the truststore aliases to be imported. Truststore aliases are identified with it's name. The wildcard "*" selects all the truststore aliases. For example, a single truststore alias can be imported using the following request: POST /rest/apigateway/archive?trustStores=test_truststore Whereas, all the truststore aliases can be imported using the following request: POST /rest/apigateway/archive?trustStores=* (optional)
      jnDIProviderAliases - This parameter identifies the JNDI provider aliases to be imported. JNDI provider aliases are identified with it's name. The wildcard "*" selects all the JNDI provider aliases. For example, a single JNDI provider alias can be imported using the following request: POST /rest/apigateway/archive?JNDIProviderAliases=test_jndiProviderAlias Whereas, all the JNDI provider aliases can be imported using the following request: POST /rest/apigateway/archive?JNDIProviderAliases=* (optional)
      jmSConnectionAliases - This parameter identifies the JMS connection aliases to be imported. JMS connection aliases are identified with it's name. The wildcard "*" selects all the JNDI provider aliases. For example, a single JNDI provider alias can be imported using the following request: POST /rest/apigateway/archive?JMSConnectionAliases=test_jmsConnectionAlias Whereas, all the JMS connection aliases can be imported using the following request: POST /rest/apigateway/archive?JMSConnectionAliases=* (optional)
      jmSTriggers - This parameter identifies the JMS triggers to be imported. JMS triggers are identified with it's name. The wildcard "*" selects all the JMS triggers. For example, a single JMS trigger can be imported using the following request: POST /rest/apigateway/archive?JMSTriggers=test_jmsTrigger Whereas, all the JMS triggers can be imported using the following request: POST /rest/apigateway/archive?JMSTriggers=* (optional)
      webserviceEndpointAliases - This parameter identifies the 'web service endpoint' aliases to be imported. Web service endpoint aliases are identified with it's name. The wildcard "*" selects all the web service endpoint aliases. For example, a single web service endpoint alias can be imported using the following request: POST /rest/apigateway/archive?webserviceEndpointAliases=test_wsEndpointAlias Whereas, all the JMS triggers can be imported using the following request: POST /rest/apigateway/archive?webserviceEndpointAliases=* (optional)
      users - This parameter identifies the users to be imported. The wildcard "*" selects all the users. For example, a single user can be imported using the following request: POST /rest/apigateway/archive?users=7a6d3d40-44d8-4ab1-83df-5be63cdbae54 Whereas, all the users can be imported using the following request: POST /rest/apigateway/archive?users=* (optional)
      groups - This parameter identifies the groups to be imported. The wildcard "*" selects all the groups. For example, a single group can be imported using the following request: POST /rest/apigateway/archive?groups=d6b38ff8-59a8-47bf-9fba-0bdb24ee5b48 Whereas, all the groups can be imported using the following request: POST /rest/apigateway/archive?groups=* (optional)
      accessProfiles - This parameter identifies the teams to be imported. The wildcard "*" selects all the teams. For example, a single team can be imported using the following request: POST /rest/apigateway/archive?accessProfiles=d6b38ff8-59a8-47bf-9fba-0bdb24ee5b48 Whereas, all the teams can be imported using the following request: POST /rest/apigateway/archive?accessProfiles=* (optional)
      kerberosSetting - This parameter identifies the kerberos configuration to be imported. The kerberos configuration can be imported using the following request: POST /rest/apigateway/archive?kerberosSetting=kerberosSetting (optional)
      plans - This parameter identifies the plans to be imported. The wildcard "*" selects all the plans. For example, a single plan can be imported using the following request: POST /rest/apigateway/archive?plans=86d58023-be4b-4735-a08f-14e78131ce4a Whereas, all the plans can be imported using the following request: POST /rest/apigateway/archive?plans=* (optional)
      packages - This parameter identifies the packages to be imported. The wildcard "*" selects all the packages. For example, a single package can be imported using the following request: POST /rest/apigateway/archive?packages=73c93393-1477-4a99-9e44-c9b3e679de0c Whereas, all the packages can be imported using the following request: POST /rest/apigateway/archive?packages=* (optional)
      configurations - This parameter identifies the configurations to be imported. The wildcard "*" selects all the configurations. For example, a single configuration can be imported using the following request: POST /rest/apigateway/archive?configurations=loadBalancer,customContentTypes Whereas, all the configurations can be imported using the following request: POST /rest/apigateway/archive?configurations=* (optional)
      gatewayScopes - This parameter identifies the oauth scopes to be imported. The wildcard "*" selects all the oauth scopes. For example, a single oauth scope can be imported using the following request: POST /rest/apigateway/archive?gatewayScopes=73c93393-1477-4a99-9e44-c9b3e679de0c Whereas, all the oauth scopes can be imported using the following request: POST /rest/apigateway/archive?gatewayScopes=* (optional)
      xHTTPMethodOverride - This parameter is used to specify that this REST call is an export operation. The value for this field is GET. If this is specified then you need to provide the filtering criteria in body to specify the asset. If empty payload specified then all assets will be exported. (optional)
      zipFile - Zip file that contains the API Gateway asset needs to be imported (optional)

    • importTraceInfo

      ImportTraceInfoResponse importTraceInfo(@NotNull @NotNull File _file)

      Import trace data from the given archive. This does not import the events in to the storage. It simply reads the archive and returns all the events and their tracing data in the archive.

      Parameter:
      _file - The import archive containing the exported tracer events. (required)

    • jWKSUri

      Object jWKSUri()

      This is the JWKS uri of the API Gateway. It fetches all the public keys of APIGateway, which can be used by to validate the JWT generated by API Gateway. The response will be in the JWK format

    • listAllArchives

      void listAllArchives(@Nullable @Nullable String filter)

      This GET method is used to fetch the details of existing archive files and response of this method is the list of archive file names. Select a filename from the list of archive file names returned by this method and use the POST method /apitransactions/archives/{fileName} to restore.The user must either be a part of API-Gateway-Administrators group or must have 'Manage purge and restore runtime events' privilege to perform this operation.

      Parameter:
      filter - (optional)

    • listAllJNDI

      void listAllJNDI()

      The method retrieves list of all JNDI configurations in API Gateway.

    • listAllPendingJobs

      void listAllPendingJobs(@Nullable @Nullable String action, @Nullable @Nullable String status)

      This method returns a list of pending jobs. Every time you initiate archive, restore, or purge operation you get a job id as a response. You can use the specific job id to query the status of the initiated operation. The user must either be part of the API-Gateway-Administrators group or must have 'Manage purge and restore runtime events' privilege to perform this operation.

      Parameter:
      action - (optional)
      status - (optional)

    • listJNDI

      JNDIProviderAlias listJNDI(@NotNull @NotNull String jndiId)

      The method retrieves the specified JNDI configuration in API Gateway.

      Parameter:
      jndiId - This path parameter is used to specify the JNDI configuration id which JNDI configuration needs to be retrived. (required)

    • migration

      void migration(@NotNull @NotNull MigrationConfig body)

      Triggers a migration action and immediately returns with 202 status code. Clean action clears the data from the API Gateway data store, reindex action reindex the data from the source Elasticsearch to API Gateway data store and transform action transforms the reindexed assets in the API Gateway data store to be compatible with the current API Gateway version. The clean action should be invoked on target API Gateway server prior to invoking reindex API for core indices. The current status of the action can be retrieved using /migration/status API. A webhook event with the migration status also would be sent to the subscribed webhook clients

      Parameter:
      body - (required)

    • moveDownThreatProtectionRuleByPolicyID

      Policy moveDownThreatProtectionRuleByPolicyID(@NotNull @NotNull String policyId)

      This REST request is used to move down the execution order of the Threat protection rule created in API Gateway. This request does not require any request body. If the threat protection policy execution order is changed successfully then the policy details of specified policy will be sent as response.

      Parameter:
      policyId - This path parameter is used to specify the policy id of the threat protection whose execution order needs to be moved down (required)

    • moveUpThreatProtectionRuleByPolicyID

      Policy moveUpThreatProtectionRuleByPolicyID(@NotNull @NotNull String policyId)

      This REST request is used to move up the execution order of the Threat protection rule created in API Gateway. This request does not require any request body. This request does not require any request body. If the threat protection policy execution order is changed successfully then the policy details of specified policy will be sent as response.

      Parameter:
      policyId - This path parameter is used to specify the policy id of the threat protection whose execution order needs to be moved up (required)

    • notifyAPIImplementation

      ModelAPIResponse notifyAPIImplementation(@NotNull @NotNull String apiId, @Nullable @Nullable String maturityState, @Nullable @Nullable List<String> nativeBaseURLs)

      This operation can be used to update an API with its implementation endpoints details and optionally the corresponding maturity state after the implementation has been completed

      Parameter:
      apiId - API Id for the API to be updated (required)
      maturityState - (optional)
      nativeBaseURLs - (optional)

    • patchApplication

      Application patchApplication(@NotNull @NotNull String applicationId, @NotNull @NotNull Application body)

      This HTTP PATCH request suspends the specified application in API Gateway.

      Parameter:
      applicationId - This parameter specifies the ID of an application that is to be updated in API Gateway. (required)
      body - This parameter describes the request payload of an application that is to be updated in API Gateway. (required)

    • patchDocument

      DocumentResponse patchDocument(@NotNull @NotNull String documentId, @NotNull @NotNull Document body)
      Parameter:
      documentId - The unique identifier of the document to be patched. (required)
      body - The request payload to patch the document in API Gateway. (required)

    • policiesPost

      Policy policiesPost(@NotNull @NotNull Policy body, @Nullable @Nullable String action, @Nullable @Nullable String policyIds, @Nullable @Nullable String policyScope)

      This REST request is used to create a policy in API Gateway. The body of this request should contain the payload of the policy. Using this request we can create Policies of different type. To create a service, scope, package and template level policy we can add the policy payload and set the corresponding policy scope. To create a Global policy user should have API Gateway Administrator access. Other users cannot create global policies. To Create Global policy send the policy payload along with scope details and policy scope set to global. Similarly, to create a threat protection policy user have to send the policy along with the policy enforcement id of Threat protection policy actions. The policy actions needs to be created before adding the enforcement id of policy actions to policy. Threat protection rules are another type of global level policies which are applied to all requests and responses. The threat protection policy enforcement cannot be used in any other policies and other policy enforcement cannot be used in threat protection policies. Using this request we can also clone a policy. To clone a policy user have to set the appropriate query parameters. The effective policy calculation for policy(Service and scope level policy) is not calculated till it is referred in the API. But for a global policy the effective policy is calculated while creating the policy itself. Policy with template as policy scope cannot be referred from any API or scope. User needs to clone the policy templates and set the policy scope to either service or scope or global before referring it from the API. Policy should have only one occurrence of any stage. Multiple policy enforcements can be added to the applicable stages. To know about the list of stages and applicable policy enforcements on that stage please refer /policyStages resource.

      Parameter:
      body - (required)
      action - This query parameter represents the action user want to perform. Currently user can only clone the policy. Hence the allowed value for this parameter would be "clone". Cloning is duplication of one or more policies in to a single policy. All the policy actions specified inside the policies are also be duplicated while creating the duplicate policy.The effective policy is not calculated for this until this policy is referred from the API. (optional)
      policyIds - This query parameter represents the list of policies from which the new clone policy is created. If you specify list of policies then the newly created policy has all the policy action from all the policies. (optional)
      policyScope - This query parameter represents the policy scope of cloned policy. We can clone policy from one policy scope to another policy scope. Allowed policy scope values are global,service,template & scope (optional)

    • policyActionTemplatesGet

      List<PolicyActionTemplate> policyActionTemplatesGet(@Nullable @Nullable String policyActionTemplates)

      This REST Request is used to get the template detail for list of policy action.

      Parameter:
      policyActionTemplates - This is a query parameter. It will be used to fetch policy action templates for list of policy action. (optional)

    • policyActionTemplatesPolicyActionTemplateIdGet

      PolicyActionTemplate policyActionTemplatesPolicyActionTemplateIdGet(@NotNull @NotNull String policyActionTemplateId)

      This REST Request is used to get the template details of a policy action.. To retrieve the policy action template for a particular policy action, specify the policy action template name as a path parameter

      Parameter:
      policyActionTemplateId - This is a path parameter. It will be used to fetch policy action template of a particular template. (required)

    • publishAPI

      APIResponseCreate publishAPI(@NotNull @NotNull String apiId, @NotNull @NotNull InputPublish body)

      This REST operation is used to publish API to the registered API Portal

      Parameter:
      apiId - API Id for the API to be published (required)
      body - API publish request payload (required)

    • publishPackageByPackageId

      PackageResponseContainer publishPackageByPackageId(@NotNull @NotNull String packageId)

      This endpoint is used to publish the packages along with its associated plans to portal. Before publishing the package, the portal configuration should be configured in API gateway. You can use the endpoint /portalGateways to configure the portal configuration. The associated APIs needs to be published before publishing the package.

      Parameter:
      packageId - package id which needs to be published to portal (required)

    • publishToIntegrationServer

      ServiceRegistryPublishPutResponse publishToIntegrationServer(@NotNull @NotNull InputIntegrationServerPublish body)

      Publish one or more APIs to one or more integration servers. Only REST and SOAP APIs are supported.

      Parameter:
      body - Integration server publish payload (required)

    • publishToServiceRegistry

      ServiceRegistryPublishPutResponse publishToServiceRegistry(@NotNull @NotNull InputServiceRegistryPublish body)

      Publish one or more APIs to one or more service registries

      Parameter:
      body - Service registry publish payload (required)

    • purgeAPITransactions

      void purgeAPITransactions(@NotNull @NotNull String from, @NotNull @NotNull String until, @NotNull @NotNull String eventType, @Nullable @Nullable String action, @Nullable @Nullable String olderThan)

      The DELETE method is used to purge the api transactions of the specified type. Data to be purged is filtered based on the input parameters. This method returns a job id as response and this job id is used to track the job status. See /apitransactions/jobs/{jobId} for more details. The user must either be a part of API-Gateway-Administrators group or must have the 'Manage purge and restore runtime events' privilege to perform this operation.

      Parameter:
      from - This is a date parameter. All the api transactions of the specified type, from the given date, are purged. Ex: from=2017-12-18 00:00:00. Either one of from or duration is a mandatory parameter (required)
      until - This is a date parameter. All the api transactions of the specified type, until the given date, are purged. Ex: until=2017-12-18 00:00:00. Either one of until or duration is a mandatory parameter (required)
      eventType - This parameter is used to specify the event type to be purged. Specify eventType=ALL to purge all the events. To purge a specific event type, specify the required event type. Ex: eventType=transactionalEvents. Ex: eventType=transactionalEvents. The available event types are as follows 1.transactionalEvents 2.monitorEvents 3.errorEvents 4.performanceMetrics 5.threatProtectionEvents 6.lifecycleEvents 7.policyViolationEvents 8.auditlogs 9.applicationlogs 10.mediatorTraceSpan 11.serverLogTraceSpan (required)
      action - This is an optional query parameter. Sometimes it’s better to take backup before purging the data . If you specify the action value as "archiveAndPurge", API Gateway performs an archive before purging the data. (optional)
      olderThan - All the api transactions of the specified type, that are older than the value specified, are purged. Ex: olderThan='2d'. Possible types are d(days),M(months),y(years), For Example a) 2d means 2days b) 1M means 1 month c) 1y means 1 year (optional)

    • quiescemode

      QuiesceMode quiescemode(@NotNull @NotNull QuiesceMode body)

      This method either enables or disables the quiesce mode in API Gateway. Quiesce mode has two kinds - designtime and all. Quiesce mode for designtime will block the designtime API requests to API Gateway server and return 503 status code except the GET http method as well as few whitelisted APIs like search and this API itself. Quiesce mode for all is an extension of Integration server's Quiesce mode with the addition of flushing of API Gateway in-memory data such as performance metrics, license metrics and subscription quota to the configured data store.

      Parameter:
      body - (required)

    • refreshCredentials

      OneOfStrategyModel refreshCredentials(@NotNull @NotNull String strategyId, @NotNull @NotNull StrategyRequest body)

      The method refreshes the credentials of a strategy in API Gateway. This is applicable only when dynamic client registration (generate credentials) is enabled in the strategy.

      Parameter:
      strategyId - This parameter specifies the ID of a strategy that is to be updated in API Gateway. (required)
      body - This parameter describes the request payload for the strategy to be refreshed in API Gateway. (required)

    • regenerateAccessTokens

      void regenerateAccessTokens(@NotNull @NotNull String applicationId, @NotNull @NotNull AccessTokensTypeModel body)

      The method regenarates the access tokens of an application. Possible values for type - apiAccessKeyCredentials for API Key regenaration and oAuthCredentials for Oauth credentials regenaration.

      Parameter:
      applicationId - This parameter specifies the ID of an application for generating the access Tokens in API Gateway. (required)
      body - This parameter specifies the type of token to be regenerated. (required)

    • registerApis

      void registerApis(@NotNull @NotNull String applicationId, @NotNull @NotNull List<String> body)

      This method is to be used to update the registered APIs list for an application. To add a new api to an application which is already registered with other APIs, you should send the complete list of apiIds including the old apiIds and the new apiId(s) to be added. To remove all APIs from the application, send an empty array for the apiIds field in the request.

      Parameter:
      applicationId - This parameter specifies the ID of an application for registering APIs in API Gateway. (required)
      body - This parameter specifies the IDs of the APIs for registering in an application in API Gateway. (required)

    • resetMasterPassword

      MasterPasswordResetResponse resetMasterPassword()

      Resets the master password to the default value in API Gateway.This should be performed when the master password is lost and after a successful reset, it is recommended to change the master password again to a secure value

    • restoreData

      void restoreData(@NotNull @NotNull String fileName)

      This method is used to restore the runtime data by specifying the archive file name.For more details see GET /apitransactions/archives/ to know how to get the existing archive file names. This method returns a job id as a response to track the status. The user must either be a part of API-Gateway-Administrators group or must have the 'Manage purge and restore runtime events' privilege to perform this operation.

      Parameter:
      fileName - This parameter indicates the file name to be restored. Ex: fileName=default-2017-08-29-1504011306456. (required)

    • saveAPICallbackProcessorSettings

      CallbackProcessorSettings saveAPICallbackProcessorSettings(@NotNull @NotNull CallbackProcessorSettings body)

      This method updates or creates API callback processor settings in API Gateway. The user should have Manage general administration configurations privilege to update the API callback processor settings.

      Parameter:
      body - (required)

    • saveAPIPortalAsDestination

      Destination saveAPIPortalAsDestination(@NotNull @NotNull Destination body)

      The method is used to update the details of the API Portal destination in API Gateway.

      Parameter:
      body - (required)

    • saveAccountLockSettings

      AccountLockSettings saveAccountLockSettings(@NotNull @NotNull AccountLockSettings body)

      Saves the account lock settings in API Gateway

      Parameter:
      body - (required)

    • saveAnalyticsDataStoreAsDestination

      AnalyticsDataStoreDestination saveAnalyticsDataStoreAsDestination(@NotNull @NotNull AnalyticsDataStoreDestination body)
      Parameter:
      body - (required)

    • saveAuditLogAsDestination

      AuditLogDestination saveAuditLogAsDestination(@NotNull @NotNull AuditLogDestination body)

      The method is used to update the details of the Transaction Logger destination in API Gateway.

      Parameter:
      body - (required)

    • saveCentraSiteCommunicationAsDestination

      CSCommunicationDestination saveCentraSiteCommunicationAsDestination(@NotNull @NotNull CSCommunicationDestination body)

      The method is used to update the Communication details of the CentraSite destination in API Gateway.

      Parameter:
      body - (required)

    • saveCentraSiteSNMPAsDestination

      CSSNMPDestination saveCentraSiteSNMPAsDestination(@NotNull @NotNull CSSNMPDestination body)

      The method is used to update the details of the CentraSite SNMP destination in API Gateway.

      Parameter:
      body - (required)

    • saveCustomContentTypes

      Object saveCustomContentTypes(@NotNull @NotNull Object body)

      This REST method is used to update the custom content types for API Gateway.The response is a set of key/value pair where key indicates the custom content type and value indicates the base type. The value can be application/xml or application/json or text/xml

      Parameter:
      body - (required)

    • saveDatabaseAsDestination

      Destination saveDatabaseAsDestination(@NotNull @NotNull Destination body)

      The method is used to update the details of the Database destination in API Gateway.

      Parameter:
      body - (required)

    • saveDenyByIPForFailedAuthConfig

      DenyByIPForFailedAuthConfig saveDenyByIPForFailedAuthConfig(@NotNull @NotNull DenyByIPForFailedAuthConfig body)

      Saves the global IP access setting for authentication based restriction settings in API Gateway

      Parameter:
      body - (required)

    • saveDigitalEventsAsDestination

      Destination saveDigitalEventsAsDestination(@NotNull @NotNull Destination body)

      The method is used to update the details of the Digital Events destination in API Gateway.

      Parameter:
      body - (required)

    • saveElasticsearchAsDestination

      ElasticsearchDestination saveElasticsearchAsDestination(@NotNull @NotNull ElasticsearchDestination body)

      The method is used to update the details of the Elasticsearch destination in API Gateway.

      Parameter:
      body - (required)

    • saveEmailAsDestination

      EmailDestination saveEmailAsDestination(@NotNull @NotNull EmailDestination body)

      The method is used to update the details of the Email destination in API Gateway.

      Parameter:
      body - (required)

    • saveErrorProcessingDetails

      ErrorProcessing saveErrorProcessingDetails(@NotNull @NotNull ErrorProcessing body)

      This REST method is used to update the default error template with any custom templates and the value of the property - sendNativeProviderFault.

      Parameter:
      body - (required)

    • saveGatewayAsDestination

      Destination saveGatewayAsDestination(@NotNull @NotNull Destination body)

      The method is used to update the details of the API Gateway destination in API Gateway.

      Parameter:
      body - (required)

    • saveKeystoreTruststore

      KeystoreTruststore saveKeystoreTruststore(@NotNull @NotNull KeystoreTruststore body)

      The method is used to update the details of the default keystore, truststore and alias configuration in API Gateway.

      Parameter:
      body - (required)

    • saveLdapConfig

      InputLdapConfiguration saveLdapConfig(@NotNull @NotNull InputLdapConfiguration body)

      Saves the LDAP configuration settings in the API Gateway

      Parameter:
      body - (required)

    • saveLoadBalancers

      LoadBalancer saveLoadBalancers(@NotNull @NotNull LoadBalancer body)

      The method is used to update the details of the load Balancer configuration in API Gateway.

      Parameter:
      body - (required)

    • saveLogConfig

      LogConfiguration saveLogConfig()

      The method is used to update the details of the log configuration in API Gateway.

    • saveMobileApplicationConfigurations

      MobileApplicationConfiguration saveMobileApplicationConfigurations(@NotNull @NotNull MobileApplicationConfiguration body)

      The method is used to update the details of the Mobile Applications configuration in API Gateway.You can use API Gateway to disable access for certain mobile application versions on a predefined set of mobile platforms. By registering the required devices and applications and disabling access to these versions, you ensure that all users use the latest versions of the applications and take advantage of the latest security and functional updates.

      Parameter:
      body - (required)

    • savePasswordExpirySettings

      PasswordExpirySettings savePasswordExpirySettings(@NotNull @NotNull PasswordExpirySettings body)

      Saves the password expiry settings in API Gateway

      Parameter:
      body - (required)

    • savePasswordRestrictions

      PasswordRestrictions savePasswordRestrictions(@NotNull @NotNull PasswordRestrictions body)

      Saves the password restrictions settings in API Gateway

      Parameter:
      body - (required)

    • saveProxyBypass

      void saveProxyBypass(@NotNull @NotNull ProxyBypass body)

      The method updates the proxyBypassAddresses to bypass the outbound proxy servers. The API request body must contain the payload. In the proxyBypassAddresses field, type the fully qualified host and domain name of each server to which you want the Integration Server to issue requests directly. Type the host name and the domain name exactly as they appear in the URLs the server uses. To enter multiple names, separate each with commas. You can use the asterisk (*) to identify several servers with similar names. The asterisk matches any number of characters. For example, if you want to bypass requests made to localhost, www.yahoo.com, home.microsoft.com, and all hosts whose names begin with NYC, you would type: localhost,www.yahoo.com,home.microsoft.com, NYC*.*

      Parameter:
      body - The request payload of proxybypass server that is to be saved in API Gateway. (required)

    • saveSNMPAsDestination

      SNMPDestination saveSNMPAsDestination(@NotNull @NotNull SNMPDestination body)

      The method is used to update the details of the SNMP destination in API Gateway.

      Parameter:
      body - (required)

    • saveSSOConfig

      SSOConfiguration saveSSOConfig(@NotNull @NotNull SSOConfiguration body)

      The method is used to update the details of the SSO configuration in API Gateway.

      Parameter:
      body - (required)

    • saveSettings

      ExtendedSettingsOutput saveSettings(@NotNull @NotNull ExtendedSettingsInput body)

      This method updates or creates a list of extended settings and watt properties in API Gateway. The user should have an API Gateway administrator access to update thse settings. The user needs to send only the modified settings i.e, 'preferredSettings', in the payload.

      Parameter:
      body - (required)

    • saveWhitelistedIPs

      WhiteListedIPs saveWhitelistedIPs(@NotNull @NotNull WhiteListedIPs body)

      The method is used to update the details of the whitelisting IPs configuration in API Gateway.

      Parameter:
      body - (required)

    • searchByType

      Map<String,Object> searchByType(@NotNull @NotNull SearchContext body)

      The search API allows you to execute a search query in API Gateway and get back search results that match the query. You can perform search across different objects such as API, Application, Alias, Assertions, Policies, Administrator Settings, Policy Action, Packages, Plans, Subscriptions, Users, User Groups, Transactional events, Lifecycle events, Policy violation events, Monitor events, Error events, Threat protection events, Performance metrics and Audit logs. Following are the type of searches that does not require scope or fields. 1. Users - This type is used to get the list of users from IS. 2. User Groups - This type is used to get the list of user groups from IS. Following are the type of searches for which you can specify the scope and fields. 1. API - This type is used to search the APIs in API Gateway. 2. Application - This type is used to search the Applications created in API Gateway. 3. Alias - This type is used to search aliases created in API Gateway. 4. Assertions - This type is used to search custom assertions created in API Gateway. 5. Policy - This type is used to search policies in API Gateway. 6. Policy Action - This type is used to search policy actions in API Gateway. 7. Package - This type is used to search packages in API Gateway. 8. Plan - This type is used to search plans in API Gateway. 9. Administrator Setting - This type is used to search the administrator settings in API Gateway. 10. Subscription - This type is used to search subscriptions in API Gateway. 11. Transactional events - This type is used to search transactional events generated in API Gateway. 12. Lifecycle events - This type is used to search lifecycle events in API Gateway. 13. Policy violation events - This type is used to search policy violation events generated in API Gateway. 14. Monitor events - This type is used to search monitor events generated in API Gateway. 15. Error events - This type is used to search error events generated in API Gateway. 16. Threat protection events - This type is used to search threat protection events generated in API Gateway. 17. Performance metrics - This type is used to search performance metrics generated in API Gateway. 18. Audit log events - This type is used to search audit logs events generated in API Gateway. For the above eighteen types, if a scope is specified, then the scope is applicable for all types regardless whether it is applicable for that or not. Also if the required fields are specified and it is not available in any other types, then the search result corresponds to that type does not have the fields. If from and size are specified then it skips first n records specified in from for all types and it fetches the number of records specified in size. examples: 1. Fetch All APIs contains run as substring Payload : { "types" : ["api"], "scope":[ { "attributeName" : "apiName", "keyword" : ".*run.*" }] } The above payload will fetch all APIs contains run as substring in API name. The response will contains APIs with some fields populated with default values. 2. Fetch All APIs contains run as substring and specific set of fields in the response Payload : { "types" : ["api"], "scope":[ { "attributeName" : "apiName", "keyword" : ".*run.*" }], "responseFields" : ["apiName", "type", "isActive", "systemVersion", "policies","publishedPortals","apiVersion","id"]} To fetch all fields, user can use "*" in responseFields. It will fetch all the fields in the response. Payload : { "types" : ["api"], "scope":[ { "attributeName" : "apiName", "keyword" : ".*run.*" }], "responseFields" : ["*"]} The above payload will fetch all APIs contains run as substring in API name and corresponding fields mentioned in responseFields section. The responseFields can be identified from schema definition using below table for some of the main used types Asset type: API ,Swagger file: APIGatewayServiceManagement.json ,Definition: #/definitions/GatewayAPI Asset type: POLICY ,Swagger file: APIGatewayPolicyManagement.json ,Definition: #/definitions/Policy Asset type: POLICY_ACTION ,Swagger file: APIGatewayPolicyManagement.json ,Definition: #/definitions/PolicyAction Asset type: ALIAS ,Swagger file: APIGatewayAlias.json ,Definition: #/definitions/Alias Asset type: APPLICATION ,Swagger file:APIGatewayApplication.json ,Definition: #/definitions/Application Asset type: USERS ,Swagger file: APIGatewayUserManagementSwagger.json ,Definition: #/definitions/User Asset type: GROUPS ,Swagger file: APIGatewayUserManagementSwagger.json ,Definition: #/definitions/Group Asset type: ACCESSPROFILES ,Swagger file: APIGatewayUserManagementSwagger.json ,Definition: #/definitions/AccessProfile Asset type: API_DOCUMENT ,Swagger file: APIGatewayDocumentManagement.json ,Definition: #/definitions/Document Asset type: KEYSTORE ,Swagger file: APIGatewayAdministration.json ,Definition: #/definitions/KeyStore Asset type: TRUSTSTORE ,Swagger file: APIGatewayAdministration.json ,Definition: #/definitions/TrustStore For other types user can use "*" in responseFields section to get all the fields.

      Parameter:
      body - Search Parameters to search for specific set of results on specified types (required)

    • serverInformation

      ServerInfo serverInformation()

    • setPrimaryPort

      PortReference setPrimaryPort(@Nullable @Nullable PortReference body)

      The PUT method updates the primary port configuration to the referenced existing port configuration.

      Parameter:
      body - The request body references the existing port configuration to be defined as the primary port. (optional)

    • shutdown

      void shutdown(@NotNull @NotNull Shutdown body)

      This method shutdowns the API Gateway server. If bounce is set as true then the server would be restarted. The option parameter specifies whether to shutdown API Gateway server immediately or after all client sessions are ended. A value of 'force' would shutdown the server immediately and 'drain' would wait for a maximum period of time for all the client sessions to end before shutdown. Quiesce specifies the quiesce mode for all in API Gateway. A value of true would first flush the API Gateway in memory data like performance metrics, license metrics and subscription quota to datastore before shutdown of the server. Next, when API Gateway is restarted either manually or using bounce parameter, the Integration server will be started in Quiesce mode. The default value is false.

      Parameter:
      body - (required)

    • storeDocument

      DocumentResponse storeDocument(@NotNull @NotNull Document body)
      Parameter:
      body - The request payload to store the document in API Gateway. (required)

    • testJNDI

      void testJNDI(@NotNull @NotNull String jndiId)

      The method is to test the given JNDI configuration in API Gateway.

      Parameter:
      jndiId - (required)

    • tracingEnable

      GatewayAPI tracingEnable(@NotNull @NotNull String apiId)

      Enable tracing for an API

      Parameter:
      apiId - API Id of the API for which tracing should be enabled. (required)

    • trackJobStatus

      void trackJobStatus(@NotNull @NotNull String jobId)

      Use this method to know the status of a specific job. This method returns the status and file name (in case of archive process) as a response. The user must either be a part of the API-Gateway-Administrators group or must have the 'Manage purge and restore runtime events' privilege to perform this operation.

      Parameter:
      jobId - This parameter indicates the job Id. Job Id is required to identify and track the status of a job which has been initiated. Ex: jobId=1504011632215 (required)

    • unLockUserAccounts

      LockedAccounts unLockUserAccounts(@NotNull @NotNull UnlockAccountsRequest body)

      Unlock user account(s) locked by API Gateway

      Parameter:
      body - (required)

    • unPublishPackageByPackageId

      PackageResponseContainer unPublishPackageByPackageId(@NotNull @NotNull String packageId)

      This endpoint is used to un publish the package and its associated plan from portal.

      Parameter:
      packageId - package id which needs to be unpublished from portal (required)

    • unpublishAPI

      APIResponseCreate unpublishAPI(@NotNull @NotNull String apiId)

      Unpublish API from the registered API Portal

      Parameter:
      apiId - API Id for the API to be unpublished (required)

    • unpublishFromServiceRegistry

      ServiceRegistryUnpublishPutResponse unpublishFromServiceRegistry(@NotNull @NotNull InputServiceRegistryUnpublish body)

      Unpublish one or more APIs from one or more service registries

      Parameter:
      body - Service registry unpublish payload (required)

    • updateAPI

      APIResponseCreate updateAPI(@NotNull @NotNull String apiId, @NotNull @NotNull UpdateAPIRequest body, @Nullable @Nullable Boolean overwriteTags)

      This REST operation is used to update an API by importing a file, url or inline. While updating the API, visibility of the operations can be set by enabling or disabling the operations. Disabled operations will not be exposed to the customers. By default, all the operations are exposed to the consumers. When updating the API using file or url, API Gateway overwrite the resources/operations for the API. But it will retain the maturity state, scopes, visibility and if API mocking is enabled, then default mocked responses, mocked conditions and IS services will also be retained.

      Parameter:
      apiId - API Id for the API to be updated (required)
      body - (required)
      overwriteTags - When an API is updated using a URL / file, the existing tags will be overwritten if this value is true. (optional, defaults to false)

    • updateAPIPortalConfiguration

      PortalGateway updateAPIPortalConfiguration(@NotNull @NotNull String portalGatewayId, @NotNull @NotNull PortalGateway body)

      This API allows you to update API Portal configuration information in API Gateway.

      Parameter:
      portalGatewayId - Id of the API Portal configuration for update (required)
      body - API Portal configuration payload (required)

    • updateAccessMode

      AccessModeServices updateAccessMode(@NotNull @NotNull String listenerKey, @NotNull @NotNull AccessModeServices body)

      The PUT updates the services for the access mode for an API Gateway port configuration

      Parameter:
      listenerKey - The listenerKey parameter uniquely identifies a port configuration within the WmRoot package. (required)
      body - The request contains the updated services access mode information. (required)

    • updateAccessProfile

      AccessProfile updateAccessProfile(@NotNull @NotNull String accessProfileId, @NotNull @NotNull AccessProfile body)

      The method updates the details of a specified team in API Gateway. The API request body must contain the payload for the updated accessProfile.

      Parameter:
      accessProfileId - The path parameter specifies the id of a team whose detail is to be updated in API Gateway. (required)
      body - This parameter describes the request payload of a accessProfile that is to be updated in API Gateway. (required)

    • updateAlias

      Alias updateAlias(@NotNull @NotNull String aliasId, @NotNull @NotNull Alias body)

      The method updates the details of a specified alias in API Gateway. The API request body must contain the payload of the alias that needs to be updated.

      Parameter:
      aliasId - The path parameter specifies the id of an alias whose detail is to be updated in API Gateway. (required)
      body - This parameter describes the request payload of an alias that is to be updated in API Gateway. (required)

    • updateApiKeysExpiry

      void updateApiKeysExpiry(@NotNull @NotNull AccessTokensTypeModel body)

      The method updates the expiry date of all the API Keys in the instance. The new expiry date is calculated based on the extended settings property 'apiKeyExpirationPeriod'. If 'apiKeyExpirationPeriod is empty, then the expiration date for all API Keys are set as unlimited.If 'apiKeyExpirationPeriod' is set to some accepted value (say 60min), then the expiry date is calculated as current time when this method is invoked + the expiration period (60min).Since this method updates expiry date for all API keys in the instance, take caution when you invoke this! Invoke this only if absolutely necessary and take necessary precautions!For example, your system might have applications to the scale of 1M or higher - make sure to configure appropriate timeout settings, etc when invoking this!

      Parameter:
      body - This parameter specifies the type of access token for which expiry date should be updated. Currently only apiAccessKeyCredentials is supported (required)

    • updateApplication

      Application updateApplication(@NotNull @NotNull String applicationId, @NotNull @NotNull Application body)

      This HTTP request updates a specified application in API Gateway. You can use this resource to update basic information in application like name, description, version, identifiers, linked authentication strategy ids etc., but you cannot use this method to update the contents of authentication strategies, access tokens or to update associated apis. To regenerate the access tokens (API key), refer the resource /applications/{applicationId}/accessTokens POST. To update the associated apis, refer the resource /applications/{applicationId}/apis PUT. To create new authentication strategies or update the authentication strategies, refer the resource /strategies POST or /strategies/{strategyId} PUT

      Parameter:
      applicationId - This parameter specifies the ID of an application that is to be updated in API Gateway. (required)
      body - This parameter describes the request payload of an application that is to be updated in API Gateway. (required)

    • updateApprovalConfiguration

      ApprovalConfiguration updateApprovalConfiguration(@NotNull @NotNull String id, @NotNull @NotNull ApprovalConfiguration body)

      The method updates the approval configuration in API Gateway.

      Parameter:
      id - This parameter specifies the ID of an approval configuration that is to be updated in API Gateway. (required)
      body - This parameter describes the request payload of an approval configuration that is to be updated in API Gateway. (required)

    • updateAssertion

      AssertionConfiguration updateAssertion(@NotNull @NotNull String assertionId, @NotNull @NotNull AssertionConfiguration body)

      This REST service is used to update the assertion

      Parameter:
      assertionId - This path parameter is used to specify the assertion id which assertion details needs to updated. (required)
      body - assertion request payload (required)

    • updateCacheConfig

      GatewayCacheConfig updateCacheConfig()

    • updateCluster

      ClusterInfo updateCluster(@NotNull @NotNull ClusterInfo body)

      Updates the cluster settings in API Gateway.

      Parameter:
      body - The request payload for cluster settings in API Gateway. (required)

    • updateDocumentContent

      DocumentResponse updateDocumentContent(@NotNull @NotNull String documentId, @NotNull @NotNull Document body)
      Parameter:
      documentId - The unique identifier of the document to update (required)
      body - The request payload to update the document in API Gateway. (required)

    • updateExpiryInterval

      MasterPasswordExpiryIntervalResponse updateExpiryInterval(@NotNull @NotNull MasterPasswordExpiryInterval body)

      The method updates the expiry interval of the master password in API Gateway.

      Parameter:
      body - (required)

    • updateGroup

      Group updateGroup(@NotNull @NotNull String groupId, @NotNull @NotNull Group body)

      The method updates the details of a specified group in API Gateway. The API request body must contain the payload for the updated group.

      Parameter:
      groupId - The path parameter specifies the id of a group whose detail is to be updated in API Gateway. (required)
      body - This parameter describes the request payload of a group that is to be updated in API Gateway. (required)

    • updateJMSConnection

      JMSConnectionAlias updateJMSConnection(@NotNull @NotNull JMSConnectionAlias body)

      This REST service is used to update the JMS connection

      Parameter:
      body - (required)

    • updateJMSTrigger

      JMSTrigger updateJMSTrigger(@NotNull @NotNull JMSTrigger body)

      This REST service is used to update the JMS trigger

      Parameter:
      body - (required)

    • updateJNDI

      JNDIProviderAlias updateJNDI(@NotNull @NotNull JNDIProviderAlias body)

      This REST service is used to update the JNDI configuration

      Parameter:
      body - (required)

    • updateKerberos

      void updateKerberos(@NotNull @NotNull KerberosSettings body)
      Parameter:
      body - The request payload for Kerberos settings in API Gateway. (required)

    • updateKeystoreAliases

      KeyStore updateKeystoreAliases(@NotNull @NotNull String keyStoreName, @NotNull @NotNull String keyStoreType, @NotNull @NotNull String keyStoreProvider, @NotNull @NotNull String keyStorePassword, @NotNull @NotNull String uploadFileName, @NotNull @NotNull File fileContent, @Nullable @Nullable String keyStoreDescription, @Nullable @Nullable String pkAliasesList, @Nullable @Nullable String pkPasswordsList, @Nullable @Nullable String nullPKpasswds, @Nullable @Nullable String isPwdBase64Encoded)

      Updates an already existing keystore in API Gateway.

      Parameter:
      keyStoreName - The name of the keystore. It cannot contain spaces or special characters. The name of the key store must be unique across all the keystores created in API Gateway. (required)
      keyStoreType - The certificate file format of the keystore. (required)
      keyStoreProvider - The provider that is used for the keystore type. The default is SUN for JKS type and SunJSSE for PKCS12 type. (required)
      keyStorePassword - The keystore password that is defined at the time of keystore creation using a keystore utility. (required)
      uploadFileName - The name of the keystore file that will be used to save the keystore internally in API Gateway. (required)
      fileContent - The contents of the keystore file. (required)
      keyStoreDescription - The description for the keystore. (optional)
      pkAliasesList - Comma separated list of alias names in the uploaded keystore file. (optional)
      pkPasswordsList - Comma separated list of passwords in the same order as the aliases specified in pkAliasesList. If a particular key alias does not have a password, it is denoted by space. (optional)
      nullPKpasswds - Comma separated list of boolean values (true/false) indicating whether the particular alias has a password or not in the same order as the aliases specified in pkAliasesList. For each key alias, true indicates that the key alias does not have a password and false indicates that it does have a password. (optional)
      isPwdBase64Encoded - Specifies whether password is base 64 encoded. (optional)

    • updateLicenseDetails

      void updateLicenseDetails(@NotNull @NotNull LicenseDetail body)
      Parameter:
      body - The request payload for updating license details in APIGateway. (required)

    • updateListenerConfiguration

      ListenerConfig updateListenerConfiguration(@NotNull @NotNull ListenerConfig body)

      The method is used to configure the listener in the datacenter in API Gateway.

      Parameter:
      body - Listener configuration payload (required)

    • updateMasterPassword

      MasterPasswordUpdateResponse updateMasterPassword(@NotNull @NotNull MasterPasswordUpdate body)

      The method updates the master password in API Gateway.On successful update,all the old passwords available will be encrypted using this new master password.

      Parameter:
      body - (required)

    • updateOAuthScope

      GatewayScope updateOAuthScope(@NotNull @NotNull String oauthScopeId, @NotNull @NotNull GatewayScope body)

      Use this method to update an OAuth scope mapping

      Parameter:
      oauthScopeId - The path parameter specifies the id of an OAuth scope mapping that is to be updated in API Gateway. (required)
      body - This parameter describes the request payload of an OAuth scope that is to be updated in API Gateway. (required)

    • updateOutboundProxy

      void updateOutboundProxy(@NotNull @NotNull OutboundProxySettings body)
      Parameter:
      body - The request payload of an outbound proxy server that is to be updated in API Gateway. (required)

    • updatePackageByPackageId

      PackageResponseContainer updatePackageByPackageId(@NotNull @NotNull String packageId, @Nullable @Nullable ModelPackage body)

      This endpoint is used to update the package metadata and associate or remove APIs and plans. The package can be active while editing any details of the package. If an API is added to an active package then subscribers can start consuming the API with existing key. Similarly if the API is removed, subscribers wont be able to use the removed APIs. Removal of plan is allowed only if the plan does not have any subscribers. You need to republish the package to portal to make the updated changes available in portal. Please use /package/{packageId}/active or /package/{packageId}/deactivate to activate or deactivate as this endpoint cannot be used to activate or deactivate package.

      Parameter:
      packageId - package id to which the update requests is sent (required)
      body - (optional)

    • updatePlanByPlanId

      PlanGetResponse updatePlanByPlanId(@NotNull @NotNull String planId, @Nullable @Nullable Plan body)

      This request is used to update the plan meta data such as name, description, license details. To update the rate limit or quota use the /policies/{policyId} to get the throttling/MSLA policy action id and use /policyActions/{policyActionId} to update the rate limit or quota. To associate or dis associate a package use /packages/{packageId} end point. If the rate limit or quota changes it will be automatically enforced with updated with out re activating the package.

      Parameter:
      planId - The id of the plan whose details needs to be updated. (required)
      body - (optional)

    • updatePolicyAction

      PolicyActionWrapper updatePolicyAction(@NotNull @NotNull String policyActionId, @NotNull @NotNull PolicyActionWrapper body)

      This put request is used to update policy action based on the policy action id which is specified in path

      Parameter:
      policyActionId - This path parameter is used to specify the policy action id which needs to be updated. (required)
      body - Contains the policy action details which needs to be updated. (required)

    • updatePolicyByID

      Policy updatePolicyByID(@NotNull @NotNull String policyId, @Nullable @Nullable Policy body)

      This REST request is used to update the policy details for a specific policy. For Global policy user should have API Gateway administrator access to update global policy

      Parameter:
      policyId - This path parameter is used to specify the policy id that needs to be updated. (required)
      body - (optional)

    • updatePort

      Port updatePort(@Nullable @Nullable Port body)

      The PUT method updates an existing port configuration. Updating an enabled port implies that it is disabled and enabled again.

      Parameter:
      body - (optional)

    • updateProxyBypass

      void updateProxyBypass(@NotNull @NotNull ProxyBypass body)

      The method updates the proxyBypassAddresses to bypass the outbound proxy servers. The API request body must contain the payload. In the proxyBypassAddresses field, type the fully qualified host and domain name of each server to which you want the Integration Server to issue requests directly. Type the host name and the domain name exactly as they appear in the URLs the server uses. To enter multiple names, separate each with commas. You can use the asterisk (*) to identify several servers with similar names. The asterisk matches any number of characters. For example, if you want to bypass requests made to localhost, www.yahoo.com, home.microsoft.com, and all hosts whose names begin with NYC, you would type: localhost,www.yahoo.com,home.microsoft.com, NYC*.*

      Parameter:
      body - The request payload of proxybypass that is to be updated in API Gateway. (required)

    • updateRegisteredApis

      void updateRegisteredApis(@NotNull @NotNull String applicationId, @NotNull @NotNull List<String> body)

      This method is to be used to update the registered APIs list for an application. To add a new api to an application which is already registered with other APIs, you should send the complete list of apiIds including the old apiIds and the new apiId(s) to be added. To remove all APIs from the application, send an empty array for the apiIds field in the request.

      Parameter:
      applicationId - This parameter specifies the ID of an application for updating the details of the registered APIs in API Gateway. (required)
      body - This parameter specifies the ID of a registered API that is to be updated in API Gateway. (required)

    • updateRingConfiguration

      RemotePortConfig updateRingConfiguration(@NotNull @NotNull RemotePortConfig body)

      The method is used to configure the other datacenter connectivity information in API Gateway.

      Parameter:
      body - Ring configuration payload (required)

    • updateRule

      Rule updateRule(@NotNull @NotNull String ruleId, @NotNull @NotNull Rule body)

      The method updates the details of a specified rule in API Gateway. The API request body must contain the payload for the updated rule.

      Parameter:
      ruleId - The path parameter specifies the id of the rule that is to be updated in API Gateway. (required)
      body - This parameter describes the request payload of an rule that is to be updated in API Gateway. (required)

    • updateStage

      Stage updateStage(@NotNull @NotNull String stageId, @NotNull @NotNull Stage body)

      This REST operation is used to update a stage in the source API Gateway where promotion will be initiated. A stage is just another API Gateway instance. When the stage url is https, then keystore and keystore alias will also be expected while configuring a stage

      Parameter:
      stageId - Stage Id for the stage to be updated (required)
      body - Stage request payload (required)

    • updateStrategy

      OneOfStrategyModel updateStrategy(@NotNull @NotNull String strategyId, @NotNull @NotNull StrategyRequest body)

      This REST operation is used to update a strategy

      Parameter:
      strategyId - This parameter specifies the ID of a strategy that is to be updated in API Gateway. (required)
      body - This parameter describes the request payload of a strategy that is to be updated in API Gateway. (required)

    • updateSubscription

      Application updateSubscription(@NotNull @NotNull String applicationId, @Nullable @Nullable SubscriptionUpdateRequest body)

      This is used switch the subscription from one package and plan to another package and plan combination. If approval is enabled, then the request will return old application detail as response and will create a request for approver to approve the switch. Till the request get approved the user can invoke old package APIs only. After the subscription is switched, the quota for the subscription will be reset and will be able to invoke the new APIs using the same API Key. To get the history of the subscription usage use the /transactionalEvents/_search endpoint

      Parameter:
      applicationId - Application id to update the subscription details (required)
      body - (optional)

    • updateTruststore

      TrustStore updateTruststore(@NotNull @NotNull String trustStoreName, @NotNull @NotNull String keyStoreType, @NotNull @NotNull String keyStoreProvider, @NotNull @NotNull String keyStorePassword, @NotNull @NotNull String uploadFileName, @NotNull @NotNull File fileContent, @Nullable @Nullable String keyStoreDescription, @Nullable @Nullable String isPwdBase64Encoded)

      Updates an already existing truststore in API Gateway.

      Parameter:
      trustStoreName - The name of the truststore. It cannot contain spaces or special characters. The name of the trust store must be unique across all the truststores created in API Gateway. (required)
      keyStoreType - The certificate file format of the truststore. (required)
      keyStoreProvider - The provider that is used for the truststore type. (required)
      keyStorePassword - The truststore password that is defined at the time of truststore creation using a keystore utility. (required)
      uploadFileName - The name of the truststore file that will be used to save the truststore internally in API Gateway. (required)
      fileContent - The contents of the truststore file. (required)
      keyStoreDescription - The description for the truststore. (optional)
      isPwdBase64Encoded - Specifies whether password is base 64 encoded. (optional)

    • updateURLALias

      URLAliasSettings updateURLALias(@NotNull @NotNull URLAliasSettings body)

      Updates an existing URL Alias in API Gateway.

      Parameter:
      body - The request body for updating an existing URL Alias in API Gateway. (required)

    • updateUser

      User updateUser(@NotNull @NotNull String userId, @NotNull @NotNull User body)

      The method updates the details of a specified user in API Gateway. The API request body must contain the payload for the updated user.

      Parameter:
      userId - The path parameter specifies the id of an user whose detail is to be updated in API Gateway. (required)
      body - This parameter describes the request payload of a user that is to be updated in API Gateway. (required)

    • updateWebhook

      Webhook updateWebhook(@NotNull @NotNull String id, @NotNull @NotNull Webhook body)

      The method updates the details of a specified webhook in API Gateway. The API request body must contain the payload of the webhook that needs to be updated.

      Parameter:
      id - The path parameter specifies the id of an webhook whose detail is to be updated in API Gateway. (required)
      body - This parameter describes the request payload of webhook that is to be updated in API Gateway. (required)

    • updateWebserviceEndpoint

      WebserviceEndpointAlias updateWebserviceEndpoint(@NotNull @NotNull WebserviceEndpointAlias body)

      This REST service is used to update the Webservice endpoint

      Parameter:
      body - (required)

    • updatedIPAccessMode

      IPAccessModeHostsList updatedIPAccessMode(@NotNull @NotNull String listenerKey, @NotNull @NotNull IPAccessModeHostsList body)

      The PUT updates the ipAccessMode for an API Gateway port configuration

      Parameter:
      listenerKey - The listenerKey parameter uniquely identifies a port configuration within the WmRoot package. (required)
      body - The request contains update the ip access mode hosts list information. (required)