deploy.errors.connect

Connect Error Tracking: DSN, environment and release at build and run time

PUT /deploy/api/apps/{id}/errorsIAM deploy:ManageErrorsBindingChanges stateDestructive

At every build and rollout the app gets SENTRY_DSN and NEXT_PUBLIC_SENTRY_DSN (the project’s managed key, filed in Secrets as a managed entry), SENTRY_ENVIRONMENT and SENTRY_RELEASE (the commit). A build also gets SENTRY_ORG, SENTRY_PROJECT, SENTRY_URL and, as a BuildKit secret, a SENTRY_AUTH_TOKEN minted for that build alone (source-map upload to this project only), revoked when the build ends. A variable the app defines itself wins. With redeploy: true the live commit is rebuilt, so the DSN reaches the browser bundle and source maps are uploaded.

Depending on the resource, the call checks errors:UpdateProject, deploy:DeployApp instead; hold all of them to be sure it is allowed.

Request syntax

PUT /deploy/api/apps/{id}/errors
{
  "projectId": "string",
  "dsnEnv": "string",
  "publicDsnEnv": "string",
  "environmentEnv": "string",
  "releaseEnv": "string",
  "environment": "string",
  "redeploy": "boolean"
}

Path parameters

  • idRequired

    string

    Constraints: uuid

Request body

  • projectIdRequired

    string

    Error Tracking project id

    Constraints: uuid

  • dsnEnvOptional

    string

    Server DSN variable (default SENTRY_DSN)

    Constraints: /^([A-Za-z_][A-Za-z0-9_]{0,127})?$/

  • publicDsnEnvOptional

    string

    Browser DSN variable (default NEXT_PUBLIC_SENTRY_DSN; VITE_SENTRY_DSN or PUBLIC_SENTRY_DSN for Vite and SvelteKit)

    Constraints: /^([A-Za-z_][A-Za-z0-9_]{0,127})?$/

  • environmentEnvOptional

    string

    Environment variable (default SENTRY_ENVIRONMENT)

    Constraints: /^([A-Za-z_][A-Za-z0-9_]{0,127})?$/

  • releaseEnvOptional

    string

    Release variable (default SENTRY_RELEASE)

    Constraints: /^([A-Za-z_][A-Za-z0-9_]{0,127})?$/

  • environmentOptional

    string

    SENTRY_ENVIRONMENT; omitted: the app’s secrets environment, else production

    Constraints: 1-64 chars, /^[^\s/]+$/

    May be null.

  • redeployOptional

    boolean

    Rebuild and redeploy now, so the build bakes the DSN into the browser bundle and uploads source maps

Response

201 with `data`: the binding — id, projectId, projectName, projectSlug, the variable names it sets (dsnEnv, publicDsnEnv, environmentEnv, releaseEnv), environment and effectiveEnvironment, overriddenByApp (variables the app sets itself), ownAuthToken, dsn, the Secret holding the key (secretId, secretName) and createdAt. The top-level `redeploy` is null unless redeploy was requested; then { ok: true, deploymentId, generation, reusedDeploymentId } or { ok: false, error }.

A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.

Fields of data

  • idAlways

    string

    Binding id
  • projectIdAlways

    string

    Error Tracking project
  • projectNameAlways

    string

    Project name; (deleted project) if it was deleted
  • projectSlugAlways

    string

    Project slug; empty if it was deleted
  • dsnEnvAlways

    string

    Variable the DSN is set in
  • publicDsnEnvAlways

    string

    Variable the browser DSN is set in
  • environmentEnvAlways

    string

    Variable the environment name is set in
  • releaseEnvAlways

    string

    Variable the release (commit) is set in
  • environmentAlways

    string, may be null

    Environment name as set; null: taken from the app
  • effectiveEnvironmentAlways

    string

    The environment name the app reports
  • overriddenByAppAlways

    array of string

    Generated names the app sets itself, which win over the binding
  • ownAuthTokenAlways

    boolean

    True when the app sets its own SENTRY_AUTH_TOKEN: no token is minted per build
  • dsnAlways

    string, may be null

    The DSN (send-only); null when the project has no key
  • secretIdAlways

    string, may be null

    The Secret holding the project key; null if none
  • secretNameAlways

    string, may be null

    Its name
  • createdAtAlways

    string

    When it was connected

Checked against the handlers: every route test validates their answers against this schema.

Errors

  • 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
  • 401No credentials, or an access key that is unknown, revoked or expired.
  • 403The caller's policies do not allow deploy:ManageErrorsBinding on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
  • 404The resource does not exist in your organization.

Examples

The required parameters only, with example values. Replace id and the other placeholders with your own.

dcloud deploy errors connect id --project-id 00000000-0000-0000-0000-000000000000

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_deploy_errors_connect.