# Deployment History

## Get Deployment by ID

**get** `/deployment-history/{deployment_id}`

Get a deployment record by its unique ID.

### Path Parameters

- `deployment_id: string`

### Returns

- `DeploymentHistory object { id, agent_id, author_email, 5 more }`

  API schema for deployment history.

  - `id: string`

    The unique identifier of the deployment record

  - `agent_id: string`

    The ID of the agent this deployment belongs to

  - `author_email: string`

    Email of the commit author

  - `author_name: string`

    Name of the commit author

  - `branch_name: string`

    Name of the branch

  - `build_timestamp: string`

    When the build was created

  - `commit_hash: string`

    Git commit hash for this deployment

  - `deployment_timestamp: string`

    When this deployment was first seen in the system

### Example

```http
curl http://localhost:5003/deployment-history/$DEPLOYMENT_ID \
    -H "Authorization: Bearer $AGENTEX_SDK_API_KEY"
```

#### Response

```json
{
  "id": "id",
  "agent_id": "agent_id",
  "author_email": "author_email",
  "author_name": "author_name",
  "branch_name": "branch_name",
  "build_timestamp": "2019-12-27T18:11:19.117Z",
  "commit_hash": "commit_hash",
  "deployment_timestamp": "2019-12-27T18:11:19.117Z"
}
```

## List Deployments for an agent

**get** `/deployment-history`

List deployment history for an agent.

### Query Parameters

- `agent_id: optional string`

- `agent_name: optional string`

- `limit: optional number`

- `order_by: optional string`

- `order_direction: optional string`

- `page_number: optional number`

### Returns

- `id: string`

  The unique identifier of the deployment record

- `agent_id: string`

  The ID of the agent this deployment belongs to

- `author_email: string`

  Email of the commit author

- `author_name: string`

  Name of the commit author

- `branch_name: string`

  Name of the branch

- `build_timestamp: string`

  When the build was created

- `commit_hash: string`

  Git commit hash for this deployment

- `deployment_timestamp: string`

  When this deployment was first seen in the system

### Example

```http
curl http://localhost:5003/deployment-history \
    -H "Authorization: Bearer $AGENTEX_SDK_API_KEY"
```

#### Response

```json
[
  {
    "id": "id",
    "agent_id": "agent_id",
    "author_email": "author_email",
    "author_name": "author_name",
    "branch_name": "branch_name",
    "build_timestamp": "2019-12-27T18:11:19.117Z",
    "commit_hash": "commit_hash",
    "deployment_timestamp": "2019-12-27T18:11:19.117Z"
  }
]
```

## Domain Types

### Deployment History

- `DeploymentHistory object { id, agent_id, author_email, 5 more }`

  API schema for deployment history.

  - `id: string`

    The unique identifier of the deployment record

  - `agent_id: string`

    The ID of the agent this deployment belongs to

  - `author_email: string`

    Email of the commit author

  - `author_name: string`

    Name of the commit author

  - `branch_name: string`

    Name of the branch

  - `build_timestamp: string`

    When the build was created

  - `commit_hash: string`

    Git commit hash for this deployment

  - `deployment_timestamp: string`

    When this deployment was first seen in the system

### Deployment History List Response

- `DeploymentHistoryListResponse = array of DeploymentHistory`

  - `id: string`

    The unique identifier of the deployment record

  - `agent_id: string`

    The ID of the agent this deployment belongs to

  - `author_email: string`

    Email of the commit author

  - `author_name: string`

    Name of the commit author

  - `branch_name: string`

    Name of the branch

  - `build_timestamp: string`

    When the build was created

  - `commit_hash: string`

    Git commit hash for this deployment

  - `deployment_timestamp: string`

    When this deployment was first seen in the system