CreatePrivateCatalogIntegration

object
* Additional properties are NOT allowed.
visibilitystringrequired

Allowed values:private

resource_typesobjectrequired

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}}

descriptionstringrequired

Description of the integration.

<= 2048 characters

display_namestringrequired

The display name of the integration.

>= 1 characters<= 120 characters

Example:My Integration

Example

UpdateCatalogIntegration

object
* Additional properties are NOT allowed.
descriptionstring

Description of the integration.

<= 2048 characters

display_namestring

The display name of the catalog integration.

>= 1 characters<= 120 characters

Example:Updated Catalog Integration

Example

InitializeCatalogResource

object
* Additional properties are NOT allowed.
typestringrequired

The resource type. Available resource types are compiled from the integrations installed within the catalog.

>= 1 characters<= 120 characters

Example:gateway_svc

configobjectrequired

JSON object representing the properties used to identify the resource in the third-party system.
The schema depends on the resource type and is dynamically registered at runtime.

Example:{"control_plane_id":"ccadfb0a-56cd-4f74-955d-aec1d87157c8","gateway_service_id":"94896d05-0c4d-45eb-aae3-de754885dd58"}

* Additional properties are allowed.
Example

DeleteCatalogResources

object
* Additional properties are NOT allowed.
dataarray[object]required

>= 1 items<= 100 items

* Additional properties are NOT allowed.
Show Child Parameters
Example

UpsertCatalogResource

object
* Additional properties are NOT allowed.
namestringrequired

The name of the resource.

>= 1 characters<= 255 characters

typestringrequired

The resource type. Available resource types are compiled from the integrations installed within the catalog.

>= 1 characters<= 120 characters

Example:gateway_svc

configobjectrequired

JSON object representing the properties used to identify the resource in the third-party system.
The schema depends on the resource type and is dynamically registered at runtime.

Example:{"control_plane_id":"ccadfb0a-56cd-4f74-955d-aec1d87157c8","gateway_service_id":"94896d05-0c4d-45eb-aae3-de754885dd58"}

* Additional properties are allowed.
integration_dataobjectrequired

JSON object containing schemaless integration data of the resource.
This field is always populated by the system backing the integration.

* Additional properties are allowed.
Example