---
title: "overlane deploy targets"
description: "List deploy targets and environments"
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.overlane.app/llms.txt
> Use this file to discover all available pages before exploring further.

# overlane deploy targets

{/* Generated by apps/docs/scripts/generate.mjs (CLI pages from the command registry in packages/cli). Do not edit; run `pnpm --filter @overlane/docs gen`. */}

Lists the places this project deploys to (Cloudflare Workers, Vercel, Netlify, Fly, AWS Lambda, a container image) and the environments on them, with which are protected. Provider tokens are never shown.

## Usage

```sh
overlane deploy targets
```

## Examples

```sh
overlane deploy targets
```

## Behavior

- Effect: `read` (changes nothing).
- Needs credentials: yes. Uses the network: yes.
- Supports `--dry-run`: no. Accepts `--force`: no.
- Machine-readable description: `overlane schema deploy targets`.

## Result

With `--json` (the default when stdout is not a terminal) the command prints this JSON Schema's shape on stdout.

```json
{
  "type": "object",
  "properties": {
    "tenantId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]*$",
      "description": "tenant identifier"
    },
    "targets": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "schemaVersion": {
            "type": "string",
            "const": "1"
          },
          "tenantId": {
            "type": "string",
            "minLength": 1,
            "maxLength": 128,
            "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]*$",
            "description": "tenant identifier"
          },
          "projectId": {
            "type": "string",
            "minLength": 1,
            "maxLength": 128,
            "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]*$",
            "description": "project identifier"
          },
          "targetId": {
            "type": "string",
            "minLength": 1,
            "maxLength": 64
          },
          "name": {
            "type": "string",
            "pattern": "^[a-z][a-z0-9-]{0,40}$"
          },
          "config": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "const": "workers"
                  },
                  "scriptName": {
                    "type": "string",
                    "pattern": "^[A-Za-z0-9][A-Za-z0-9._:/-]{0,127}$"
                  },
                  "accountId": {
                    "type": "string",
                    "pattern": "^[A-Za-z0-9][A-Za-z0-9._:/-]{0,127}$"
                  }
                },
                "required": [
                  "kind",
                  "scriptName",
                  "accountId"
                ],
                "additionalProperties": false
              },
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "const": "vercel"
                  },
                  "projectRef": {
                    "type": "string",
                    "pattern": "^[A-Za-z0-9][A-Za-z0-9._:/-]{0,127}$"
                  },
                  "teamId": {
                    "type": "string",
                    "pattern": "^[A-Za-z0-9][A-Za-z0-9._:/-]{0,127}$"
                  }
                },
                "required": [
                  "kind",
                  "projectRef"
                ],
                "additionalProperties": false
              },
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "const": "netlify"
                  },
                  "siteId": {
                    "type": "string",
                    "pattern": "^[A-Za-z0-9][A-Za-z0-9._:/-]{0,127}$"
                  }
                },
                "required": [
                  "kind",
                  "siteId"
                ],
                "additionalProperties": false
              },
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "const": "fly"
                  },
                  "app": {
                    "type": "string",
                    "pattern": "^[A-Za-z0-9][A-Za-z0-9._:/-]{0,127}$"
                  },
                  "machineId": {
                    "type": "string",
                    "pattern": "^[A-Za-z0-9][A-Za-z0-9._:/-]{0,127}$"
                  }
                },
                "required": [
                  "kind",
                  "app"
                ],
                "additionalProperties": false
              },
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "const": "overlane-hosting"
                  },
                  "scriptName": {
                    "type": "string",
                    "pattern": "^olh-[0-9a-f]{16}$"
                  }
                },
                "required": [
                  "kind",
                  "scriptName"
                ],
                "additionalProperties": false
              },
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "const": "aws"
                  },
                  "region": {
                    "type": "string",
                    "pattern": "^[a-z]{2}(?:-[a-z]+)+-[0-9]$"
                  },
                  "functionName": {
                    "type": "string",
                    "pattern": "^[A-Za-z0-9][A-Za-z0-9._:/-]{0,127}$"
                  }
                },
                "required": [
                  "kind",
                  "region",
                  "functionName"
                ],
                "additionalProperties": false
              },
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "const": "container"
                  },
                  "app": {
                    "type": "string",
                    "pattern": "^[A-Za-z0-9][A-Za-z0-9._:/-]{0,127}$"
                  },
                  "machineId": {
                    "type": "string",
                    "pattern": "^[A-Za-z0-9][A-Za-z0-9._:/-]{0,127}$"
                  },
                  "image": {
                    "type": "string",
                    "pattern": "^[a-z0-9][a-z0-9._\\-/:]{0,254}$"
                  },
                  "channels": {
                    "type": "object",
                    "propertyNames": {
                      "type": "string",
                      "pattern": "^[a-z][a-z0-9-]{0,40}$"
                    },
                    "additionalProperties": {
                      "type": "string",
                      "pattern": "^[A-Za-z0-9_][A-Za-z0-9._-]{0,127}$"
                    }
                  },
                  "port": {
                    "type": "integer",
                    "minimum": 1,
                    "maximum": 65535
                  },
                  "database": {
                    "type": "object",
                    "properties": {
                      "engine": {
                        "type": "string",
                        "const": "postgres"
                      },
                      "version": {
                        "type": "string",
                        "pattern": "^[0-9]{1,2}$"
                      },
                      "migrations": {
                        "type": "object",
                        "properties": {
                          "command": {
                            "type": "string",
                            "minLength": 1,
                            "maxLength": 500
                          },
                          "path": {
                            "type": "string",
                            "pattern": "^[A-Za-z0-9][A-Za-z0-9._:/-]{0,127}$"
                          }
                        },
                        "required": [
                          "command"
                        ],
                        "additionalProperties": false
                      }
                    },
                    "required": [
                      "engine"
                    ],
                    "additionalProperties": false
                  }
                },
                "required": [
                  "kind",
                  "app",
                  "image",
                  "channels"
                ],
                "additionalProperties": false
              }
            ]
          },
          "vaultRef": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 128
              },
              {
                "type": "null"
              }
            ]
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
          }
        },
        "required": [
          "schemaVersion",
          "tenantId",
          "projectId",
          "targetId",
          "name",
          "config",
          "vaultRef",
          "createdAt"
        ],
        "additionalProperties": false
      }
    },
    "environments": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "schemaVersion": {
            "type": "string",
            "const": "1"
          },
          "tenantId": {
            "type": "string",
            "minLength": 1,
            "maxLength": 128,
            "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]*$",
            "description": "tenant identifier"
          },
          "projectId": {
            "type": "string",
            "minLength": 1,
            "maxLength": 128,
            "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]*$",
            "description": "project identifier"
          },
          "name": {
            "type": "string",
            "pattern": "^[a-z][a-z0-9-]{0,40}$"
          },
          "targetId": {
            "type": "string"
          },
          "protected": {
            "type": "boolean"
          },
          "kind": {
            "type": "string",
            "enum": [
              "permanent",
              "preview"
            ]
          },
          "branch": {
            "type": [
              "string",
              "null"
            ]
          },
          "secretNames": {
            "maxItems": 100,
            "type": "array",
            "items": {
              "type": "string",
              "pattern": "^[A-Z][A-Z0-9_]{0,63}$"
            }
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
          }
        },
        "required": [
          "schemaVersion",
          "tenantId",
          "projectId",
          "name",
          "targetId",
          "protected",
          "kind",
          "branch",
          "secretNames",
          "createdAt"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "tenantId",
    "targets",
    "environments"
  ],
  "additionalProperties": false
}
```

See [exit codes](/cli/#exit-codes) for the status the process returns.

Source: https://docs.overlane.app/cli/deploy-targets/index.mdx
