Render

App · 20 actions

Inspect and manage services, deployments, disks, jobs and workspace resources.

Actions

ActionWhat it does
Cancel deployCancel an in-progress deploy for a service.
List deploysList a service's deploys matching the filters you give, or all of them if you give none.
List disksList the persistent disks matching the filters you give, or every disk you can view if you give none.
List environment variablesList all environment variables of a service.
List eventsList recent events for a service.
List jobsList a service's jobs matching the filters you give, or all of them if you give none.
List registry credentialsList the registry credentials matching the filters you give, or every one you can view if you give none.
List servicesList the services matching the filters you give, or every service you can view if you give none.
List snapshotsList the snapshots of a persistent disk.
List workspacesList the workspaces your API key can access.
Resume serviceResume a suspended service by its ID.
Retrieve deployGet the details of one deploy of a service.
Retrieve diskGet a persistent disk by its ID.
Retrieve jobGet the details of one one-off job for a service.
Retrieve registry credentialGet a registry credential by its ID.
Retrieve serviceGet a service by its ID.
Retrieve workspaceGet a workspace by its ID.
Suspend serviceSuspend a service by its ID.
Trigger deployStart a deploy of a service.
Update serviceUpdate a service by its ID.

Cancel deploy

Cancel an in-progress deploy for a service. Not supported for cron jobs.

Inputs

Serviceservice_idtextRequired
The ID of the service
Deploy IDdeploy_idtextRequired
The ID of the deploy

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "buildId": "example",
    "commit": {
      "createdAt": "example",
      "id": "example",
      "message": "example"
    },
    "createdAt": "example",
    "finishedAt": "example",
    "id": "example",
    "image": {
      "ref": "example",
      "registryCredential": "example",
      "sha": "example"
    },
    "startedAt": "example",
    "status": "created",
    "trigger": "api",
    "updatedAt": "example"
  }
}

List deploys

List a service's deploys matching the filters you give, or all of them if you give none.

Inputs

Serviceservice_idtextRequired
The ID of the service
Statusstatuslist
Filter for deploys with the specified statusesOne or more of: created, queued, build_in_progress (Build in progress), update_in_progress (Update in progress), live, deactivated, build_failed (Build failed), update_failed (Update failed), canceled, pre_deploy_in_progress (Pre deploy in progress), pre_deploy_failed (Pre deploy failed).
Created beforecreated_beforedate and time
Filter for deploys created before a certain time (specified as an ISO 8601 timestamp)
Created aftercreated_afterdate and time
Filter for deploys created after a certain time (specified as an ISO 8601 timestamp)
Updated beforeupdated_beforedate and time
Filter for deploys updated before a certain time (specified as an ISO 8601 timestamp)
Updated afterupdated_afterdate and time
Filter for deploys updated after a certain time (specified as an ISO 8601 timestamp)
Finished beforefinished_beforedate and time
Filter for deploys finished before a certain time (specified as an ISO 8601 timestamp)
Finished afterfinished_afterdate and time
Filter for deploys finished after a certain time (specified as an ISO 8601 timestamp)
Cursorcursortext
The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination).
Limitlimitnumber
The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination).From 1 to 100.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "items": [],
    "next_cursor": "example"
  }
}

List disks

List the persistent disks matching the filters you give, or every disk you can view if you give none.

Inputs

Owner IDowner_idlist
The ID of the workspaces to return resources for
Diskdisk_idlist
Filter by disk IDs
Namenamelist
Filter by name
Created beforecreated_beforedate and time
Filter for resources created before a certain time (specified as an ISO 8601 timestamp)
Created aftercreated_afterdate and time
Filter for resources created after a certain time (specified as an ISO 8601 timestamp)
Updated beforeupdated_beforedate and time
Filter for resources updated before a certain time (specified as an ISO 8601 timestamp)
Updated afterupdated_afterdate and time
Filter for resources updated after a certain time (specified as an ISO 8601 timestamp)
Serviceservice_idlist
Filter for resources by service ID
Cursorcursortext
The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination).
Limitlimitnumber
The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination).From 1 to 100.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "items": [],
    "next_cursor": "example"
  }
}

List environment variables

List all environment variables of a service.

Inputs

