Deploy

Deploy a service. Returns NDJSON stream with progress updates.

Post the source as source_archive, the tar.gz, up to 100 MiB. Ship large files via volumes (cycls volume put), not the source archive.

timeout is how long a single request to the deployed service may run raise it for long compute, up to Cloud Run’s 3600s ceiling. cpu is raised automatically if memory requires more than you asked for.

concurrency is how many requests one instance serves at once. Leave it high for I/O-bound apps; set it to 1 for compute, so each call gets its own instance.

max_instances caps how many instances the service may scale to. 0 (default) leaves scaling to the platform.

volumes maps mount paths to volumes (JSON), e.g. {"/data": "shared"} or {"/data": {"name": "shared", "read_only": true, "sub_path": "v1"}}. Required, {} declares no storage; the deploy is a complete declaration. Unknown volumes are created (announced in the stream).

schedule fires the deployed function on a cron: {"cron": "0 3 * * *", "timezone": "Asia/Riyadh"}. Empty or omitted removes any schedule, the same complete-declaration rule.

Events: BUILDING → DEPLOYING → DONE (or ERROR)

POST https://api.cycls.ai/v1/deploy

Deploy

cURL

curl --request POST \
  --url https://api.cycls.ai/v1/deploy \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-API-Key: <api-key>' \
  --form 'function_name=<string>' \
  --form port=8080 \
  --form memory=1Gi \
  --form 'source_archive=<string>' \
  --form 'source_object=<string>' \
  --form session_affinity=false \
  --form use_http2=false \
  --form timeout=600 \
  --form cpu=1 \
  --form concurrency=80 \
  --form max_instances=0 \
  --form 'volumes=<string>' \
  --form schedule= \
  --form timezone= \
  --form source_archive.0='@example-file'

422

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

APIKeyHeaderHTTPBearer

X-API-Key · string · header · required

Your Cycls API key, from https://cloud.cycls.com. Sent as the X-API-Key header. This is the CYCLS_API_KEY the CLI uses.

Body

multipart/form-data

function_name · string · required

port · integer · default: 8080

memory · string · default: 1Gi

source_archive · file | null

source_object · string | null

session_affinity · boolean · default: false

use_http2 · boolean · default: false

timeout · integer · default: 600

Required range: 1 <= x <= 3600

cpu · integer · default: 1

concurrency · integer · default: 80

Required range: 1 <= x <= 1000

max_instances · integer · default: 0

Required range: 0 <= x <= 1000

volumes · string | null

schedule · string · default: ""

timezone · string · default: ""

Response

200

application/json

NDJSON stream of deployment progress