get_deploy | Get one deploy of a service (see list_deploys): status, commit, trigger, start and finish times. |
get_service | Get a service by id (see list_services): type, repository, branch, settings, suspended state and dashboard URL. |
list_custom_domains | List the custom domains of a service with their verification status. Optional: name (array), domainType (“apex”|“subdomain”), verificationStatus (“verified”|“unverified”), createdBefore / createdAfter (ISO 8601), cursor, limit (integer 1-100). |
list_deploys | List the deploys of a service, newest first (deploy id, commit, status). Optional: status (array of created, queued, build_in_progress, update_in_progress, live, deactivated, build_failed, update_failed, canceled, pre_deploy_in_progress, pre_deploy_failed), createdBefore / createdAfter / updatedBefore / updatedAfter / finishedBefore / finishedAfter (ISO 8601), cursor, limit (integer 1-100). |
list_jobs | List the one-off jobs run on a service (id, start command, status). Optional: status (array of pending, running, succeeded, failed, canceled), createdBefore / createdAfter / startedBefore / startedAfter / finishedBefore / finishedAfter (ISO 8601), cursor, limit (integer 1-100). |
list_logs | List logs of one or more resources of a workspace (all in the same region). Required: ownerId (string, see list_workspaces), resource (array of resource ids — service, cron job, job, Postgres, Redis… — see list_services). Optional: startTime / endTime (ISO 8601, default = last hour), direction (“backward” = newest first, default | “forward”), level, type (app, request, build), text, instance, host, statusCode, method, path (each an array of strings; level, text, host, statusCode, method and path accept wildcards and regex), limit (integer 1-100). When hasMore is true, pass nextStartTime / nextEndTime as startTime / endTime. |
list_services | List services (their id is the serviceId used by the other actions). Optional filters: ownerId (array, see list_workspaces), name (array), type (array of static_site, web_service, private_service, background_worker, cron_job), environmentId (array), region (array of frankfurt, oregon, ohio, singapore, virginia), suspended (array of suspended, not_suspended), includePreviews (boolean), createdBefore / createdAfter / updatedBefore / updatedAfter (ISO 8601), cursor, limit (integer 1-100). |
list_workspaces | List the workspaces the API key can access — gives the ownerId used by list_services and list_logs. No argument required. Optional: name (array of exact workspace names), email (array of owner email addresses), cursor, limit (integer 1-100). |