# Render

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

App · 20 actions. Web page: https://docs.lodol.com/docs/integrations/render

## Actions

### Cancel deploy

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

**Inputs**

- Service (`service_id`, text, required): The ID of the service
- Deploy ID (`deploy_id`, text, required): The ID of the deploy

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "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**

- Service (`service_id`, text, required): The ID of the service
- Status (`status`, list): Filter for deploys with the specified statuses. One 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 before (`created_before`, date and time): Filter for deploys created before a certain time (specified as an ISO 8601 timestamp)
- Created after (`created_after`, date and time): Filter for deploys created after a certain time (specified as an ISO 8601 timestamp)
- Updated before (`updated_before`, date and time): Filter for deploys updated before a certain time (specified as an ISO 8601 timestamp)
- Updated after (`updated_after`, date and time): Filter for deploys updated after a certain time (specified as an ISO 8601 timestamp)
- Finished before (`finished_before`, date and time): Filter for deploys finished before a certain time (specified as an ISO 8601 timestamp)
- Finished after (`finished_after`, date and time): Filter for deploys finished after a certain time (specified as an ISO 8601 timestamp)
- Cursor (`cursor`, text): The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination).
- Limit (`limit`, number): The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination). From 1 to 100.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "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 ID (`owner_id`, list): The ID of the workspaces to return resources for
- Disk (`disk_id`, list): Filter by disk IDs
- Name (`name`, list): Filter by name
- Created before (`created_before`, date and time): Filter for resources created before a certain time (specified as an ISO 8601 timestamp)
- Created after (`created_after`, date and time): Filter for resources created after a certain time (specified as an ISO 8601 timestamp)
- Updated before (`updated_before`, date and time): Filter for resources updated before a certain time (specified as an ISO 8601 timestamp)
- Updated after (`updated_after`, date and time): Filter for resources updated after a certain time (specified as an ISO 8601 timestamp)
- Service (`service_id`, list): Filter for resources by service ID
- Cursor (`cursor`, text): The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination).
- Limit (`limit`, number): The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination). From 1 to 100.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "items": [],
    "next_cursor": "example"
  }
}
```

### List environment variables

List all environment variables of a service.

**Inputs**

- Service (`service_id`, text, required): The ID of the service
- Cursor (`cursor`, text): The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination).
- Limit (`limit`, number): The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination). From 1 to 100.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "items": [],
    "next_cursor": "example"
  }
}
```

### List events

List recent events for a service.

**Inputs**

- Service (`service_id`, text, required): The ID of the service
- Type (`type`, text): The type of event to filter to. One 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 time (`start_time`, date and time): Epoch/Unix timestamp of start of time range to return. Defaults to `now() - 1 hour`.
- End time (`end_time`, date and time): Epoch/Unix timestamp of end of time range to return. Defaults to `now()`.
- Cursor (`cursor`, text): The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination).
- Limit (`limit`, number): The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination). From 1 to 100.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "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**

- Service (`service_id`, text, required): The ID of the service
- Cursor (`cursor`, text): The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination).
- Limit (`limit`, number): The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination). From 1 to 100.
- Status (`status`, list): Filter for the status of the job (`pending`, `running`, `succeeded`, `failed`, or `canceled`). One or more of: `pending`, `running`, `succeeded`, `failed`, `canceled`.
- Created before (`created_before`, date and time): Filter for jobs created before a certain time (specified as an ISO 8601 timestamp)
- Created after (`created_after`, date and time): Filter for jobs created after a certain time (specified as an ISO 8601 timestamp)
- Started before (`started_before`, date and time): Filter for jobs started before a certain time (specified as an ISO 8601 timestamp)
- Started after (`started_after`, date and time): Filter for jobs started after a certain time (specified as an ISO 8601 timestamp)
- Finished before (`finished_before`, date and time): Filter for jobs finished before a certain time (specified as an ISO 8601 timestamp)
- Finished after (`finished_after`, date and time): Filter for jobs finished after a certain time (specified as an ISO 8601 timestamp)

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "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**

- Name (`name`, list): Filter for the name of a credential
- Username (`username`, list): Filter for the username of a credential
- Type (`type`, list): Filter for the registry type for the credential. One or more of: `GITHUB`, `GITLAB`, `DOCKER`, `GOOGLE_ARTIFACT` (Google artifact), `AWS_ECR` (Aws ecr).
- Created before (`created_before`, date and time): Filter for services created before a certain time (specified as an ISO 8601 timestamp)
- Created after (`created_after`, date and time): Filter for services created after a certain time (specified as an ISO 8601 timestamp)
- Updated before (`updated_before`, date and time): Filter for services updated before a certain time (specified as an ISO 8601 timestamp)
- Updated after (`updated_after`, date and time): Filter for services updated after a certain time (specified as an ISO 8601 timestamp)
- Owner ID (`owner_id`, list): The ID of the workspaces to return resources for
- Cursor (`cursor`, text): The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination).
- Limit (`limit`, number): The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination). From 1 to 100.

