# deployment

From **GitHub v3 REST API**.

A request for a specific ref(branch,sha,tag) to be deployed

- Type: `object`

## Properties

### `created_at`

- Required: true
- Type: `string`
- Format: `date-time`
- Example: `2012-07-20T01:19:13Z`

### `creator`

- Required: true
- Type: `object`
- Nullable: true

Simple User

### `description`

- Required: true
- Type: `string`
- Nullable: true
- Example: `Deploy request from hubot`

### `environment`

- Required: true
- Type: `string`
- Example: `production`

Name for the target deployment environment.

### `id`

- Required: true
- Type: `integer`
- Example: `42`

Unique identifier of the deployment

### `node_id`

- Required: true
- Type: `string`
- Example: `MDEwOkRlcGxveW1lbnQx`

### `original_environment`

- Required: false
- Type: `string`
- Example: `staging`

### `payload`

- Required: true
### `performed_via_github_app`

- Required: false
- Type: `object`
- Nullable: true

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

### `production_environment`

- Required: false
- Type: `boolean`
- Example: `true`

Specifies if the given environment is one that end-users directly interact with. Default: false.

### `ref`

- Required: true
- Type: `string`
- Example: `topic-branch`

The ref to deploy. This can be a branch, tag, or sha.

### `repository_url`

- Required: true
- Type: `string`
- Format: `uri`
- Example: `https://api.github.com/repos/octocat/example`

### `sha`

- Required: true
- Type: `string`
- Example: `a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d`

### `statuses_url`

- Required: true
- Type: `string`
- Format: `uri`
- Example: `https://api.github.com/repos/octocat/example/deployments/1/statuses`

### `task`

- Required: true
- Type: `string`
- Example: `deploy`

Parameter to specify a task to execute

### `transient_environment`

- Required: false
- Type: `boolean`
- Example: `true`

Specifies if the given environment is will no longer exist at some point in the future. Default: false.

### `updated_at`

- Required: true
- Type: `string`
- Format: `date-time`
- Example: `2012-07-20T01:19:13Z`

### `url`

- Required: true
- Type: `string`
- Format: `uri`
- Example: `https://api.github.com/repos/octocat/example/deployments/1`

## JSON Schema

```json
{"description":"A request for a specific ref(branch,sha,tag) to be deployed","properties":{"created_at":{"example":"2012-07-20T01:19:13Z","format":"date-time","type":"string"},"creator":{"$ref":"#/components/schemas/nullable-simple-user"},"description":{"example":"Deploy request from hubot","nullable":true,"type":"string"},"environment":{"description":"Name for the target deployment environment.","example":"production","type":"string"},"id":{"description":"Unique identifier of the deployment","example":42,"type":"integer"},"node_id":{"example":"MDEwOkRlcGxveW1lbnQx","type":"string"},"original_environment":{"example":"staging","type":"string"},"payload":{"oneOf":[{"additionalProperties":true,"type":"object"},{"type":"string"}]},"performed_via_github_app":{"$ref":"#/components/schemas/nullable-integration"},"production_environment":{"description":"Specifies if the given environment is one that end-users directly interact with. Default: false.","example":true,"type":"boolean"},"ref":{"description":"The ref to deploy. This can be a branch, tag, or sha.","example":"topic-branch","type":"string"},"repository_url":{"example":"https://api.github.com/repos/octocat/example","format":"uri","type":"string"},"sha":{"example":"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d","type":"string"},"statuses_url":{"example":"https://api.github.com/repos/octocat/example/deployments/1/statuses","format":"uri","type":"string"},"task":{"description":"Parameter to specify a task to execute","example":"deploy","type":"string"},"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"},"updated_at":{"example":"2012-07-20T01:19:13Z","format":"date-time","type":"string"},"url":{"example":"https://api.github.com/repos/octocat/example/deployments/1","format":"uri","type":"string"}},"required":["id","node_id","sha","ref","task","environment","creator","payload","description","statuses_url","repository_url","url","created_at","updated_at"],"title":"Deployment","type":"object"}
```