Serviceservice_idtextRequired
The ID of the service
Cursorcursortext
The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination).
Limitlimitnumber
The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination).From 1 to 100.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "items": [],
    "next_cursor": "example"
  }
}

List events

List recent events for a service.

Inputs

Serviceservice_idtextRequired
The ID of the service
Typetypetext
The type of event to filter toOne of: artifact_fetch_failed (Artifact fetch failed), artifact_source_changed (Artifact source changed), autoscaling_config_changed (Autoscaling config changed), autoscaling_ended (Autoscaling ended), autoscaling_started (Autoscaling started), branch_deleted (Branch deleted), build_ended (Build ended), build_started (Build started), commit_ignored (Commit ignored), cron_job_run_ended (Cron job run ended), and 34 more.
Start timestart_timedate and time
Epoch/Unix timestamp of start of time range to return. Defaults to `now() - 1 hour`.
End timeend_timedate and time
Epoch/Unix timestamp of end of time range to return. Defaults to `now()`.
Cursorcursortext
The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination).
Limitlimitnumber
The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination).From 1 to 100.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "items": [],
    "next_cursor": "example"
  }
}

List jobs

List a service's jobs matching the filters you give, or all of them if you give none.

Inputs

Serviceservice_idtextRequired
The ID of the service
Cursorcursortext
The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination).
Limitlimitnumber
The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination).From 1 to 100.
Statusstatuslist
Filter for the status of the job (`pending`, `running`, `succeeded`, `failed`, or `canceled`)One or more of: pending, running, succeeded, failed, canceled.
Created beforecreated_beforedate and time
Filter for jobs created before a certain time (specified as an ISO 8601 timestamp)
Created aftercreated_afterdate and time
Filter for jobs created after a certain time (specified as an ISO 8601 timestamp)
Started beforestarted_beforedate and time
Filter for jobs started before a certain time (specified as an ISO 8601 timestamp)
Started afterstarted_afterdate and time
Filter for jobs started after a certain time (specified as an ISO 8601 timestamp)
Finished beforefinished_beforedate and time
Filter for jobs finished before a certain time (specified as an ISO 8601 timestamp)
Finished afterfinished_afterdate and time
Filter for jobs finished after a certain time (specified as an ISO 8601 timestamp)

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "items": [],
    "next_cursor": "example"
  }
}

List registry credentials

List the registry credentials matching the filters you give, or every one you can view if you give none.

Inputs

Namenamelist
Filter for the name of a credential
Usernameusernamelist
Filter for the username of a credential
Typetypelist
Filter for the registry type for the credentialOne or more of: GITHUB, GITLAB, DOCKER, GOOGLE_ARTIFACT (Google artifact), AWS_ECR (Aws ecr).
Created beforecreated_beforedate and time
Filter for services created before a certain time (specified as an ISO 8601 timestamp)
Created aftercreated_afterdate and time
Filter for services created after a certain time (specified as an ISO 8601 timestamp)
Updated beforeupdated_beforedate and time
Filter for services updated before a certain time (specified as an ISO 8601 timestamp)
Updated afterupdated_afterdate and time
Filter for services updated after a certain time (specified as an ISO 8601 timestamp)
Owner IDowner_idlist
The ID of the workspaces to return resources for
Cursorcursortext
The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination).
Limitlimitnumber
The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination).From 1 to 100.

Outputs

datalist
Returned value.
Example output
{
  "data": []
}

List services

List the services matching the filters you give, or every service you can view if you give none.

Inputs

Namenamelist
Filter by name
Typetypelist
Filter for types of servicesOne or more of: static_site (Static site), web_service (Web service), private_service (Private service), background_worker (Background worker), cron_job (Cron job).
Environment IDenvironment_idlist
Filter for resources that belong to an environment
Envenvlist
Filter for environments (runtimes) of services (deprecated; use `runtime` instead)One or more of: docker, elixir, go, node, python, ruby, rust, image.
Regionregionlist
Filter by resource regionOne or more of: frankfurt, oregon, ohio, singapore, virginia.
Suspendedsuspendedlist
Filter resources based on whether they're suspended or not suspendedOne or more of: suspended, not_suspended (Not suspended).
Created beforecreated_beforedate and time
Filter for resources created before a certain time (specified as an ISO 8601 timestamp)
Created aftercreated_afterdate and time
Filter for resources created after a certain time (specified as an ISO 8601 timestamp)
Updated beforeupdated_beforedate and time
Filter for resources updated before a certain time (specified as an ISO 8601 timestamp)
Updated afterupdated_afterdate and time
Filter for resources updated after a certain time (specified as an ISO 8601 timestamp)
Owner IDowner_idlist
The ID of the workspaces to return resources for
Include previewsinclude_previewstrue/false
Include previews in the response
Cursorcursortext
The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination).
Limitlimitnumber
The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination).From 1 to 100.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "items": [],
    "next_cursor": "example"
  }
}

