Sign in
Integrations (pim/v1)

List of Integrations

General Availability

Retrieve a sorted, filtered, paginated list of all integrations.

If no provider filter is specified, returns provider integrations from all clouds.

get/pim/v1/integrations

Query parameters

providerstring

Filter a collection by a string search

Filter the results by exact match for provider.

environmentstring required

Filter a collection by a string search

Filter the results by exact match for environment.

page_sizeinteger

A pagination size for collection requests.

page_tokenstring

An opaque pagination token for collection requests.

Response

Integration.

api_version'pim/v1' required

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

kind'IntegrationList' required

Kind defines the object this REST resource represents.

Example response

{
  "metadata": {
    "first": "https://api.confluent.cloud/pim/v1/integrations",
    "last": "https://api.confluent.cloud/pim/v1/integrations?page_token=bcAOehAY8F16YD84Z1wT",
    "prev": "https://api.confluent.cloud/pim/v1/integrations?page_token=YIXRY97wWYmwzrax4dld",
    "next": "https://api.confluent.cloud/pim/v1/integrations?page_token=UvmDWOB1iwfAIBPj6EYb",
    "total_size": 123
  },
  "data": [
    {
      "id": "dlz-f3a90de",
      "display_name": "s3_provider_integration",
      "provider": "AWS",
      "config": {
        "iam_role_arn": "arn:aws:iam::000000000000:role/my-test-aws-role",
        "customer_iam_role_arn": "arn:aws:iam::000000000000:role/my-test-aws-role",
        "kind": "AwsIntegrationConfig"
      },
      "usages": [
        "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-456xy/cloud-cluster=lkc-123abc/connector=my_datagen_connector"
      ],
      "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.