Get Bulk Destination

GET

https://app.polytomic.com/api/connections/:id/bulksync/target

GET

/api/connections/:id/bulksync/target

curl -G https://app.polytomic.com/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/bulksync/target \
     -H "Authorization: Bearer <token>" \
     -d source_connection_id=248df4b7-aa70-47b8-a036-33ac447e668d

{
  "data": {
    "configuration": {
      "advanced": {
        "items": {
          "truncate_existing": {
            "default": "",
            "items": null,
            "required": false
          }
        }
      },
      "mirror_schemas": {
        "default": "",
        "items": null,
        "required": false
      },
      "schema": {
        "default": "",
        "items": null,
        "required": false
      }
    },
    "initial_configuration": {},
    "modes": [
      {
        "description": "Replace all records",
        "id": "snapshot",
        "label": "Replace",
        "requires_identity": false,
        "supports_field_sync_mode": false,
        "supports_target_filters": false
      }
    ],
    "supported_resync_modes": [
      "refetch"
    ],
    "supports_history_mode": false
  }
}

Describes the destination configuration schema a connection accepts when used as a bulk sync destination.

Use configuration to discover the fields accepted by destination_configuration when you create or update a Bulk Sync. Required fields vary by Connection type. Use modes to choose a mode supported by this destination.

Suggested initial configuration

Supply source_connection_id to request suggested values for a new Bulk Sync. For example, Snowflake suggests an output schema based on the source Connection name. You must be able to read both Connections, and they must belong to the same Organization.

When the destination generates suggestions, initial_configuration contains values using the same field names as destination_configuration. Use these values as a starting point, preserving any explicit choices. This request does not change a Connection or an existing Bulk Sync. Omit source_connection_id to retrieve metadata without contextual suggestions.

ℹ️ Configuration field metadata is reusable for the destination Connection. Initial values depend on the source and destination Connections. Fetch them for each new source/destination pair rather than caching them by Connection type. Do not apply them over an existing configuration.

Authentication

AuthorizationBearer

Bearer user API key

AuthorizationBasic

Basic organization-scoped API key

Path parameters

idstringRequiredformat: "uuid"

Connection ID

Query parameters

source_connection_idstringOptionalformat: "uuid"

Source Connection ID used to suggest initial destination configuration values

Response

dataobjectOptional

The connection's bulk sync destination capabilities

Errors

400

Bad Request Error

403

Forbidden Error

500

Internal Server Error