CreateIntegration

FieldTypeRequired?Description
nameStringyesIntegration name to be displayed. Must be less than 50 characters.
typeStringyesThe type of integration. you can explore integration types using Catalog API -> type
provisioner_idStringnoSpecifies the provisioner id that the integration connects with. you can find it using Connectors API
metadataString, String{}yesMetadata is the configuration parameters. you can explore integration params using Catalog API -> params
secret_configSecretConfignoSpecifies the secret that will used by the integration.

UpdateIntegration

FieldTypeRequired?Description
nameStringnoIntegration name to be displayed. Must be less than 50 characters.
provisioner_idStringnoSpecifies the provisioner id that the integration connects with. you can find it using Connectors API
metadataString, String{}yesMetadata is the configuration parameters. you can explore integration params using Catalog API -> params
secret_configSecretConfignoSpecifies the secret that will used by the integration.

Integration

FieldTypeDescription
idStringIntegration Uniqe Identifier.
nameStringIntegration name to be displayed. Must be less than 50 characters.
typeStringThe type of integration. you can explore integration types using Catalog API -> type
statusStringThe status of integration.
can be one of the statues:
Initializing, Refreshing, Active, Error or Warning
detailsStringExtra details about the integration status.
provisioner_idStringSpecifies the provisioner id that the integration connects with. you can find it using Connectors API
connectionConnectionMetadataModelextra details about the Integration cloud connection.
last_sync_timeStringHolds the last refresh time for the integration. you can refresh an integration using the Refresh API.
metadataString, String{}Metadata is the configuration parameters. you can explore integration params using Catalog API -> params
secret_configSecretConfigSpecifies the secret that will used by the integration.

SecretConfig

FieldTypeRequired?Description
typeStringyesSecret store type: AWS, GCP

Additional AWS Fields

FieldTypeRequired?Description
regionStringyesThe AWS secret Region.
secret_idStringyesSecretID can be the Name / ARN of the secret.

Additional GCP Fields

FieldTypeRequired?Description
projectStringyesThe GCP secret project.
secret_idStringyesThe name of the secret.