Update integration settings

PUT {{baseUrl}}/apis/:owner/:api/:version/integrations/:integrationId

Updates integration settings for the specified API and integration ID. The integration type is determined by which object is passed in the request body.

The request body must contain a full representation of an integration object. If you want to update just a few parameters, use the PATCH operation instead.

For a list of fields that need to be provided in the request body, see the descriptions of the following objects in the Models section at the bottom of API docs:

  • AmazonApiGatewayIntegration
  • AmazonApiGatewayLambdaIntegration
  • ApigeeEdgeIntegration
  • AutoMockingIntegration
  • AzureApiManagementIntegration
  • AzureDevopsServicesIntegration
  • BitbucketCloudIntegration
  • BitbucketServerIntegration
  • GitHubIntegration
  • GitHubEnterpriseIntegration
  • GitLabIntegration
  • IBMApiConnectIntegration
  • WebhookIntegration

Notes: * The integration name must be unique among all integrations configured for the given API version. * If target is the YAMl/JSON definition, you must specify the outputFile. * If syncMethod=Advanced Sync, you must specify a non-empty list of either providedPaths or managedPaths (or both). If you are not sure which paths to use, use providedPaths=["*"]. * The operation does not validate the repository details and access tokens.

Request Body

{"configType"=>"GITHUB", "name"=>"Java client SDK", "token"=>"abcd12345", "owner"=>"myOrg", "repository"=>"petstore", "branch"=>"develop", "target"=>"java", "syncMethod"=>"Advanced Sync", "outputFolder"=>"sdk/java", "providedPaths"=>["*"], "enabled"=>true}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring

RESPONSES

status: OK

""