Abstract
The Syndesis Supported REST API connects to back-end services on the Syndesis and provides a single entry point for the 3rd party clients.

1. Endpoints

1.1. Extensions

1.1.1. delete

DELETE /extensions/{id}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

Return Type

-

Content Type
  • /

Responses
Table 1. http response codes
Code Message Datatype

0

default response

<<>>

Samples

1.1.2. get

GET /extensions/{id}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

Return Type
Content Type
  • application/json

Responses
Table 2. http response codes
Code Message Datatype

0

default response

Extension

Samples

1.1.3. getStepIcon

GET /extensions/{id}/stepIcon

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

Return Type

-

Content Type
  • /

Responses
Table 3. http response codes
Code Message Datatype

0

default response

<<>>

Samples

1.1.4. install

POST /extensions/{id}/install

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

Return Type
Content Type
  • /

Responses
Table 4. http response codes
Code Message Datatype

200

Installed

List[[object]]

400

Found violations in validation

List[[object]]

Samples

1.1.5. integrations

GET /extensions/{id}/integrations

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

Return Type
Content Type
  • /

Responses
Table 5. http response codes
Code Message Datatype

0

default response

Set[ResourceIdentifier]

Samples

1.1.6. list

GET /extensions

Description
Parameters
Query Parameters
Name Description Required Default Pattern

sort

Sort the result list according to the given field value

-

null

direction

Sorting direction when a 'sort' field is provided. Can be 'asc' (ascending) or 'desc' (descending)

-

null

page

Page number to return

-

1

per_page

Number of records per page

-

20

query

The search query to filter results on

-

null

extensionType

-

null

Return Type
Content Type
  • application/json

Responses
Table 6. http response codes
Code Message Datatype

0

default response

ListResultExtension

Samples

1.1.7. upload

POST /extensions

Description
Parameters
Form Parameters
Name Description Required Default Pattern

parts

[InputPart]

-

null

preamble

[string]

-

null

Query Parameters
Name Description Required Default Pattern

updatedId

-

null

Return Type
Content Type
  • application/json

Responses
Table 7. http response codes
Code Message Datatype

0

default response

Extension

Samples

1.1.8. validate

POST /extensions/validation

Description
Parameters
Body Parameter
Name Description Required Default Pattern

Extension

Extension

X

Return Type
Content Type
  • application/json

Responses
Table 8. http response codes
Code Message Datatype

200

All blocking validations pass

List[[object]]

400

Found violations in validation

List[[object]]

Samples

1.1.9. validate1

POST /extensions/{id}/validation

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

Return Type
Content Type
  • application/json

Responses
Table 9. http response codes
Code Message Datatype

200

All blocking validations pass

List[[object]]

400

Found violations in validation

List[[object]]

Samples

1.2. IntegrationSupport

1.2.1. export

GET /integration-support/export.zip

Description
Parameters
Query Parameters
Name Description Required Default Pattern

id

[String]

X

null

Return Type

-

Content Type
  • application/octet-stream

Responses
Table 10. http response codes
Code Message Datatype

0

default response

<<>>

Samples

1.2.2. getOverviews

GET /integration-support/overviews

Description
Parameters
Content Type
  • application/json

Responses
Table 11. http response codes
Code Message Datatype

0

default response

ListResultIntegrationOverview

Samples

1.2.3. importIntegration

POST /integration-support/import

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

[object]

-

Return Type
Content Type
  • application/json

Responses
Table 12. http response codes
Code Message Datatype

0

default response

Map[WithResourceId]

Samples

1.2.4. projectPom

POST /integration-support/generate/pom.xml

Description
Parameters
Body Parameter
Name Description Required Default Pattern

Integration

Integration

-

Return Type
Content Type
  • application/octet-stream

Responses
Table 13. http response codes
Code Message Datatype

0

default response

List[[ByteArray]]

Samples

1.3. PublicApi

1.3.1. addNewEnvironment

POST /public/environments/{env}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

env

X

null

Return Type

-

Content Type
  • /

Responses
Table 14. http response codes
Code Message Datatype

0

default response

<<>>

Samples

1.3.2. configureConnection

POST /public/connections/{id}/properties

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

Body Parameter
Name Description Required Default Pattern

request_body

