API Reference

This page summarizes the current public API surface. The canonical request and response contract lives in:

  • backend/internal-tooling/apidog/dartcloudfunctions.openapi.yaml

Base Model

Property Value

Public API host

https://api.dartcloudfunctions.com

Authentication

Firebase ID token in Authorization: Bearer <idToken>

Canonical public contract

backend/internal-tooling/apidog/dartcloudfunctions.openapi.yaml

Main Endpoint Groups

Authoring Metadata

  • GET /api/v1/functions/trigger-types

  • GET /api/v1/runtimes

  • GET /api/v1/runtime-versions (legacy alias)

Artifact Uploads

  • POST /api/v1/functions/upload/code

  • POST /api/v1/functions/upload/docker

  • POST /api/v1/functions/upload/yaml

  • POST /api/v1/functions/get-file

Function Drafts And Lists

  • POST /api/v1/functions

  • POST /api/v1/functions/save

  • PUT /api/v1/functions/update

  • GET /api/v1/functions/{projectId}

  • GET /api/v1/functions/{projectId}/non-draft

  • GET /api/v1/functions/{projectId}/deployed

  • GET /api/v1/functions/tenant/all

  • GET /api/v1/functions/list-by-status

  • DELETE /api/v1/functions/{id}

Deployments

  • POST /api/v1/projects/{projectId}/deployments

  • GET /api/v1/projects/{projectId}/deployments/{deploymentId}

  • GET /api/v1/projects/{projectId}/deployments/{deploymentId}/events

  • POST /api/v1/projects/{projectId}/deployments/{deploymentId}/undeploy

Integrations

  • Azure Workload Identity and resource template endpoints under /api/v1/projects/{projectId}/integrations/azure/*

  • AWS OIDC endpoints under /api/v1/projects/{projectId}/integrations/aws/*

  • GCP Workload Identity Federation endpoints under /api/v1/projects/{projectId}/integrations/gcp/*, including connect, verify, diagnostics, bucket check, and bucket config

Contract Notes

  • /api/v1/runtimes is the source of truth for selectable and deployable Dart runtime versions.

  • The GCP WIF public API is strict and expects the split-field provider shape, not a raw STS audience shortcut.

  • GCP deployments require explicit target.runtimeTarget. Use cloud_run plus serviceName for the standard Cloud Run path; use gke plus namespace, deploymentName, and containerName only for entitled enterprise targets.

  • POST /api/v1/projects/{projectId}/integrations/gcp/wif/diagnostics mirrors the backend auth chain and returns structured results for projected token load, STS exchange, IAMCredentials impersonation, project access, and optional bucket checks.

  • The async project deployment API is the preferred public deployment contract.

Error Model

The backend uses normal HTTP status codes plus error bodies that describe the validation or policy failure. Common cases include:

  • 400 for malformed requests

  • 401 for missing or invalid auth

  • 403 for access-denied or provider-RBAC failures

  • 404 for missing project, function, or deployment rows

  • 409 for lifecycle conflicts such as blocked deployment or unsafe delete

  • 415 for invalid upload content type

OpenAPI And APIDog

The internal-tooling OpenAPI file is the maintained source of truth for APIDog. The published spec is versioned independently from the product release cadence.