# deployment-status

From **GitHub v3 REST API**.

The status of a deployment.

- 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

### `deployment_url`

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

### `description`

- Required: true
- Type: `string`
- Example: `Deployment finished successfully.`
- maxLength: `140`

A short description of the status.

### `environment`

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

The environment of the deployment that the status is for.

### `environment_url`

- Required: false
- Type: `string`
- Format: `uri`
- Example: `https://staging.example.com/`

The URL for accessing your environment.

### `id`

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

### `log_url`

- Required: false
- Type: `string`
- Format: `uri`
- Example: `https://example.com/deployment/42/output`

The URL to associate with this status.

### `node_id`

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

### `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.

### `repository_url`

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

### `state`

- Required: true
- Type: `string`
- Example: `success`
- Allowed values: `"error"`, `"failure"`, `"inactive"`, `"pending"`, `"success"`, `"queued"`, `"in_progress"`

The state of the status.

### `target_url`

- Required: true
- Type: `string`
- Format: `uri`
- Example: `https://example.com/deployment/42/output`

Deprecated: the URL to associate with this status.

### `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/42/statuses/1`

## JSON Schema

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