[string]

X

Query Parameters
Name Description Required Default Pattern

refreshIntegrations

X

null

Return Type
Content Type
  • application/json

Responses
Table 15. http response codes
Code Message Datatype

0

default response

ConnectionOverview

Samples

1.3.3. deleteEnvironment

DELETE /public/environments/{env}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

env

X

null

Return Type

-

Content Type
  • /

Responses
Table 16. http response codes
Code Message Datatype

0

default response

<<>>

Samples

1.3.4. deleteReleaseTag

DELETE /public/integrations/{id}/tags/{env}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

env

X

null

Return Type

-

Content Type
  • /

Responses
Table 17. http response codes
Code Message Datatype

0

default response

<<>>

Samples

1.3.5. exportResources

GET /public/integrations/{env}/export.zip

Description
Parameters
Path Parameters
Name Description Required Default Pattern

env

X

null

Query Parameters
Name Description Required Default Pattern

all

-

null

ignoreTimestamp

-

null

Return Type

-

Content Type
  • application/octet-stream

Responses
Table 18. http response codes
Code Message Datatype

0

default response

<<>>

Samples

1.3.6. getIntegrationState

GET /public/integrations/{id}/state

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

Return Type
Content Type
  • application/json

Responses
Table 19. http response codes
Code Message Datatype

0

default response

IntegrationState

Samples

1.3.7. getReleaseEnvironments

GET /public/environments

Description
Parameters
Query Parameters
Name Description Required Default Pattern

withUses

-

null

Return Type

-

Content Type
  • application/json

Responses
Table 20. http response codes
Code Message Datatype

0

default response

<<>>

Samples

1.3.8. getReleaseTags

GET /public/integrations/{id}/tags

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

Content Type
  • application/json

Responses
Table 21. http response codes
Code Message Datatype

0

default response

Map[ContinuousDeliveryEnvironment]

Samples

1.3.9. importResources

POST /public/integrations

Description
Parameters
Form Parameters
Name Description Required Default Pattern

data

[object]

-

null

deploy

[boolean]

-

null

environment

[string]

-

null

properties

[object]

-

null

refreshIntegrations

[boolean]

-

null

Content Type
  • application/json

Responses
Table 22. http response codes
Code Message Datatype

0

default response

ContinuousDeliveryImportResults

Samples

1.3.10. patchTagsForRelease

PATCH /public/integrations/{id}/tags

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

Body Parameter
Name Description Required Default Pattern

string

[string]

X

Content Type
  • application/json

Responses
Table 23. http response codes
Code Message Datatype

0

default response

Map[ContinuousDeliveryEnvironment]

Samples

1.3.11. publishIntegration

POST /public/integrations/{id}/deployments

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

Return Type
Content Type
  • application/json

Responses
Table 24. http response codes
Code Message Datatype

0

default response

IntegrationDeployment

Samples

1.3.12. putTagsForRelease

PUT /public/integrations/{id}/tags

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

Body Parameter
Name Description Required Default Pattern

string

[string]

X

Content Type
  • application/json

Responses
Table 25. http response codes
Code Message Datatype

0

default response

Map[ContinuousDeliveryEnvironment]

Samples

1.3.13. renameEnvironment

PUT /public/environments/{env}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

env

X

null

Body Parameter
Name Description Required Default Pattern

body

[string]

X

Return Type

-

Content Type
  • /

Responses
Table 26. http response codes
Code Message Datatype

0

default response

<<>>

Samples

1.3.14. stopIntegration

PUT /public/integrations/{id}/deployments/stop

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

Return Type

-

Content Type
  • application/json

Responses
Table 27. http response codes
Code Message Datatype

0

default response

<<>>

Samples

2. Models

2.1. Action

Field Name Required Type Description Format

actionType

String

description

String

descriptor

ActionDescriptor

id

String

metadata

Map of [string]

name

X

String

pattern

String

Enum: From, Pipe, To, PollEnrich,

tags

Set of [string]

2.2. ActionDescriptor

Field Name Required Type Description Format

inputDataShape

DataShape

outputDataShape

DataShape

propertyDefinitionSteps

List of ActionDescriptorStep

2.3. ActionDescriptorStep

Field Name Required Type Description Format

configuredProperties

