# Version routes

URL: /code/api/version · Id: `page:code/api/version`

> Every Version Verb as an api.sb route, with its inputs, result, refusals and an example.

Reference for [Version](/business/nouns/version).

| Noun | System | Run by |
| --- | --- | --- |
| [Version](/business/nouns/version) | [Repositories](/code/systems/repositories) | [Engineering Lead](/agents/engineering/engineering-lead) |

### Version.get
Returns one Version by id. [Verb page](/business/nouns/version/get?interface=api).

```text
GET /{namespace}/versions/{id}
```

Path: `id`. Query: the other inputs. Reads only: it emits no Event.

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | `string` | Yes | The id of the Version. |
| `at` | `string` | No | A time or Version name: the record as it stood then. Unset: as it stands now. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `version` | [Version](/business/nouns/version) | Yes | The Version. |

**Refuses when**

| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The key is valid, but its scopes do not allow this operation. | [`forbidden`](/code/api/errors/forbidden) | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |

**Example**

```bash
curl https://api.sb/leaseline.app/versions/version_4HTEMs14G4 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
```

```json
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Version",
  "$id": "https://api.sb/leaseline.app/versions/version_4HTEMs14G4",
  "version": {
    "$id": "https://api.sb/leaseline.app/versions/version_4HTEMs14G4",
    "$type": "Version",
    "fingerprint": "sha256:9f2c4e1a7b3d"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/versions/version_4HTEMs14G4",
    "up": "https://api.sb/leaseline.app/versions"
  },
  "actions": {
    "deploy": "https://api.sb/leaseline.app/versions/version_4HTEMs14G4/deploy"
  }
}
```

### Version.list
Returns Versions, newest first, one page at a time. [Verb page](/business/nouns/version/list?interface=api).

```text
GET /{namespace}/versions
```

Query: the inputs. Reads only: it emits no Event.

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `limit` | `integer` | No | At most this many records, up to 100. The default is 20. |
| `after` | `string` | No | The cursor from the previous page. |
| `where` | `string` | No | A filter over the properties, such as `paidAt = null and total.amount > 500`. |
| `sort` | `string` | No | Properties to sort by, comma-separated; a leading minus sorts descending. |
| `total` | `boolean` | No | True adds the match count as `meta.total`, exact up to 10,000 matches and estimated above. |
| `facets` | `string` | No | Properties to count by value, comma-separated, returned as `meta.facets`. |
| `fields` | `string` | No | Properties to return on each record, comma-separated; `$id` and `$type` always return. |
| `include` | `string` | No | Related records to embed in place of their URLs, comma-separated. |
| `depth` | `integer` | No | How many levels of related records to embed. The default is 1. |
| `q` | `string` | No | Words to match across the text properties, ranked by relevance. |
| `match` | `string` | No | Ranks the search by `words`, or `meaning`; words is the default. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `versions` | list of [Version](/business/nouns/version) | Yes | One page of Versions. |

**Refuses when**

| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The key is valid, but its scopes do not allow this operation. | [`forbidden`](/code/api/errors/forbidden) | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |

**Example**

```bash
curl "https://api.sb/leaseline.app/versions?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
```

```json
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Version",
  "versions": [
    {
      "$id": "https://api.sb/leaseline.app/versions/version_4HTEMs14G4",
      "$type": "Version",
      "fingerprint": "sha256:9f2c4e1a7b3d"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "version_4HTEMs14G4"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/versions?limit=20",
    "next": "https://api.sb/leaseline.app/versions?after=version_4HTEMs14G4"
  }
}
```

### Version.deploy
Deploy points a Startup’s live address at a Version, so every Interface serves that build. [Verb page](/business/nouns/version/deploy?interface=api).

```text
POST /{namespace}/versions/{version}/deploy
```

Path: `version`. Emits [`Version.deployed`](/business/events/Version.deployed).

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `version` | [Version](/business/nouns/version) | Yes | The Version to serve. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `version` | [Version](/business/nouns/version) | Yes | The Version, now live. |

**Refuses when**

| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The key is valid, but its scopes do not allow this operation. | [`forbidden`](/code/api/errors/forbidden) | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |
| The record is not in a state that allows this Verb, so the call is refused. | [`refused`](/code/api/errors/refused) | Read the record, run the Verb that moves it to an allowed state, then retry. | None. |
| `live` when a Secret a Function declares is missing in `live` | [`refused`](/code/api/errors/refused) | Clear what the check names, then call it again. | None. |

**Example**

```bash
curl -X POST https://api.sb/leaseline.app/versions/version_4HTEMs14G4/deploy \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
```

```json
{
  "api": "https://api.sb/leaseline.app",
  "version": {
    "$id": "https://api.sb/leaseline.app/versions/version_4HTEMs14G4",
    "$type": "Version",
    "fingerprint": "sha256:9f2c4e1a7b3d"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Version.deploy",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}
```