Deployments
Prepare deployment upload
Create a short-lived, one-time archive upload credential.
/api/v1/deploy/uploadsREST defaults to proxied multipart. Explicit direct GCS mode returns a resumable PUT URL and finalize URL.
Authentication: REST bearer token required.
Parameters
Idempotency-KeystringoptionalHeaderA caller-generated key, up to 200 characters.
project_idUUIDoptionalBodyDeploy into an existing project. Omit to create a project.
namestringoptionalBodyName for a newly created project. Required when project_id is omitted.
descriptionstringoptionalBodyProject description used when creating a project.
visibilitystringoptionalBodydraft, private, password, or public. Defaults to draft for new projects.
access_passwordstringoptionalBodyRequired when visibility is password.
filenamestringrequiredBodyOverride the uploaded archive filename.
variablesobjectoptionalBodyEnvironment variable name/value pairs to store for the deployment.
configurationobjectoptionalBodyOptional runtime, framework, command, port, root-directory, Dockerfile, and skip-build overrides.
expected_sizeintegeroptionalBodyExact ZIP size in bytes. Required for direct_gcs_resumable.
checksumstringoptionalBodyOptional client checksum verified during direct-upload finalization.
upload_modestringoptionalBodyproxied_multipart or direct_gcs_resumable. REST defaults to proxied_multipart.
ttl_secondsintegeroptionalBodyRequested upload-credential lifetime, bounded by the service.
Responses
201Instructions for exactly one upload before expires_at.
400The request is invalid or contains an unsupported value.
401The bearer token is missing, invalid, or expired.
403The account plan or current grant does not allow the action.
413The ZIP exceeds the active upload transport limit.