Partially update integration settings
PATCH {{baseUrl}}/apis/:owner/:api/:version/integrations/:integrationId
Use this operation to partially update integration settings for the specified API and integration ID. For example, enable or disable an integration, or specify a new access token.
Only the fields provided in the request body will be updated; other settings will remain unchanged. For a list of fields that can be updated, see 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:
* configType
(integration type) cannot be changed.
* If updating the integration name
, make sure the new name is unique among all integrations configured for the given API version.
* If you change target
to the YAMl/JSON definition, you must also specify the outputFile
.
* If you change syncMethod
to Advanced Sync, you must also specify a non-empty list of either providedPaths
or managedPaths
(or both). If you are not sure which paths to use, use providedPaths
=["*"]
.
* The update operation does not validate the repository details and access tokens.
Request Body
{"name"=>"GitHub integration", "token"=>"abcd12345", "owner"=>"myOrg", "repository"=>"petstore", "branch"=>"develop", "target"=>"java", "syncMethod"=>"Advanced Sync", "outputFolder"=>"sdk/java", "providedPaths"=>["*"], "enabled"=>true}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
""