List snapshots

List the snapshots of a persistent disk. Each snapshot is a point-in-time copy of the disk's data.

Inputs

Diskdisk_idtextRequired
The ID of the disk

Outputs

datalist
Returned value.
Example output
{
  "data": []
}

List workspaces

List the workspaces your API key can access. You can filter by name or by owner email address.

Inputs

Namenamelist
Only return workspaces with one of the provided names. Only exact matches are returned.
Emailemaillist
Only return workspaces owned by one of the provided email addresses.
Cursorcursortext
The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination).
Limitlimitnumber
The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination).From 1 to 100.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "items": [],
    "next_cursor": "example"
  }
}

Resume service

Resume a suspended service by its ID.

Inputs

Serviceservice_idtextRequired
The ID of the service

Outputs

dataobject
Returned value.
Example output
{
  "data": {}
}

Retrieve deploy

Get the details of one deploy of a service.

Inputs

Serviceservice_idtextRequired
The ID of the service
Deploy IDdeploy_idtextRequired
The ID of the deploy

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "buildId": "example",
    "commit": {
      "createdAt": "example",
      "id": "example",
      "message": "example"
    },
    "createdAt": "example",
    "finishedAt": "example",
    "id": "example",
    "image": {
      "ref": "example",
      "registryCredential": "example",
      "sha": "example"
    },
    "startedAt": "example",
    "status": "created",
    "trigger": "api",
    "updatedAt": "example"
  }
}

Retrieve disk

Get a persistent disk by its ID.

Inputs

Diskdisk_idtextRequired
The ID of the disk

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "createdAt": "example",
    "id": "example",
    "mountPath": "example",
    "name": "example",
    "serviceId": "example",
    "sizeGB": 1,
    "updatedAt": "example"
  }
}

Retrieve job

Get the details of one one-off job for a service.

Inputs

Serviceservice_idtextRequired
The ID of the service
Job IDjob_idtextRequired
The ID of the job

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "createdAt": "example",
    "finishedAt": "example",
    "id": "example",
    "planId": "example",
    "serviceId": "example",
    "startCommand": "example",
    "startedAt": "example",
    "status": "pending"
  }
}

Retrieve registry credential

Get a registry credential by its ID.

Inputs

Registry credential IDregistry_credential_idtextRequired
The ID of the registry credential

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "id": "example",
    "name": "example",
    "registry": "GITHUB",
    "updatedAt": "example",
    "username": "example"
  }
}

Retrieve service

Get a service by its ID.

Inputs

Serviceservice_idtextRequired
The ID of the service

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "autoDeploy": "yes",
    "autoDeployTrigger": "commit",
    "branch": "example",
    "buildFilter": {
      "ignoredPaths": [],
      "paths": []
    },
    "buildSourceId": "example",
    "createdAt": "example",
    "dashboardUrl": "example",
    "environmentId": "example",
    "id": "example",
    "imagePath": "example",
    "name": "example",
    "notifyOnFail": "default",
    "ownerId": "example",
    "registryCredential": {
      "id": "example",
      "name": "example"
    },
    "repo": "example",
    "rootDir": "example",
    "serviceDetails": {},
    "slug": "example",
    "suspended": "suspended",
    "suspenders": [],
    "type": "static_site",
    "updatedAt": "example"
  }
}

Retrieve workspace

Get a workspace by its ID. Workspace IDs start with tea-. If you give a user ID instead, which starts with own-, you get that user's default workspace.

Inputs

Owner IDowner_idtextRequired
The ID of the user or team

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "email": "example",
    "id": "example",
    "ipAllowList": [],
    "name": "example",
    "twoFactorAuthEnabled": false,
    "type": "user"
  }
}

Suspend service

Suspend a service by its ID.