Map of [string]

description

String

name

X

String

properties

Map of ConfigurationProperty

2.4. ActionsSummary

Field Name Required Type Description Format

actionCountByTags

Map of [integer]

int32

totalActions

Integer

int32

2.5. ArrayDefinition

Field Name Required Type Description Format

key

ArrayDefinitionElement

value

ArrayDefinitionElement

2.6. ArrayDefinitionElement

Field Name Required Type Description Format

displayName

String

type

String

2.7. ArrayDefinitionOptions

Field Name Required Type Description Format

i18nAddElementText

String

minElements

Integer

int32

2.8. ConfigurationProperty

Field Name Required Type Description Format

arrayDefinition

ArrayDefinition

arrayDefinitionOptions

ArrayDefinitionOptions

componentProperty

Boolean

connectorValue

String

controlHint

String

dataList

List of [string]

defaultValue

String

deprecated

Boolean

description

String

displayName

String

enum

List of PropertyValue

extendedProperties

String

generator

String

group

String

javaType

String

kind

String

label

String

labelHint

String

multiple

Boolean

order

ConfigurationProperty_order

placeholder

String

raw

Boolean

relation

List of PropertyRelation

required

Boolean

secret

Boolean

tags

Set of [string]

type

String

2.9. ConfigurationPropertyOrder

Field Name Required Type Description Format

asInt

Integer

int32

present

Boolean

2.10. Connection

Field Name Required Type Description Format

configuredProperties

Map of [string]

connector

Connector

connectorId

String

createdDate

Date

date-time

derived

Boolean

description

String

icon

String

id

String

lastUpdated

Date

date-time

metadata

Map of [string]

name

X

String

options

Map of [string]

organization

Organization

organizationId

String

tags

Set of [string]

userId

String

uses

Integer

int32

2.11. ConnectionBulletinBoard

Field Name Required Type Description Format

createdAt

Long

int64

errors

ConfigurationProperty_order

id

String

messages

List of LeveledMessage

metadata

Map of [string]

notices

ConfigurationProperty_order

targetResourceId

String

updatedAt

Long

int64

warnings

ConfigurationProperty_order

2.12. ConnectionOverview

Field Name Required Type Description Format

board

ConnectionBulletinBoard

configuredProperties

Map of [string]

connector

Connector

connectorId

String

createdDate

Date

date-time

derived

Boolean

description

String

icon

String

id

String

lastUpdated

Date

date-time

metadata

Map of [string]

name

X

String

options

Map of [string]

organization

Organization

organizationId

String

tags

Set of [string]

userId

String

uses

Integer

int32

2.13. Connector

Field Name Required Type Description Format

actions

X

List of ConnectorAction

actionsSummary

ActionsSummary

componentScheme

String

configuredProperties

Map of [string]

connectorCustomizers

List of [string]

connectorFactory

String

connectorGroup

ConnectorGroup

connectorGroupId

String

dependencies

List of Dependency

description

String

exceptionHandler

String

icon

String

id

String

metadata

Map of [string]

name

X

String

properties

Map of ConfigurationProperty

tags

Set of [string]

uses

Connector_uses

version

Integer

int32

2.14. ConnectorAction

Field Name Required Type Description Format

actionType

String

dependencies

List of Dependency

description

String

descriptor

ConnectorDescriptor

id

String

metadata

Map of [string]

name

X

String

pattern

String

Enum: From, Pipe, To, PollEnrich,

tags

Set of [string]

2.15. ConnectorDescriptor

Field Name Required Type Description Format

camelConnectorGAV

String

camelConnectorPrefix

String

componentScheme

String

configuredProperties

Map of [string]

connectorCustomizers

List of [string]

connectorFactory

String

connectorId

String

exceptionHandler

String

inputDataShape

DataShape

outputDataShape

DataShape

propertyDefinitionSteps

List of ActionDescriptorStep

standardizedErrors

List of [object]

2.16. ConnectorGroup

Field Name Required Type Description Format

id

String

name

X

String

2.17. ConnectorUses

Field Name Required Type Description Format

asInt

Integer

int32

present

Boolean

2.18. ContinuousDeliveryEnvironment

Field Name Required Type Description Format

environmentId

String

lastExportedAt

Date

