oec.sh

Read only: returns one server's provider, region, size, environment count and readiness.

Description is built at runtime.

Read only: returns one support ticket with its description and the public replies, oldest first (from_support marks replies from oec.sh Support). Internal notes are never included. Needs an organization-scoped API key with Support tickets turned on (Settings > API Keys in the dashboard).

Read only: returns one task's status, progress, current step, timing and error message. Works for every task type (deploy, restart, start, stop, backup, destroy).

Read only: returns the step log and error of an environment's latest task, or of a given task (deploy, restart, backup...). This is the task's own log, not the Odoo server log.

Read only: returns one outgoing webhook's URL, events, format, state and failure count.

Read only: lists an environment's backups, newest first, with status, type, size, timing, retention and note; optionally filtered by status or type.

Read only: lists oec.sh platform releases (release notes), newest first, each with version, date, title, highlights and changes by category (added, fixed, improved...). since_version returns only releases newer than that version; since_date only releases on or after that date. Use it to see what changed on the platform since a version or day.

Read only: lists an environment's deploy tasks, newest first, with status, timing and error message. A failed task with no started_at never ran (for example, another deployment was already running).

Read only: lists a project's environments with status, URL, branch, Odoo version and size, optionally only those in one status.

Read only: lists the projects this key can see (one project for a project-scoped key), with Odoo version, repository, default branch, server and environment count.

Read only: lists the organization's servers with provider, region, size, environment count and whether each is ready to take deploys (qualification_status).

Read only: lists the organization's support tickets, newest first, with ticket number, subject, status, priority, category and the project, environment or server each is about; optionally only one status. Needs an organization-scoped API key with Support tickets turned on (Settings > API Keys in the dashboard).

Read only: lists a webhook's 50 most recent delivery attempts, newest first, with event, status, HTTP response code and timing.

Read only: lists the outgoing webhooks this key can see, with URL, events, format, whether active and recent failure count.

Pulls the latest code into a running environment and restarts it, optionally updating all or some modules (faster than a full deploy, no rebuild). Modes: pull_restart, update_all, update_specific (needs modules). Module updates first save a copy of the database on the server as a restore point; skip_safety_copy leaves it out. A running backup refuses the update; ignore_running_backup goes ahead and that backup fails. Returns a task to follow with oecsh_wait_for_task.

Reinstalls the listed modules on a running environment (odoo -i), which can reset their data and settings to the module defaults. confirm must repeat the environment's name exactly as the user typed it. Returns a task to follow with oecsh_wait_for_task.

Restarts a running environment; the site is unavailable for a short time. Returns a task to follow with oecsh_wait_for_task.

Overwrites an environment's current database and files with a completed backup of that same environment; the site is unavailable while it runs and changes made since the backup are lost (a safety backup of the current data is taken first). confirm_environment_name must repeat the environment's name exactly as the user typed it. Returns a task to follow with oecsh_wait_for_task.

Revokes an oec.sh API key at once and for good: every program using it stops working, including this server if it is the key being revoked. Needs an organization-scoped full-access key. confirm must repeat the key's name exactly as the user typed it.

Replaces a webhook's signing secret: the old secret stops working at once, so the receiver rejects events until it is given the new one (in the answer, shown only once). confirm must repeat the webhook's URL exactly as the user typed it. The secret then sits in the conversation transcript: tell the user to rotate it in the oec.sh dashboard if the transcript is shared.

Starts a stopped environment. Returns a task to follow with oecsh_wait_for_task.

Stops a running environment: the site goes offline until it is started again (data is kept). Returns a task to follow with oecsh_wait_for_task.

Sends a test 'ping' event to the webhook's URL now and returns whether it answered, with the HTTP status and time taken. No delivery record is kept. confirm must repeat the host of the webhook's URL (e.g. hooks.example.com) exactly as the user typed it.

Changes an environment's name, branch, custom domain or size; the change takes effect on the next deploy or restart (it does not redeploy by itself). Pass domain as an empty string to remove it.

Changes a project's name, default branch or Odoo version; running environments are not redeployed and keep their installed version. To change the repository or git provider use oecsh_update_project_repository (opt-in).

Points a project at another git repository: every later deploy of its environments runs code from the new repository. Running environments are not redeployed. confirm must repeat the project's name exactly as the user typed it.

Changes a webhook's URL, events, description, format, or turns it on or off. With url, confirm must repeat the new URL's host (e.g. hooks.example.com) exactly as the user typed it.

Read only: checks a task every 5 to 15 seconds until it is completed, failed or cancelled, or until the time limit (50 seconds per call by default, 45 seconds on the hosted server; call again if it is still running). Returns the task as last seen.