Inputs

Serviceservice_idtextRequired
The ID of the service

Outputs

dataobject
Returned value.
Example output
{
  "data": {}
}

Trigger deploy

Start a deploy of a service.

Inputs

Serviceservice_idtextRequired
The ID of the service
Build IDbuild_idtext
The ID of the build to deploy. Cannot be combined with `commitId`, `imageUrl`, or `deployMode`.
Clear cacheclear_cachetext
If `clear`, Render clears the service's build cache before deploying. This can be useful if you're experiencing issues with your build.One of: clear, do_not_clear (Do not clear).
Commit IDcommit_idtext
The SHA of a specific Git commit to deploy for a service. Defaults to the latest commit on the service's connected branch. Cannot be combined with `buildId`, `imageUrl`, or `deployMode: deploy_only`. Note that deploying a specific commit with this endpoint does not disable autodeploys for the service. You can toggle autodeploys for your service with the [Update service](https://api-docs.render.com/reference/update-service) endpoint or in the Render Dashboard. Not supported for cron jobs.
Image urlimage_urltext
The URL of the image to deploy for an image-backed service. Cannot be combined with `buildId`, `commitId`, or `deployMode: deploy_only`. The host, repository, and image name all must match the currently configured image for the service.
Deploy modedeploy_modetext
Deployment mode controlling build and deploy behavior. Defaults to `build_and_deploy` when not specified. **Validation:** `deployMode` cannot be combined with `buildId`. `deploy_only` cannot be combined with `commitId`, `imageUrl`, or `clearCache`.One of: deploy_only (Deploy only), build_and_deploy (Build and deploy).

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "buildId": "example",
    "commit": {
      "createdAt": "example",
      "id": "example",
      "message": "example"
    },
    "createdAt": "example",
    "finishedAt": "example",
    "id": "example",
    "image": {
      "ref": "example",
      "registryCredential": "example",
      "sha": "example"
    },
    "startedAt": "example",
    "status": "created",
    "trigger": "api",
    "updatedAt": "example"
  }
}

Update service

Update a service by its ID. A build source backed by a Git repository must be in the same region as the service.

Inputs

Serviceservice_idtextRequired
The ID of the service
Build source IDbuild_source_idtext
The ID of the Build Source to link this service to. Cannot be combined with build-configuration changes or other `serviceDetails` fields, except `startCommand`. Linking to a Build Source with a native runtime requires a start command, either in this request or already set on the service. Linking to a Build Source with a Docker or image runtime rejects a start command. A git-backed Build Source must be in the same region as the service; otherwise the request is rejected with 400 and `code: build_source_region_mismatch`.
Auto deployauto_deploytext
Deprecated: use `autoDeployTrigger` instead. You can't set both `autoDeploy` and `autoDeployTrigger` in the same request. - `yes` is equivalent to `autoDeployTrigger: commit`. - `no` is equivalent to `autoDeployTrigger: off`.One of: yes, no.
Auto deploy triggerauto_deploy_triggertext
Controls autodeploy behavior. - `commit`: Deploy each time a commit is pushed to the service's linked branch. - `checksPass`: Deploy each time a commit is pushed to the linked branch, but only after the commit's CI checks pass. - `off`: Disable autodeploys.One of: commit, off, checksPass.
Reporepotext
Returned value.
Branchbranchtext
Returned value.
Imageimageobject
Returned value.
Namenametext
Returned value.
Build filterbuild_filterobject
Returned value.
Root dirroot_dirtext
Returned value.
Service detailsservice_detailsobject
See the documented object structure in the API reference.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "autoDeploy": "yes",
    "autoDeployTrigger": "commit",
    "branch": "example",
    "buildFilter": {
      "ignoredPaths": [],
      "paths": []
    },
    "buildSourceId": "example",
    "createdAt": "example",
    "dashboardUrl": "example",
    "environmentId": "example",
    "id": "example",
    "imagePath": "example",
    "name": "example",
    "notifyOnFail": "default",
    "ownerId": "example",
    "registryCredential": {
      "id": "example",
      "name": "example"
    },
    "repo": "example",
    "rootDir": "example",
    "serviceDetails": {},
    "slug": "example",
    "suspended": "suspended",
    "suspenders": [],
    "type": "static_site",
    "updatedAt": "example"
  }
}

On this page