Skip to content

Export connector

Returns the runtime connector configuration for the named connector. Use this when you need a copy of connector settings from the control plane (for backup, review, or as input to Import).

Authentication uses the x-pcloud-key header; see Authentication.

Connector name in the URL

Connector names may include spaces or other characters that are not safe in a URL path. Percent-encode the entire connector name when you build the request URL (for example a space becomes %20). If you paste the raw name into curl, the request can fail or target the wrong resource. Use whatever URL-encoding your shell, script, or HTTP client provides so the path segment matches what the server expects.

Sensitive fields in the export

Sensitive data is not included in the export response. Passwords, tokens, and other secret values are omitted or redacted so the JSON is safe to share and store; plan to set secrets again after an Import, using the portal or API according to your secret store. See How Sensitive Data is Handled.

Endpoint
Method GET
Path /v2/runtime/connector/{connector_name}/export

Example request

Bash
1
2
curl -fsS -X GET "https://api.privaceracloud.com/v2/runtime/connector/<connector_name>/export" \
  -H "x-pcloud-key: <api_key>"

Path parameters

Name Required Type Description
connector_name Yes string Connector identifier (name). Must be URL-encoded in the path when it contains spaces or reserved characters—see the note above.

Request headers

Header Required Description
x-pcloud-key Yes Privacera API key (see Authentication).

Request body

None (GET).

Responses

200 response body — field reference
Field Type Description
name string Connector (datasource) display name.
description string Optional description.
datasourceType string Connector type (for example SNOWFLAKE, DATABRICKS_UNITY_CATALOG).
applications array One entry per active application.

Each applications[] element:

Field Type Description
appType string Application role (for example ACCESS_CONTROL, DISCOVERY).
appConfigs array of object Property rows; each row typically has name, value, and optionally type. Sensitive values may be null.
deployConfigs array of object Deployment-related property rows (structure similar to app configs).
This endpoint may return the following HTTP codes: 200, 400, 403, 404, 500
HTTP code When
200 Connector found; JSON body returned.
400 Missing required header, malformed request, or validation error.
403 Permission or scope mismatch (often from PrivaceraCloud when headers or API key do not align with the runtime plane).
404 No active connector with that name on the runtime plane (or datasource not found).
500 Unexpected or serialization/runtime errors (including some path-parameter conversion failures depending on gateway routing).

Response samples

Successful export returns pretty-printed JSON with the structure below. Certain fields are omitted from the serialized output so the payload matches the create/import shape (see collapsible Omitted fields).

JSON
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
  "name": "string",
  "description": "string",
  "datasourceType": "STRING_UPPERCASE_TYPE",
  "applications": [
    {
      "appType": "ACCESS_CONTROL",
      "appConfigs": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "deployConfigs": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    }
  ]
}
JSON
1
2
3
4
5
{
  "error_code": "ENTITY_NOT_FOUND",
  "message": "Datasource not found with id: string",
  "timestamp": "2026-05-08T12:00:00.123456789Z"
}