Create an integration

POST 
/v1/integration

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

To learn more about integrations, check out the documentation.

Request

Query Parameters

upsert boolean
If true, the integration will be updated if it already exists.

Default value: false

application/json

Body

required

installationIdstringrequired

A unique identifier which will be used to identify the integration when using the Port API.


Possible values: non-empty

titlestring

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


versionstring

The version of the integration.


installationAppTypestring

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


config

object

Various configuration options for the integration.


deleteDependentEntitiesboolean

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


createMissingRelatedEntitiesboolean

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 [

kindstringrequired

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


selector

object

required

querystring

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

Array [

identifierstringrequired

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


titlestring

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


blueprintstringrequired

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.


relations

object

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


]

object

identifierstringrequired

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


titlestring

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


blueprintstringrequired

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.


relations

object

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


]

changelogDestination

object

The destination of the integration's changelog.


oneOf

Kafka

typestringrequired

Possible values: [KAFKA]

Webhook

typestringrequired

Possible values: [WEBHOOK]

agentboolean

If true, Port's execution agent will be used to send the changelog.


urlurirequired

The URL of the webhook.

Responses

200

Default Response