at.happyproto.server.setPrimaryDomain

{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Make a domain the primary of one of the caller's instances: a verified custom domain that is serving, or the platform subdomain. The instance restarts onto it. 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": "instanceId or idempotencyKey is not a UUID, or hostname is missing or too long.",
          "name": "InvalidRequest"
        },
        {
          "description": "No such instance or domain, or it is not the caller's. The cases are indistinguishable.",
          "name": "NotFound"
        },
        {
          "description": "Custom domains are not switched on yet.",
          "name": "NotAvailable"
        },
        {
          "description": "Passed through from the provisioner.",
          "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 hostname is not a valid public hostname: no scheme, port, path, wildcard or IP address.",
          "name": "InvalidHostname"
        },
        {
          "description": "Passed through from the provisioner.",
          "name": "PlatformHostname"
        },
        {
          "description": "Passed through from the provisioner.",
          "name": "DomainExists"
        },
        {
          "description": "Passed through from the provisioner.",
          "name": "DomainLimit"
        },
        {
          "description": "Passed through from the provisioner.",
          "name": "TooSoon"
        },
        {
          "description": "Passed through from the provisioner.",
          "name": "DomainIsPrimary"
        },
        {
          "description": "The hostname is not a verified domain of this instance: still pending, lapsed, or about to lapse.",
          "name": "NotVerified"
        },
        {
          "description": "The domain's certificate isn't issued yet, or the instance is stopped, so the domain isn't serving over HTTPS.",
          "name": "CertificateNotReady"
        },
        {
          "description": "The instance runs a HappyView too old to switch its primary domain safely. Update the instance first.",
          "name": "VersionTooOld"
        },
        {
          "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": {
            "hostname": {
              "description": "The verified custom domain, or the instance's own <slug>.hpy.at.",
              "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"
            },
            "instanceId": {
              "description": "The instance's UUID.",
              "type": "string"
            }
          },
          "required": [
            "instanceId",
            "hostname",
            "idempotencyKey"
          ],
          "type": "object"
        }
      },
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "jobId": {
              "description": "The background job following the switch, when there was one. Absent when the hostname was already the requested primary. Poll it with at.happyproto.server.getJob.",
              "type": "string"
            }
          },
          "required": [],
          "type": "object"
        }
      },
      "type": "procedure"
    }
  },
  "id": "at.happyproto.server.setPrimaryDomain",
  "lexicon": 1
}