CreateIntegration
Field | Type | Required? | Description |
---|---|---|---|
name | String | yes | Integration name to be displayed. Must be less than 50 characters. |
type | String | yes | The type of integration. you can explore integration types using Catalog API -> type |
provisioner_id | String | no | Specifies the provisioner id that the integration connects with. you can find it using Connectors API |
metadata | String, String{} | yes | Metadata is the configuration parameters. you can explore integration params using Catalog API -> params |
secret_config | SecretConfig | no | Specifies the secret that will used by the integration. |
UpdateIntegration
Field | Type | Required? | Description |
---|---|---|---|
name | String | no | Integration name to be displayed. Must be less than 50 characters. |
provisioner_id | String | no | Specifies the provisioner id that the integration connects with. you can find it using Connectors API |
metadata | String, String{} | yes | Metadata is the configuration parameters. you can explore integration params using Catalog API -> params |
secret_config | SecretConfig | no | Specifies the secret that will used by the integration. |
Integration
Field | Type | Description |
---|---|---|
id | String | Integration Uniqe Identifier. |
name | String | Integration name to be displayed. Must be less than 50 characters. |
type | String | The type of integration. you can explore integration types using Catalog API -> type |
status | String | The status of integration. can be one of the statues: Initializing , Refreshing , Active , Error or Warning |
details | String | Extra details about the integration status. |
provisioner_id | String | Specifies the provisioner id that the integration connects with. you can find it using Connectors API |
connection | ConnectionMetadataModel | extra details about the Integration cloud connection. |
last_sync_time | String | Holds the last refresh time for the integration. you can refresh an integration using the Refresh API. |
metadata | String, String{} | Metadata is the configuration parameters. you can explore integration params using Catalog API -> params |
secret_config | SecretConfig | Specifies the secret that will used by the integration. |
SecretConfig
Field | Type | Required? | Description |
---|---|---|---|
type | String | yes | Secret store type: AWS , GCP |
Additional AWS Fields
Field | Type | Required? | Description |
---|---|---|---|
region | String | yes | The AWS secret Region. |
secret_id | String | yes | SecretID can be the Name / ARN of the secret. |
Additional GCP Fields
Field | Type | Required? | Description |
---|---|---|---|
project | String | yes | The GCP secret project. |
secret_id | String | yes | The name of the secret. |