Deployments

Prepare deployment upload

Create a short-lived, one-time archive upload credential.

POST/api/v1/deploy/uploads

REST defaults to proxied multipart. Explicit direct GCS mode returns a resumable PUT URL and finalize URL.

Authentication: REST bearer token required.

Parameters

Idempotency-Keystringoptional

HeaderA caller-generated key, up to 200 characters.

project_idUUIDoptional

BodyDeploy into an existing project. Omit to create a project.

namestringoptional

BodyName for a newly created project. Required when project_id is omitted.

descriptionstringoptional

BodyProject description used when creating a project.

visibilitystringoptional

Bodydraft, private, password, or public. Defaults to draft for new projects.

access_passwordstringoptional

BodyRequired when visibility is password.

filenamestringrequired

BodyOverride the uploaded archive filename.

variablesobjectoptional

BodyEnvironment variable name/value pairs to store for the deployment.

configurationobjectoptional

BodyOptional runtime, framework, command, port, root-directory, Dockerfile, and skip-build overrides.

expected_sizeintegeroptional

BodyExact ZIP size in bytes. Required for direct_gcs_resumable.

checksumstringoptional

BodyOptional client checksum verified during direct-upload finalization.

upload_modestringoptional

Bodyproxied_multipart or direct_gcs_resumable. REST defaults to proxied_multipart.

ttl_secondsintegeroptional

BodyRequested upload-credential lifetime, bounded by the service.

Responses

201

Instructions for exactly one upload before expires_at.

400

The request is invalid or contains an unsupported value.

401

The bearer token is missing, invalid, or expired.

403

The account plan or current grant does not allow the action.

413

The ZIP exceeds the active upload transport limit.