Integrations

Update an integration

This route allows you to modify an integration in your Port organization.<br/><br/>To learn more about integrations, check out the documentation.<br/><br/>Permission requirements<br/>To use this endpoint, you must have an admin role in your Port organization.<br/>Note: The moderator role does not include the required update:integrations scope. Requests without this scope return 403 Forbidden.<br/>To learn more about the different roles and permissions, please refer to the documentation.<br/><br/>Note: To trigger a resync of an integration without changing its mapping, simply provide its identifier and leave the body empty.<br/><br/>Port-hosted spec updates return 202 Accepted while the change is applied. Other updates return 200.

patch/v1/integration/{identifier}

Request

  • Base URL: https://api.port.io
  • URL: https://api.port.io/v1/integration/{identifier}
  • Auth: API key in header Authorization

Path parameters

identifierstring required

The unique identifier of the resource you want to operate on.

Request body

titlestring nullable

The title of the integration. This will be displayed in the connectors page of your Port account.

installationAppTypestring

The name of the integrated tool/platform (e.g. kubernetes,pagerduty).

versionstring

The version of the integration.

pinnedVersionstring

The pinned version of the integration. If provided, the integration will be pinned to this specific version in the Kubernetes manifest.

actionsProcessingEnabledboolean

If true, This integration will be able to process actions runs

incrementalSyncEnabledboolean

If true, This integration will run incremental syncs on a schedule

processingMode'ocean-core' | 'dsp'

The processing mode for the integration. ocean_core uses Ocean core processing, dsp uses the data source processor.

oauthBrokerUrlstring uri

The base URL of the OAuth broker hosted by this integration. Port uses this URL to build the re-authentication link sent to users when the integration requires a new token.

arePortResourcesInitializedboolean

Whether the Port resources are initialized for the integration.

Changes

No recorded changes to this operation across all 1 revision of this API.