errors.projects.update

Change a project: name, platform, retention, rate limit, client IP, alerts

PATCH /errors/api/projects/{id}IAM errors:UpdateProjectChanges state

Request syntax

PATCH /errors/api/projects/{id}
{
  "name": "string",
  "platform": "enum",
  "retentionDays": "object",
  "rateLimitPerMinute": "number",
  "storeClientIp": "boolean",
  "alertEmail": "boolean",
  "alertEmailAddresses": "array of string",
  "alertEnvironments": "array of string",
  "alertWebhookUrl": "string"
}

Path parameters

  • idRequired

    string

    Constraints: uuid

Request body

  • nameOptional

    string

    Display name, 1–64 characters (surrounding spaces trimmed)

    Constraints: 1-64 chars

  • platformOptional

    enum

    javascript-nextjs, javascript, node, python, go or other: the setup snippet shown

    One of: javascript-nextjs, javascript, node, python, go, other

  • retentionDaysOptional

    object

    Days an event is kept: 30, 60 or 90 (a new project has 30). Applies to events received from now on

    Constraints: JSON

  • rateLimitPerMinuteOptional

    number

    Events per minute the ingest accepts for the whole project, 1–1 000 000; null (a new project’s setting) leaves only the organization’s errors.events-per-minute quota. Over it the ingest answers 429

    Constraints: integer, 1-1000000

    May be null.

  • storeClientIpOptional

    boolean

    Keep the sender’s IP address when the SDK asks for it ({{auto}}). Off for a new project

  • alertEmailOptional

    boolean

    Default alerts: mail the organization’s owners and admins on a new issue or a regression. On for a new project

  • alertEmailAddressesOptional

    array of string

    Further addresses the default alert mail goes to, at most 20; replaces the list (empty for a new project)

    Constraints: email

  • alertEnvironmentsOptional

    array of string

    The default alerts fire only for events of these environments, at most 20; empty: any (a new project has none). Replaces the list

    Constraints: 1-64 chars

  • alertWebhookUrlOptional

    string

    https URL the default alerts POST to on a new issue or a regression; an http URL is refused (400). null removes it (none for a new project)

    Constraints: url

    May be null.

Response

200 with the project as `get` describes it, with the change applied and `stats` null. 400 for an empty body; 404 when the project does not exist.

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

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 errors:UpdateProject 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 errors projects update id

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