Deployment

A deployment created as the result of an Actions check run from a workflow that references an environment

APIs.ioEngineeringPlatform

Properties

Name	Type	Description
url	string
id	integer	Unique identifier of the deployment
node_id	string
task	string	Parameter to specify a task to execute
original_environment	string
environment	string	Name for the target deployment environment.
description	string
created_at	string
updated_at	string
statuses_url	string
repository_url	string
transient_environment	boolean	Specifies if the given environment is will no longer exist at some point in the future. Default: false.
production_environment	boolean	Specifies if the given environment is one that end-users directly interact with. Default: false.
performed_via_github_app	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/deployment-simple",
  "title": "Deployment",
  "description": "A deployment created as the result of an Actions check run from a workflow that references an environment",
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "format": "uri",
      "example": "https://api.github.com/repos/octocat/example/deployments/1"
    },
    "id": {
      "description": "Unique identifier of the deployment",
      "example": 42,
      "type": "integer"
    },
    "node_id": {
      "type": "string",
      "example": "MDEwOkRlcGxveW1lbnQx"
    },
    "task": {
      "description": "Parameter to specify a task to execute",
      "example": "deploy",
      "type": "string"
    },
    "original_environment": {
      "type": "string",
      "example": "staging"
    },
    "environment": {
      "description": "Name for the target deployment environment.",
      "example": "production",
      "type": "string"
    },
    "description": {
      "type": "string",
      "example": "Deploy request from hubot",
      "nullable": true
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "example": "2012-07-20T01:19:13Z"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "example": "2012-07-20T01:19:13Z"
    },
    "statuses_url": {
      "type": "string",
      "format": "uri",
      "example": "https://api.github.com/repos/octocat/example/deployments/1/statuses"
    },
    "repository_url": {
      "type": "string",
      "format": "uri",
      "example": "https://api.github.com/repos/octocat/example"
    },
    "transient_environment": {
      "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.",
      "example": true,
      "type": "boolean"
    },
    "production_environment": {
      "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.",
      "example": true,
      "type": "boolean"
    },
    "performed_via_github_app": {
      "$ref": "#/components/schemas/nullable-integration"
    }
  },
  "required": [
    "id",
    "node_id",
    "task",
    "environment",
    "description",
    "statuses_url",
    "repository_url",
    "url",
    "created_at",
    "updated_at"
  ]
}