IntegrationInstance
objectInformation about an integration instance.
The integration instance ID.
Example:3f51fa25-310a-421d-bd1a-007f859021a3
The machine name of the integration instance that uniquely identifies it within the catalog.
Match pattern:^[0-9a-z.-]+$
>= 1 characters<= 120 characters
Example:aws-lambda-prod
The display name of the integration instance.
>= 1 characters<= 120 characters
Example:AWS (prod)
The description of the integration instance.
<= 2048 characters
Short-hand descriptor of an integration that omits instance metadata.
Show Child Parameters
Denotes whether the integration instance has been authorized within the catalog.
Example:true
JSON object representing configuration specific to the integration instance.
The expected schema depends on the integration type and is dynamically registered at runtime.
Default:{}
Example:{"account_region":"eu"}
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
IntegrationInstanceConfig
objectJSON object representing configuration specific to the integration instance.
The expected schema depends on the integration type and is dynamically registered at runtime.
Default:{}
CreateIntegrationInstanceAuthCredential
One OfAllowed values:oauth
Show Child Parameters
IntegrationInstanceAuthCredential
Object containing metadata for an integration instance auth credential.
One OfExample:4f535923-ec24-456c-b4e5-e67f65c8c208
Short-hand descriptor of an integration instance.
Show Child Parameters
List of detected missing permissions required to enable the full functionality of the given integration instance.
Show Child Parameters
Indicates that the credential is no longer valid and must be replaced with a new valid credential.
Timestamp denoting when the when the credential will expire in RFC-3339 format with a “T” character separating date from time within the field value.
When expired, the credential must be replaced with a new valid credential to re-enable full functionality for the given integration instance.
A null value indicates no known expiration time.
Example:2025-04-01T07:20:50Z
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
Allowed values:oauth
CreateOAuthCredential
objectPayload used to create an OAuth credential for an integration instance.
Allowed values:oauth