date-time

lastImportedAt

Date

date-time

lastTaggedAt

Date

date-time

releaseTag

String

2.19. ContinuousDeliveryImportResults

Field Name Required Type Description Format

lastImportedAt

Date

date-time

results

List of WithResourceId

2.20. DataShape

Field Name Required Type Description Format

collectionClassName

String

collectionType

String

description

String

exemplar

List of [ByteArray]

byte

kind

String

Enum: any, java, json-schema, json-instance, xml-schema, xml-schema-inspected, xml-instance, csv-instance, none,

metadata

Map of [string]

name

X

String

parameters

Map of [string]

specification

String

type

String

variants

List of DataShape

2.21. Dependency

Field Name Required Type Description Format

id

String

type

String

Enum: MAVEN, EXTENSION, EXTENSION_TAG, ICON,

2.22. Environment

Field Name Required Type Description Format

id

String

name

X

String

2.23. Extension

Field Name Required Type Description Format

actions

X

List of Action

configuredProperties

Map of [string]

createdDate

Date

date-time

dependencies

List of Dependency

description

String

extensionId

String

extensionType

X

String

Enum: Steps, Connectors, Libraries,

icon

String

id

String

lastUpdated

Date

date-time

metadata

Map of [string]

name

X

String

properties

Map of ConfigurationProperty

schemaVersion

X

String

status

String

Enum: Draft, Installed, Deleted,

tags

Set of [string]

userId

String

uses

Integer

int32

version

String

2.24. Flow

Field Name Required Type Description Format

connections

List of Connection

dependencies

List of Dependency

description

String

id

String

metadata

Map of [string]

name

X

String

scheduler

Scheduler

steps

List of Step

tags

Set of [string]

type

String

Enum: PRIMARY, API_PROVIDER, ALTERNATE,

2.25. ImmutableConnectorAction

Field Name Required Type Description Format

actionType

String

description

String

descriptor

ConnectorDescriptor

id

String

metadata

Map of [string]

name

X

String

pattern

String

Enum: From, Pipe, To, PollEnrich,

tags

Set of [string]

dependencies

List of Dependency

2.26. ImmutableConnectorActionAllOf

Field Name Required Type Description Format

dependencies

List of Dependency

descriptor

ConnectorDescriptor

2.27. ImmutableStepAction

Field Name Required Type Description Format

actionType

String

description

String

descriptor

StepDescriptor

id

String

metadata

Map of [string]

name

X

String

pattern

String

Enum: From, Pipe, To, PollEnrich,

tags

Set of [string]

2.28. ImmutableStepActionAllOf

Field Name Required Type Description Format

descriptor

StepDescriptor

2.29. Integration

Field Name Required Type Description Format

configuredProperties

Map of [string]

connections

List of Connection

continuousDeliveryState

Map of ContinuousDeliveryEnvironment

createdAt

Long

int64

dependencies

List of Dependency

description

String

environment

Map of [string]

exposure

String

flows

List of Flow

id

String

labels

Map of [string]

name

X

String

properties

Map of ConfigurationProperty

resources

List of ResourceIdentifier

steps

List of Step

tags

Set of [string]

updatedAt

Long

int64

version

Integer

int32

2.30. IntegrationBulletinBoard

Field Name Required Type Description Format

createdAt

Long

int64

errors

ConfigurationProperty_order

id

String

messages

List of LeveledMessage

metadata

Map of [string]

notices

ConfigurationProperty_order

targetResourceId

String

updatedAt

Long

int64

warnings

ConfigurationProperty_order

2.31. IntegrationDeployment

Field Name Required Type Description Format

createdAt

Long

int64

currentState

String

Enum: Published, Unpublished, Error, Pending,

error

IntegrationDeploymentError

id

String

integrationId

String

spec

Integration

statusMessage

String

stepsDone

Map of [string]

targetState

String

Enum: Published, Unpublished, Error, Pending,

updatedAt

Long

int64

userId

String

version

Integer

int32

2.32. IntegrationDeploymentError

Field Name Required Type Description Format

message

String

type

String

2.33. IntegrationDeploymentOverview

Field Name Required Type Description Format

createdAt

Long

int64

currentState

String

Enum: Published, Unpublished, Error, Pending,

