Skip to main content

Patch an integration

PATCH 
/v1/integration/:identifier

This route allows you to modify an integration in your Port organization.

To learn more about integrations, check out the documentation.

Simple resync

To trigger a resync of an integration without changing its mapping, simply provide its identifier and leave the body empty.

Request​

Path Parameters

    identifier stringrequired

    The installation id of the integration you want to modify.

Body

    title string

    The new title of the integration. This will be displayed in the data-sources page of your Port account.

    version string

    The new version of the integration.

    installationAppType string

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

    config

    object

    Various configuration options for the integration.

    deleteDependentEntities boolean

    If true, deleting an entity will also delete its dependent entities.

    createMissingRelatedEntities boolean

    If true, creating an entity with a relation to a non-existing entity will also create the related entity.

    resources

    object[]

    The mapping definition of resources from the integrated tool/platform into Port. For more information and examples, check out the documentation.

  • Array [

    • kind stringrequired

    The kind of resource to map, as defined in API of the integrated tool/platorm.

    selector

    object

    required

    query string

    A jq query used to specify which resources to fetch from the integrated tool/platform. If set to "true", all resources of the specified kind will be ingested. For more information and examples, check out the documentation.

    port

    object

    required

    An object containing the mapping definitions of the kind resource into Port.

    entity

    object

    required

    mappings

    object

    required

    The mapping definitions used to map the resource fields into Port entities. For more information and examples, check out the documentation.

    oneOf

  • Array [

    • identifier stringrequired

    A jq expression used to get data from the integrated tool's API, to be used as an identifier for the entity.

    title string

    A jq expression used to get data from the integrated tool's API, to be used as the title of the entity.

    blueprint stringrequired

    The identifier of the blueprint to map the data into.

    properties

    object

    An object containing the properties of the entity and their values. For more information and examples, check out the documentation.

    property name* any

    An object containing the properties of the entity and their values. For more information and examples, check out the documentation.

    relations

    object

    An object containing the relations of the entity and their values. For more information and examples, check out the documentation.

    property name* any

    An object containing the relations of the entity and their values. For more information and examples, check out the documentation.

  • ]

  • ]

    • property name* any

    Various configuration options for the integration.

    changelogDestination

    object

    The destination of the integration's changelog.

    oneOf

    The changelog will be sent to the Kafka topic connected to your Port account.

    type stringrequired

    Possible values: [KAFKA]

    type string

    Possible values: [WEBHOOK, KAFKA]

    property name* any

Responses​

Default Response

Loading...
Last updated on