Sign in
Integrations (pim/v2)

Read an Integration

Early Access Request Access To Provider Integration

Make a request to read an integration.

get/pim/v2/integrations/{id}

Path parameters

idstring required

The unique identifier for the integration.

Query parameters

environmentstring required

Filter a collection by a string search

Scope the operation to the given environment.

Response

Integration.

api_version'pim/v2' required

APIVersion defines the schema version of this representation of a resource.

kind'Integration' required

Kind defines the object this REST resource represents.

idstring required

ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object kinds or objects of the same kind within a different scope/namespace ("space").

display_namestring

Display name of Provider Integration.

providerstring

Cloud provider to which access is provided through provider integration.

usagesstring[]

List of resource crns where this integration is being used.

statusstring required

Status of the provider integration.

  • DRAFT: Integration exists but is not associated with customer configuration
  • CREATED: Integration has been associated with customer configuration
  • ACTIVE: Integration is in use by Confluent resources

Example response

{
  "id": "dlz-f3a90de",
  "display_name": "bigquery_provider_integration",
  "provider": "GCP",
  "config": {
    "google_service_account": "cspi-sa1@cflt-project.iam.gserviceaccount.com",
    "customer_google_service_account": "customer-sa@customer-project.iam.gserviceaccount.com",
    "kind": "GcpIntegrationConfig"
  },
  "usages": [
    "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-456xy/cloud-cluster=lkc-123abc/connector=my_datagen_connector"
  ],
  "status": "CREATED",
  "environment": {
    "id": "env-00000",
    "related": "https://api.confluent.cloud/v2/environments/env-00000",
    "resource_name": "https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.