error

IntegrationDeploymentError

id

String

statusMessage

String

stepsDone

Map of [string]

targetState

String

Enum: Published, Unpublished, Error, Pending,

updatedAt

Long

int64

userId

String

version

Integer

int32

2.34. IntegrationDeploymentStateDetails

Field Name Required Type Description Format

deploymentVersion

Integer

int32

detailedState

String

Enum: ASSEMBLING, BUILDING, DEPLOYING, STARTING,

id

String

integrationId

String

linkType

String

Enum: EVENTS, LOGS,

namespace

String

podName

String

2.35. IntegrationOverview

Field Name Required Type Description Format

board

IntegrationBulletinBoard

configuredProperties

Map of [string]

connections

List of Connection

continuousDeliveryState

Map of ContinuousDeliveryEnvironment

createdAt

Long

int64

currentState

String

Enum: Published, Unpublished, Error, Pending,

dependencies

List of Dependency

deploymentVersion

Integer

int32

deployments

List of IntegrationDeploymentOverview

description

String

draft

Boolean

environment

Map of [string]

exposure

String

exposureMeans

Set of [string]

flows

List of Flow

id

String

labels

Map of [string]

managementUrl

String

name

X

String

properties

Map of ConfigurationProperty

resources

List of ResourceIdentifier

steps

List of Step

tags

Set of [string]

targetState

String

Enum: Published, Unpublished, Error, Pending,

updatedAt

Long

int64

url

String

version

Integer

int32

2.36. IntegrationState

Field Name Required Type Description Format

currentState

String

Enum: Published, Unpublished, Error, Pending,

stateDetails

IntegrationDeploymentStateDetails

2.37. LeveledMessage

Field Name Required Type Description Format

code

String

Enum: SYNDESIS000, SYNDESIS001, SYNDESIS002, SYNDESIS003, SYNDESIS004, SYNDESIS005, SYNDESIS006, SYNDESIS007, SYNDESIS008, SYNDESIS009, SYNDESIS010, SYNDESIS011, SYNDESIS012,

detail

String

level

String

Enum: INFO, WARN, ERROR,

message

String

metadata

Map of [string]

2.38. ListResultExtension

Field Name Required Type Description Format

items

List of Extension

totalCount

Integer

int32

2.39. ListResultIntegrationOverview

Field Name Required Type Description Format

items

List of IntegrationOverview

totalCount

Integer

int32

2.40. Organization

Field Name Required Type Description Format

environments

List of Environment

id

String

name

X

String

users

List of User

2.41. PropertyRelation

Field Name Required Type Description Format

action

String

when

List of When

2.42. PropertyValue

Field Name Required Type Description Format

label

String

value

String

2.43. ResourceIdentifier

Field Name Required Type Description Format

id

String

kind

String

Enum: action, connection, connection-overview, connector, connector-action, connector-group, connector-template, icon, environment, environment-type, extension, step-action, organization, integration, integration-overview, integration-deployment, integration-deployment-state-details, integration-metrics-summary, integration-runtime, integration-endpoint, step, permission, role, user, connection-bulletin-board, integration-bulletin-board, open-api, specification,

version

Integer

int32

2.44. Scheduler

Field Name Required Type Description Format

expression

String

type

String

Enum: timer, cron,

2.45. Step

Field Name Required Type Description Format

action

Action

configuredProperties

Map of [string]

connection

Connection

dependencies

List of Dependency

extension

Extension

id

String

metadata

Map of [string]

name

String

stepKind

String

Enum: endpoint, connector, expressionFilter, ruleFilter, extension, mapper, choice, split, aggregate, log, headers, template,

2.46. StepDescriptor

Field Name Required Type Description Format

entrypoint

String

inputDataShape

DataShape

kind

String

Enum: STEP, BEAN, ENDPOINT,

outputDataShape

DataShape

propertyDefinitionSteps

List of ActionDescriptorStep

resource

String

2.47. User

Field Name Required Type Description Format

firstName

String

fullName

String

id

String

integrations

List of Integration

lastName

String

name

String

organizationId

String

roleId

String

username

String

2.48. When

Field Name Required Type Description Format

id

String

value

String

2.49. WithResourceId

Field Name Required Type Description Format

id

String