App Environments and Sharing Rules

Every App created in the DDx API Console is tagged with an environment: Development or Production. The environment is selected at App creation time and cannot be changed afterward.

The environment controls whether an App is eligible to be shared beyond its own Workspace and to appear available for API key provisioning via the Admin API. Eligibility alone does not make an App visible to others; the actual sharing has to be granted separately (see How sharing is granted below).

Sharing rules at a glance

How sharing is granted

📌

There is currently no self-serve way to change an App's sharing scope after creation.

New Apps, in any environment, are only visible to the Workspace that created it. To make a Production App visible or installable beyond its own Workspace, contact [email protected].

DDx staff can set an App's sharing scope to one of:

• All child Workspaces — visible to every Workspace under the creator's Workspace hierarchy.
• All Workspaces — visible to every Workspace in the Console.
• Custom Workspace access — visible only to a specific list of Workspaces you provide.

A granted scope can also be revoked back to own-Workspace-only by contacting DDx.

No Development App is visible or installable outside its creator's Workspace, regardless of sharing scope.

Admin API Visibility

The Admin API only reads an App's existing sharing scope; it does not grant or change it. In the Admin API, Apps are called Movement Apps. An App appears in responses from endpoints like GET /admin/workspaces/{workspaceId}/interactionsApi/sources or POST /admin/workspaces/{workspaceId}/interactionsApi/apiKeys only if:

1. Its environment is Production, and
2. It belongs to the Workspace you are asking about, or its sharing scope already permits that Workspace.

Admin API responses can also report a third environment, Staging. It follows the same rules as Development above, so a Staging App is never shared and never returned. The Console only offers Development and Production when you create an App.

If you are integrating via the Admin API and a Production App is missing from the response, check first whether the App is already installed in that Workspace, because the Sources and API-keys lists exclude Apps that are already installed. Failing that, the likely cause is that no cross-workspace sharing scope has been granted yet. Contact [email protected] if you believe you should have access to an App you don't see in the response.

Related

• Production Apps (Dataset Exchange API) — Dataset Exchange-specific notes on App visibility and the DDx review process.
• Admin API Overview

🤔

Have a question that isn't answered here? Reach out to us at [email protected].