# at.happyproto.server.upgradeInstance

> Upgrade one of the caller's instances to the newer HappyView release its availableVersion offers, and start a job that follows the upgrade. The instance is offline for about 30 seconds; its database is snapshotted first, and a release that does not come up healthy is rolled back. Customers only.

- Kind: procedure
- Authority: server.happyproto.at
- Lexicon: 1
- Published by [happyproto.at](https://lexicon.garden/identity/did:plc:mo7vq4jbioxwafy5zkcc3eux), the NSID's authority

## Links

- [Documentation](https://lexicon.garden/lexicon/did:plc:mo7vq4jbioxwafy5zkcc3eux/at.happyproto.server.upgradeInstance)
- [Schema JSON](https://lexicon.garden/lexicon/did:plc:mo7vq4jbioxwafy5zkcc3eux/at.happyproto.server.upgradeInstance/schema.json)
- [Analytics](https://lexicon.garden/lexicon/did:plc:mo7vq4jbioxwafy5zkcc3eux/at.happyproto.server.upgradeInstance/analytics)

## Procedure (`at.happyproto.server.upgradeInstance`)

Type: procedure · POST

### Input (application/json)

- `id` (string, required): The instance's UUID.
- `idempotencyKey` (string, required): A UUID the client generates once per intended change and resends on every retry of it, so a retry gets the original reply instead of acting twice.
- `version` (string, required): The release to upgrade to: the instance's availableVersion.version, as the caller was shown it.

### Output (application/json)

- `jobId` (string, required): The background job following the change. Poll it with at.happyproto.server.getJob.

### Errors

- `AuthRequired`: This endpoint requires an authenticated caller.
- `Forbidden`: The caller is not a HappyProto customer, or the provisioner refused them.
- `InvalidRequest`: id or idempotencyKey is missing or not a UUID, version is missing, or the release is not newer than the one the instance runs.
- `NotFound`: No such instance, or it is not the caller's. The two are indistinguishable.
- `InvalidSlug`: Passed through from the provisioner: it reserves slugs by configuration as well.
- `SlugTaken`: Passed through from the provisioner.
- `NotEntitled`: Passed through from the provisioner.
- `InstanceLimit`: Passed through from the provisioner.
- `NoCapacity`: Passed through from the provisioner.
- `OperationInProgress`: Passed through from the provisioner: the instance is already changing, or a request with this idempotencyKey is still running.
- `UpgradeUnavailable`: The release is not the one on offer for this instance: there is none, a newer one replaced it, or the instance already runs it.
- `Upstream`: The provisioner is unreachable, not configured, or answered with an error it does not explain to callers, or the job could not be started.

## Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Upgrade one of the caller's instances to the newer HappyView release its availableVersion offers, and start a job that follows the upgrade. The instance is offline for about 30 seconds; its database is snapshotted first, and a release that does not come up healthy is rolled back. Customers only.",
      "errors": [
        {
          "description": "This endpoint requires an authenticated caller.",
          "name": "AuthRequired"
        },
        {
          "description": "The caller is not a HappyProto customer, or the provisioner refused them.",
          "name": "Forbidden"
        },
        {
          "description": "id or idempotencyKey is missing or not a UUID, version is missing, or the release is not newer than the one the instance runs.",
          "name": "InvalidRequest"
        },
        {
          "description": "No such instance, or it is not the caller's. The two are indistinguishable.",
          "name": "NotFound"
        },
        {
          "description": "Passed through from the provisioner: it reserves slugs by configuration as well.",
          "name": "InvalidSlug"
        },
        {
          "description": "Passed through from the provisioner.",
          "name": "SlugTaken"
        },
        {
          "description": "Passed through from the provisioner.",
          "name": "NotEntitled"
        },
        {
          "description": "Passed through from the provisioner.",
          "name": "InstanceLimit"
        },
        {
          "description": "Passed through from the provisioner.",
          "name": "NoCapacity"
        },
        {
          "description": "Passed through from the provisioner: the instance is already changing, or a request with this idempotencyKey is still running.",
          "name": "OperationInProgress"
        },
        {
          "description": "The release is not the one on offer for this instance: there is none, a newer one replaced it, or the instance already runs it.",
          "name": "UpgradeUnavailable"
        },
        {
          "description": "The provisioner is unreachable, not configured, or answered with an error it does not explain to callers, or the job could not be started.",
          "name": "Upstream"
        }
      ],
      "input": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "id": {
              "description": "The instance's UUID.",
              "type": "string"
            },
            "idempotencyKey": {
              "description": "A UUID the client generates once per intended change and resends on every retry of it, so a retry gets the original reply instead of acting twice.",
              "type": "string"
            },
            "version": {
              "description": "The release to upgrade to: the instance's availableVersion.version, as the caller was shown it.",
              "type": "string"
            }
          },
          "required": [
            "id",
            "version",
            "idempotencyKey"
          ],
          "type": "object"
        }
      },
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "jobId": {
              "description": "The background job following the change. Poll it with at.happyproto.server.getJob.",
              "type": "string"
            }
          },
          "required": [
            "jobId"
          ],
          "type": "object"
        }
      },
      "type": "procedure"
    }
  },
  "id": "at.happyproto.server.upgradeInstance",
  "lexicon": 1
}
```