at.happyproto.server.createInstance

{
  "description": "Create an instance for the caller, and start a job that follows its provisioning. 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": "slug, plan or idempotencyKey is missing or malformed.",
      "name": "InvalidRequest"
    },
    {
      "description": "Passed through from the provisioner.",
      "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 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": {
        "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"
        },
        "plan": {
          "description": "The plan's id, from at.happyproto.server.listPlans.",
          "type": "string"
        },
        "slug": {
          "description": "The instance's subdomain: 3 to 32 of a-z, 0-9 and -, starting with a letter.",
          "type": "string"
        }
      },
      "required": [
        "slug",
        "plan",
        "idempotencyKey"
      ],
      "type": "object"
    }
  },
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "instance": {
          "ref": "#instance",
          "type": "ref"
        },
        "jobId": {
          "description": "The background job following the change. Poll it with at.happyproto.server.getJob.",
          "type": "string"
        }
      },
      "required": [
        "instance",
        "jobId"
      ],
      "type": "object"
    }
  },
  "type": "procedure"
}