Create a new deployment.

v1.0.0

Required permission: deployments_write

Input

{
  "type": "object",
  "required": [
    "version"
  ],
  "properties": {
    "created": {
      "type": "string",
      "format": "date-time",
      "description": "When was this deployment created in UTC. Defaults to current time if not specified."
    },
    "description": {
      "type": "string",
      "description": "Optional description of this deployment. Can be markdown or clear text."
    },
    "logId": {
      "type": "string",
      "description": "As default, deployments are attached all logs of the organization. If you want a deployment to\r\nattach to a single log only, set this to the ID of that log."
    },
    "userEmail": {
      "type": "string",
      "format": "email",
      "description": "The email of the person responsible for creating this deployment. This can be the email taken from\r\nyour deployment server (like Azure DevOps or Octopus)."
    },
    "userName": {
      "type": "string",
      "description": "The name of the person responsible for creating this deployment. This can be the name taken from\r\nyour deployment server (like Azure DevOps or Octopus)."
    },
    "version": {
      "type": "string",
      "description": "The version number of this deployment. The value of version can be a SemVer compliant string or any other\r\nsyntax that you are using as your version numbering scheme."
    }
  }
}

Output

{
  "type": "object",
  "properties": {
    "location": {
      "type": "string",
      "format": "uri",
      "description": "The location of the created deployment."
    }
  }
}