ORorgo
apps

Change an app

Changed on

Any of the create fields. env replaces the app’s variables; secret_env changes single secrets: a value sets one, null removes one, and secrets left out are kept. Applied like a create. An app that belongs to a deploy is changed from its deploy (409 MANAGED_BY_DEPLOY).

patch/api/computers/{id}/services/{serviceId}

Request

  • Base URL
    https://www.orgo.ai
  • Auth
    HTTP bearer

Path parameters

idstring required

Computer id.

serviceIdstring uuid required

Request body

namestring
commandstring
cwdstring nullable
portinteger nullable
restart'always' | 'on-failure' | 'no'
run_asstring
enabledboolean
envobject

Replaces every plain variable.

secret_envobject

A value sets that secret, null removes it; others are kept.

Response

Changed.

idstring uuid required
namestring required
kind'command' | 'deploy' required

deploy: the app of a deploy, changed from the deploy.

deploy_project_idstring uuid nullable
commandstring required
cwdstring nullable
envobject required
secret_env_keysstring[] required

Names of the secret variables. Their values are never returned.

portinteger nullable
restart'always' | 'on-failure' | 'no' required
run_asstring required
enabledboolean required
status'running' | 'starting' | 'crashing' | 'stopped' | 'exited' | 'failed' | 'pending' | 'off' | 'unknown' required

pending: saved, not on the computer yet. crashing: it keeps exiting soon after it starts. failed: it could not be started.

status_detailstring nullable

The process manager’s own words, e.g. "pid 812, uptime 2:14:09".

status_atstring date-time nullable
listeningboolean nullable

Something listens on port (null: no port, or the computer was not asked).

listening_publiclyboolean nullable

It listens beyond 127.0.0.1, so a public URL reaches it.

appliedboolean required

The computer has this version of the app.

errorstring nullable
public_urlstring nullable

The public URL on this port, where public URLs are on.

created_atstring date-time
updated_atstring date-time

Changes

  • 60e768a2bb9dRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • afb6f0ee1aacRevision changes
    • info

      added the non-success response with the status