**Outputs**

- `data` (list): Returned value.

**Example output**

```json
{
  "data": []
}
```

### List services

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

**Inputs**

- Name (`name`, list): Filter by name
- Type (`type`, list): Filter for types of services. One or more of: `static_site` (Static site), `web_service` (Web service), `private_service` (Private service), `background_worker` (Background worker), `cron_job` (Cron job).
- Environment ID (`environment_id`, list): Filter for resources that belong to an environment
- Env (`env`, list): Filter for environments (runtimes) of services (deprecated; use `runtime` instead). One or more of: `docker`, `elixir`, `go`, `node`, `python`, `ruby`, `rust`, `image`.
- Region (`region`, list): Filter by resource region. One or more of: `frankfurt`, `oregon`, `ohio`, `singapore`, `virginia`.
- Suspended (`suspended`, list): Filter resources based on whether they're suspended or not suspended. One or more of: `suspended`, `not_suspended` (Not suspended).
- Created before (`created_before`, date and time): Filter for resources created before a certain time (specified as an ISO 8601 timestamp)
- Created after (`created_after`, date and time): Filter for resources created after a certain time (specified as an ISO 8601 timestamp)
- Updated before (`updated_before`, date and time): Filter for resources updated before a certain time (specified as an ISO 8601 timestamp)
- Updated after (`updated_after`, date and time): Filter for resources updated after a certain time (specified as an ISO 8601 timestamp)
- Owner ID (`owner_id`, list): The ID of the workspaces to return resources for
- Include previews (`include_previews`, true/false): Include previews in the response
- Cursor (`cursor`, text): The position in the result list to start from when fetching paginated results. For details, see [Pagination](https://api-docs.render.com/reference/pagination).
- Limit (`limit`, number): The maximum number of items to return. For details, see [Pagination](https://api-docs.render.com/reference/pagination). From 1 to 100.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "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**

- Disk (`disk_id`, text, required): The ID of the disk

**Outputs**

- `data` (list): Returned value.

**Example output**

```json
{
  "data": []
}
```

### List workspaces

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

**Inputs**

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

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "items": [],
    "next_cursor": "example"
  }
}
```

### Resume service

Resume a suspended service by its ID.

**Inputs**

- Service (`service_id`, text, required): The ID of the service

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {}
}
```

### Retrieve deploy

Get the details of one deploy of a service.

**Inputs**

- Service (`service_id`, text, required): The ID of the service
- Deploy ID (`deploy_id`, text, required): The ID of the deploy

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "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**

- Disk (`disk_id`, text, required): The ID of the disk

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "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**

- Service (`service_id`, text, required): The ID of the service
- Job ID (`job_id`, text, required): The ID of the job

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "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 ID (`registry_credential_id`, text, required): The ID of the registry credential

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "id": "example",
    "name": "example",
    "registry": "GITHUB",
    "updatedAt": "example",
    "username": "example"
  }
}
```

### Retrieve service

Get a service by its ID.

**Inputs**

- Service (`service_id`, text, required): The ID of the service

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "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 ID (`owner_id`, text, required): The ID of the user or team

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "email": "example",
    "id": "example",
    "ipAllowList": [],
    "name": "example",
    "twoFactorAuthEnabled": false,
    "type": "user"
  }
}
```

### Suspend service

Suspend a service by its ID.

**Inputs**

- Service (`service_id`, text, required): The ID of the service

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {}
}
```

### Trigger deploy

Start a deploy of a service.

**Inputs**

- Service (`service_id`, text, required): The ID of the service
- Build ID (`build_id`, text): The ID of the build to deploy. Cannot be combined with `commitId`, `imageUrl`, or `deployMode`.
- Clear cache (`clear_cache`, text): 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 ID (`commit_id`, text): 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 url (`image_url`, text): 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 mode (`deploy_mode`, text): 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**

- `data` (object): Returned value.

**Example output**

```json
{
  "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**

- Service (`service_id`, text, required): The ID of the service
- Build source ID (`build_source_id`, text): 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 deploy (`auto_deploy`, text): 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 trigger (`auto_deploy_trigger`, text): 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`.
- Repo (`repo`, text): Returned value.
- Branch (`branch`, text): Returned value.
- Image (`image`, object): Returned value.
- Name (`name`, text): Returned value.
- Build filter (`build_filter`, object): Returned value.
- Root dir (`root_dir`, text): Returned value.
- Service details (`service_details`, object): See the documented object structure in the API reference.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "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"
  }
}
```
