Deployment Status

The status of a deployment.

APIs.ioEngineeringPlatform

Properties

Name	Type	Description
url	string
id	integer
node_id	string
state	string	The state of the status.
creator	object
description	string	A short description of the status.
environment	string	The environment of the deployment that the status is for.
target_url	string	Deprecated: the URL to associate with this status.
created_at	string
updated_at	string
deployment_url	string
repository_url	string
environment_url	string	The URL for accessing your environment.
log_url	string	The URL to associate with this status.
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-status",
  "title": "Deployment Status",
  "description": "The status of a deployment.",
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "format": "uri",
      "example": "https://api.github.com/repos/octocat/example/deployments/42/statuses/1"
    },
    "id": {
      "type": "integer",
      "format": "int64",
      "example": 1
    },
    "node_id": {
      "type": "string",
      "example": "MDE2OkRlcGxveW1lbnRTdGF0dXMx"
    },
    "state": {
      "description": "The state of the status.",
      "enum": [
        "error",
        "failure",
        "inactive",
        "pending",
        "success",
        "queued",
        "in_progress"
      ],
      "example": "success",
      "type": "string"
    },
    "creator": {
      "$ref": "#/components/schemas/nullable-simple-user"
    },
    "description": {
      "description": "A short description of the status.",
      "default": "",
      "type": "string",
      "maxLength": 140,
      "example": "Deployment finished successfully."
    },
    "environment": {
      "description": "The environment of the deployment that the status is for.",
      "default": "",
      "type": "string",
      "example": "production"
    },
    "target_url": {
      "description": "Deprecated: the URL to associate with this status.",
      "default": "",
      "type": "string",
      "format": "uri",
      "example": "https://example.com/deployment/42/output"
    },
    "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"
    },
    "deployment_url": {
      "type": "string",
      "format": "uri",
      "example": "https://api.github.com/repos/octocat/example/deployments/42"
    },
    "repository_url": {
      "type": "string",
      "format": "uri",
      "example": "https://api.github.com/repos/octocat/example"
    },
    "environment_url": {
      "description": "The URL for accessing your environment.",
      "default": "",
      "type": "string",
      "format": "uri",
      "example": "https://staging.example.com/"
    },
    "log_url": {
      "description": "The URL to associate with this status.",
      "default": "",
      "type": "string",
      "format": "uri",
      "example": "https://example.com/deployment/42/output"
    },
    "performed_via_github_app": {
      "$ref": "#/components/schemas/nullable-integration"
    }
  },
  "required": [
    "id",
    "node_id",
    "state",
    "creator",
    "description",
    "deployment_url",
    "target_url",
    "repository_url",
    "url",
    "created_at",
    "updated_at"
  ]
}