The Deployer

Checks whether a public GitHub, GitLab or Bitbucket repository will deploy: the services it found, what's missing (each with its fix), the environment variables it needs, and what it would cost a month on DigitalOcean, AWS, Google Cloud and Azure. Reads the code and changes nothing. No API key needed. A check can take up to a minute; if it's still running, call again with the check_id it returned.

{
  "type": "object",
  "properties": {
    "repo": {
      "type": "string",
      "description": "owner/name, or the repository's URL"
    },
    "check_id": {
      "type": "string",
      "description": "The check_id of an earlier check, to get its result"
    }
  }
}

Plans deploying a repository with the user's account on The Deployer: checks the repository like check_repo, then adds the user's connected cloud and git accounts, any project they already have for it, and the next steps, with links. Changes nothing. Needs an API key.

{
  "type": "object",
  "properties": {
    "repo": {
      "type": "string",
      "description": "owner/name, or the repository's URL"
    },
    "cloud": {
      "type": "string",
      "enum": [
        "digitalocean",
        "aws",
        "gcp",
        "azure"
      ],
      "description": "The cloud to plan for. Optional."
    }
  },
  "required": [
    "repo"
  ]
}

Lists the user's projects on The Deployer, or one project: whether each is live, its live addresses, and its latest deployment and where that is. Changes nothing. Needs an API key.

{
  "type": "object",
  "properties": {
    "project": {
      "type": "string",
      "description": "A project's id, name or repository. Leave out to list them all."
    }
  }
}

Shows the log of a project's latest deployment, or of a given deployment, newest lines last, with secrets removed. Set errors_only to see only errors and warnings. The lines are the build's and the app's own output. Changes nothing. Needs an API key.

{
  "type": "object",
  "properties": {
    "project": {
      "type": "string",
      "description": "The project's id, name or repository. Optional with one project."
    },
    "deployment_id": {
      "type": "integer",
      "description": "A specific deployment, instead of the latest"
    },
    "lines": {
      "type": "integer",
      "minimum": 1,
      "maximum": 400,
      "description": "How many lines, newest last. Default 80."
    },
    "errors_only": {
      "type": "boolean",
      "description": "Only errors and warnings"
    }
  }
}

Puts the latest code on a live project's branch online: pulls it and restarts the app, like Pull & Restart in The Deployer. It changes a live app, so confirm with the user first. Only for a project that's already live; a project's first deployment starts in the app. Takes a few minutes; follow it with status or logs. Needs an API key.

{
  "type": "object",
  "properties": {
    "project": {
      "type": "string",
      "description": "The live project's id, name or repository. Optional with one project."
    }
  }
}

Asks The Deployer's team to do it for the user: launch (put an app online in the user's own cloud account), launch_secure (the same, with exposed keys and other security problems fixed first) or move (move an app from another host, such as Heroku, into it). Tells the team, and returns the price, the delivery promise and the link where the user finishes the order and pays. Never charges anything. Needs an API key.

{
  "type": "object",
  "properties": {
    "offer": {
      "type": "string",
      "enum": [
        "launch",
        "launch_secure",
        "move"
      ]
    },
    "repo": {
      "type": "string",
      "description": "The repository, if there is one"
    },
    "note": {
      "type": "string",
      "description": "Anything the team should know, such as the current host or a deadline"
    }
  },
  "required": [
    "offer"
  ]
}