forge_list_organizations | core | List accessible organizations and their slugs, or get one |
forge_get_current_user | core | The Forge user the API token belongs to |
forge_list_servers | core | List servers with filters, sorting and pagination |
forge_get_server | core | Every detail of a server |
forge_list_sites | core | Sites of an organization, a server or all organizations, with latest deployment |
forge_get_site | core | Every detail of a site, including its server |
forge_list_server_events | core | Operations Forge ran on a server or across the organization |
forge_get_server_event | core | An event with the output of its script |
forge_create_site | sites | Create a site (optionally with repository and database) and wait until it is installed |
forge_create_balanced_site | sites | Create a site on a load balancer |
forge_update_site | sites | Change PHP version, type, directories, branch, push to deploy, release retention |
forge_update_site_repository | sites | Switch source control provider, repository or branch |
forge_delete_site | sites | Delete a site |
forge_set_site_env_vars | sites | Set or remove .env variables without exposing the file |
forge_get_site_environment 🔑 | sites | Read the whole .env file |
forge_update_site_environment 🔑 | sites | Replace the whole .env file |
forge_get_site_nginx_config | sites | Read the Nginx configuration of a site or one of its domains |
forge_update_site_nginx_config | sites | Replace the Nginx configuration of a site or one of its domains |
forge_get_site_log | sites | End of the application, Nginx access or Nginx error log |
forge_clear_site_log | sites | Empty a site log |
forge_get_site_healthcheck | sites | Healthcheck URL used after zero-downtime deployments |
forge_update_site_healthcheck | sites | Set or remove the healthcheck URL |
forge_list_domains | sites | Domains of a site with status and www redirection |
forge_get_domain | sites | A domain with the DNS records to configure |
forge_add_domain | sites | Add a domain (alias) and wait until it is enabled |
forge_update_domain | sites | Change www redirection and wildcard subdomains |
forge_run_domain_action | sites | Enable, disable or mark a domain as primary |
forge_delete_domain | sites | Remove a domain |
forge_list_certificates | sites | SSL certificates of a site or of one domain |
forge_get_certificate | sites | A certificate, or the active one |
forge_create_certificate | sites | Let's Encrypt, existing, CSR or cloned certificate, waiting until installed |
forge_run_certificate_action | sites | Activate or deactivate a certificate |
forge_delete_certificate | sites | Delete a certificate |
forge_list_package_credentials | sites | Credentials for private Composer repositories and npm registries (secrets hidden) |
forge_set_package_credentials | sites | Add or replace Composer or npm credentials |
forge_delete_package_credentials | sites | Remove Composer or npm credentials |
forge_get_load_balancer | sites | Servers a load-balanced site sends traffic to |
forge_update_load_balancer | sites | Replace the nodes and balancing method, take nodes out of rotation |
forge_create_server | servers | Provision a server on a cloud provider or connect a custom VPS, waiting until it is ready |
forge_run_service_action | servers | Restart or stop Nginx, MySQL, Postgres, Redis, Supervisor; restart or reload PHP-FPM |
forge_run_server_action | servers | Reboot or power-cycle a server |
forge_get_server_log | servers | End of a server log (Nginx, PHP-FPM, MySQL, cron, daemons) |
forge_clear_server_log | servers | Empty a server log |
forge_update_server | servers | Rename, change IP addresses, timezone or tags |
forge_get_server_network | servers | Servers that can reach each other on the private network |
forge_update_server_network | servers | Set the server network |
forge_list_nginx_templates | servers | Custom Nginx templates for new sites |
forge_create_nginx_template | servers | Save an Nginx template |
forge_update_nginx_template | servers | Rename or replace an Nginx template |
forge_delete_nginx_template | servers | Delete an Nginx template |
forge_list_archived_servers | servers | Archived servers |
forge_archive_server | servers | Archive a server (Forge stops managing it) |
forge_unarchive_server | servers | Restore an archived server |
forge_delete_server | servers | Delete a server (optionally keeping it at the provider) |
forge_list_php_versions | servers | Installed PHP versions |
forge_get_php_settings | servers | Default CLI and site versions, upload and execution limits, OPcache |
forge_install_php_version | servers | Install a PHP version (optionally as default) and wait until installed |
forge_upgrade_php_version | servers | Update a PHP version to its latest patch release |
forge_uninstall_php_version | servers | Uninstall a PHP version |
forge_set_default_php_version | servers | Default PHP version for the CLI or for new sites |
forge_update_php_limits | servers | Max upload size and max execution time |
forge_set_php_opcache | servers | Enable or disable OPcache |
forge_get_php_config | servers | FPM or CLI php.ini, or the FPM pool configuration |
forge_update_php_config | servers | Replace a PHP configuration file |
forge_list_databases | databases | Database schemas on a server |
forge_create_database | databases | Create a database (optionally with a user) and wait until installed |
forge_delete_database | databases | Drop a database |
forge_sync_databases | databases | Import databases created outside Forge |
forge_list_database_users | databases | Database users on a server |
forge_create_database_user | databases | Create a user with access to databases (by ID or name) |
forge_update_database_user | databases | Change a user's password or databases |
forge_delete_database_user | databases | Delete a database user |
forge_update_database_root_password | databases | Change the database root password |
forge_list_backup_configurations | databases | Scheduled database backups: storage, schedule, retention, next run |
forge_create_backup_configuration | databases | Schedule backups of databases (by ID or name) to a storage provider |
forge_update_backup_configuration | databases | Change storage, databases, schedule or retention |
forge_delete_backup_configuration | databases | Stop scheduled backups |
forge_list_backups | databases | Backups of a configuration with status and size |
forge_create_backup | databases | Run a backup now and wait until it finishes |
forge_delete_backup | databases | Delete a backup |
forge_restore_backup | databases | Restore a database from a backup (overwrites it) |
forge_list_storage_providers | storage | S3, Spaces, Hetzner, OVH, Scaleway or S3-compatible storage for backups |
forge_create_storage_provider | storage | Add a storage provider (credentials are never returned) |
forge_update_storage_provider | storage | Change name, location or credentials |
forge_delete_storage_provider | storage | Remove a storage provider that no backup uses |
forge_list_deployments | deployments | Deployments of a site or of every site on a server |
forge_get_deployment | deployments | A deployment with the end of its log |
forge_get_deployment_status | deployments | Whether a deployment is running |
forge_deploy_site | deployments | Deploy a site and (optionally) wait for the result, with progress notifications |
forge_reset_deployment_state | deployments | Unblock a stuck deployment |
forge_get_deployment_script | deployments | Read the deployment script |
forge_update_deployment_script | deployments | Replace the deployment script |
forge_set_push_to_deploy | deployments | Enable or disable push to deploy |
forge_list_deployment_webhooks | deployments | Webhooks notified after deployments |
forge_create_deployment_webhook | deployments | Add a deployment webhook |
forge_delete_deployment_webhook | deployments | Remove a deployment webhook |
forge_get_deploy_key | deployments | The site's SSH deploy key |
forge_create_deploy_key | deployments | Create a deploy key |
forge_delete_deploy_key | deployments | Remove the deploy key |
forge_get_deploy_hook 🔑 | deployments | The deployment trigger URL |
forge_regenerate_deploy_hook 🔑 | deployments | Generate a new deployment trigger URL |
forge_list_scheduled_jobs | jobs | Scheduled jobs (cron) of a server or a site |
forge_get_scheduled_job | jobs | A scheduled job with the output of its last run |
forge_create_scheduled_job | jobs | Schedule a command, optionally with a heartbeat |
forge_delete_scheduled_job | jobs | Remove a scheduled job |
forge_list_background_processes | jobs | Supervisor daemons (queue workers, …) and their status |
forge_get_background_process_log | jobs | End of a background process log |
forge_create_background_process | jobs | Run a command permanently under Supervisor and wait until it is running |
forge_update_background_process | jobs | Rename or replace the Supervisor configuration |
forge_run_background_process_action | jobs | Start, stop or restart a background process, or empty its log |
forge_delete_background_process | jobs | Stop and remove a background process |
forge_list_firewall_rules | security | Open and blocked ports of a server |
forge_create_firewall_rule | security | Allow or deny a port (range) for everyone or an IP/subnet |
forge_delete_firewall_rule | security | Remove a firewall rule |
forge_list_security_rules | security | Password-protected (basic auth) paths of a site |
forge_create_security_rule | security | Protect a site or a path with a password |
forge_update_security_rule | security | Change name, path or users of a security rule |
forge_delete_security_rule | security | Remove a password protection |
forge_list_redirect_rules | security | Redirect rules of a site |
forge_create_redirect_rule | security | Add a 301 or 302 redirect |
forge_delete_redirect_rule | security | Remove a redirect |
forge_reorder_redirect_rules | security | Set the evaluation order of the redirects |
forge_export_redirect_rules | security | Redirects as CSV, in evaluation order |
forge_import_redirect_rules | security | Import redirects from CSV (append or replace) |
forge_list_ssh_keys | security | SSH keys authorized on a server |
forge_add_ssh_key | security | Authorize a public key |
forge_delete_ssh_key | security | Revoke an SSH key |
forge_get_server_public_key | security | The server's own public key (for Git providers, other servers) |
forge_regenerate_server_key | security | Replace the server's own key pair |
forge_list_heartbeats | monitoring | Heartbeats of a site and whether they are missing |
forge_create_heartbeat | monitoring | Alert when a scheduled task stops pinging |
forge_update_heartbeat | monitoring | Change name, schedule or grace period |
forge_delete_heartbeat | monitoring | Delete a heartbeat |
forge_list_monitors | monitoring | CPU, disk and memory monitors and their alert state |
forge_create_monitor | monitoring | Alert by email when a metric crosses a threshold |
forge_delete_monitor | monitoring | Remove a monitor |
forge_list_providers | providers | Cloud providers available for new servers |
forge_list_provider_regions | providers | Regions of a provider |
forge_list_provider_sizes | providers | Server sizes of a provider, optionally per region |
forge_list_server_credentials | providers | Provider accounts connected to the organization |
forge_list_vpcs | providers | Private networks of a provider account in a region |
forge_create_vpc | providers | Create a private network |
forge_list_recipes | recipes | Your recipes or the ones Forge provides |
forge_create_recipe | recipes | Save a Bash script as a recipe |
forge_update_recipe | recipes | Rename a recipe or replace its script |
forge_delete_recipe | recipes | Delete a recipe |
forge_run_recipe | recipes | Run a recipe on servers and wait for every run |
forge_list_recipe_runs | recipes | Runs of a recipe, with output |
forge_list_teams | teams | Teams of the organization |
forge_create_team | teams | Create a team with members and invitations |
forge_update_team | teams | Rename a team or replace its members |
forge_delete_team | teams | Delete a team |
forge_list_team_members | teams | Members of a team and their roles |
forge_update_team_member | teams | Change a member's role |
forge_remove_team_member | teams | Remove a member from a team |
forge_list_team_invitations | teams | Pending invitations of a team |
forge_invite_team_member | teams | Invite someone by email |
forge_cancel_team_invitation | teams | Cancel a pending invitation |
forge_list_team_resources | teams | Servers, recipes or credentials shared with a team |
forge_share_with_team | teams | Share a server, recipe or credential with a team |
forge_unshare_from_team | teams | Revoke a team's access to a server, recipe or credential |
forge_list_roles | teams | Custom and predefined roles |
forge_list_permissions | teams | Permissions, or those of a role |
forge_create_role | teams | Create a custom role |
forge_update_role | teams | Rename a role or replace its permissions |
forge_delete_role | teams | Delete a custom role |
forge_get_site_integrations | integrations | Horizon, Octane, Reverb, Pulse, Inertia SSR, scheduler and maintenance mode status |
forge_enable_site_integration | integrations | Enable an integration (e.g. put the site in maintenance mode) and wait until it is active |
forge_disable_site_integration | integrations | Disable an integration (e.g. bring the site back up) |
forge_run_site_command | commands | Run a command in the site directory and return its output |
forge_list_site_commands | commands | Commands run on a site with status and exit code |
forge_get_site_command | commands | A command run with the end of its output |
forge_delete_site_command | commands | Remove a command run from the history |