CreatePrivateCatalogIntegration
objectAllowed values:private
Defines the resource types that the integration manages within the catalog.
This schema is a key-value object where:
- Keys are globally unique, machine-readable identifiers for each resource type.
- Values are objects describing metadata about the resource type.
This declaration enables the platform to understand the structure, identity, and behavior of resources discovered by the integration.
By registering resource types, integrations communicate the kinds of entities they will ingest and maintain,
allowing the catalog to enforce consistency, validation, and visibility across all integrations.
Example:{"gateway_svc":{"display_name":"Gateway Service","schema":{"type":"simple","definition":{"control_plane_id":"string","gatway_service_id":"string"}},"resource_id_template":"{{control_plane_id}}:{{gateway_service_id}}","integration_data_schema":null},"analytics_dashboard":{"display_name":"Dashboard","schema":{"type":"simple","definition":{"dashboard_id":"string"}},"resource_id_template":"{{dashboard_id}}","integration_data_schema":null}}
Description of the integration.
<= 2048 characters
The display name of the integration.
>= 1 characters<= 120 characters
Example:My Integration
UpdateCatalogIntegration
objectDescription of the integration.
<= 2048 characters
The display name of the catalog integration.
>= 1 characters<= 120 characters
Example:Updated Catalog Integration
CreateIntegrationInstance
objectThe type of integration instance to create.
Match pattern:^[0-9a-z.-]+$
>= 1 characters<= 120 characters
Example:aws-lambda
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)
Optionally provide a description of the integration instance.
<= 2048 characters
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"}
UpdateIntegrationInstance
objectThe 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)
Optionally provide a description of the integration instance.
<= 2048 characters
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"}
IntegrationInstanceFilterParameters
objectOne OfFilter using one of the following operators: eq, oeq, neq, contains, ocontains
Show Child Parameters
One OfFilter using one of the following operators: eq, oeq, neq, contains, ocontains
Show Child Parameters
One OfOne OfFilter using one of the following operators: eq, oeq, neq, contains, ocontains
Show Child Parameters
One OfOne OfFilter using one of the following operators: eq, oeq, neq, contains, ocontains
Show Child Parameters
Filter by a boolean value (true/false).
One OfFilters on the given datetime (RFC-3339) field value.
Value strictly equals given RFC-3339 formatted timestamp in UTC
Example:2022-03-30T07:20:50Z
One OfFilters on the given datetime (RFC-3339) field value.
Value strictly equals given RFC-3339 formatted timestamp in UTC
Example:2022-03-30T07:20:50Z