Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
version: 1.0.0
title: Integration configurations Examples API
servers:
- url: /services/integration-api/v1
security:
- token: []
tags:
- name: examples
paths:
/examples/starterExample:
get:
description: Returns a starter example including an Input object and processor configuration
tags:
- examples
responses:
'200':
description: Returns a complete input example with processor configurations
content:
application/json:
schema:
$ref: '#/components/schemas/InputWithProcessorConfig'
/examples/advancedExample:
get:
description: Returns an advanced example including an Input object and processor configuration
tags:
- examples
responses:
'200':
description: Returns a complete input example with processor configurations
content:
application/json:
schema:
$ref: '#/components/schemas/InputWithProcessorConfig'
components:
schemas:
Input:
type: object
discriminator:
propertyName: processingDirection
required:
- connectorType
- connectorId
- connectorVersion
- processingDirection
properties:
connectorType:
description: The type of connector that is used
example: lxKubernetes
type: string
connectorId:
description: The identifier of the connector instance
example: Kub Dev-001
type: string
connectorVersion:
description: The version of the connector that is expected to process this LDIF file
example: 1.2.0
type: string
processingDirection:
description: The data flow direction, could be [inbound, outbound]
type: string
example: inbound
processingMode:
description: The processing mode, could be [partial, full]
type: string
default: partial
enum:
- partial
- full
InputWithProcessorConfig:
type: object
required:
- input
- processorConfiguration
properties:
input:
description: The input that is processed
readOnly: true
$ref: '#/components/schemas/Input'
processorConfiguration:
description: The processors and variables that are required to process the input
readOnly: true
$ref: '#/components/schemas/ProcessorConfiguration'
ProcessorConfiguration:
type: object
discriminator:
propertyName: processingDirection
required:
- connectorType
- connectorId
- connectorVersion
- processingDirection
properties:
connectorType:
description: The type of connector that is used
example: lxKubernetes
type: string
connectorId:
description: The identifier of the connector instance
example: Kub Dev-001
type: string
connectorVersion:
description: The version of the connector that is expected to process this LDIF file
example: 1.2.0
type: string
processingDirection:
description: The data flow direction, could be [inbound, outbound]
type: string
example: inbound
processingMode:
description: The processing mode, could be [partial, full]
type: string
default: partial
enum:
- partial
- full
sequentialExecution:
description: When set to true, all synchronizations runs processed by this processor configuration will be executed sequentially instead of in parallel.
type: boolean
default: false
securitySchemes:
token:
type: oauth2
flows:
clientCredentials:
scopes: {}
tokenUrl: /services/mtm/v1/oauth2/token