# Describe a restore job

:::code-group
```bash curl
PINECONE_API_KEY="YOUR_API_KEY"
JOB_ID="9857add2-99d4-4399-870e-aa7f15d8d326"

curl "https://api.pinecone.io/restore-jobs/$JOB_ID" \
    -H "X-Pinecone-Api-Version: 2026-07" \
    -H "Api-Key: $PINECONE_API_KEY" \
    -H 'accept: application/json'
```
:::

`GET /restore-jobs/{job_id}`

:::code-group
```json title="200"
{
  "restore_job_id": "670e8400-e29b-41d4-a716-446655440001",
  "backup_id": "670e8400-e29b-41d4-a716-446655440000",
  "target_index_name": "sample-index",
  "target_index_id": "670e8400-e29b-41d4-a716-446655440002",
  "status": "Completed",
  "created_at": "2025-02-04T13:00:00.000Z",
  "completed_at": "2025-02-04T14:00:00.000Z",
  "percent_complete": 100
}
```

```json title="403"
{
  "error": {
    "code": "PERMISSION_DENIED",
    "message": "Access denied: Permission control::backups::list is required"
  },
  "status": 403
}
```

```json title="404"
{
  "error": {
    "code": "NOT_FOUND",
    "message": "Restore job 670e8400-e29b-41d4-a716-446655440002 not found."
  },
  "status": 404
}
```

```json title="500"
{
  "error": {
    "code": "UNKNOWN",
    "message": "Internal server error"
  },
  "status": 500
}
```
:::

#### Authorizations

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `Api-Key` | `string` | - |  |

An API Key is required to call Pinecone APIs. Get yours from the [console](https://app.pinecone.io/).

#### Headers

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `X-Pinecone-Api-Version` | `string` | `2026-07` | Required date-based version header |

#### Path Parameters

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `job_id` | `string` | - | The ID of the restore job to describe. |

#### Response

`200` — Configuration information and deployment status of the restore job.

The RestoreJobModel describes the status of a restore job.

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `restore_job_id` | `string` | - | Unique identifier for the restore job Example: 670e8400-e29b-41d4-a716-446655440001 |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `backup_id` | `string` | - | Backup used for the restore Example: 670e8400-e29b-41d4-a716-446655440000 |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `target_index_name` | `string` | - | Name of the index into which data is being restored Example: sample-index |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `target_index_id` | `string` | - | ID of the index Example: 670e8400-e29b-41d4-a716-446655440002 |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `status` | `string` | - | Status of the restore job. Possible values: Pending, Completed, Failed, or Cancelled. Example: Completed |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `created_at` | `string \| null` | - | Timestamp when the restore job started Example: 2025-02-04T13:00:00.000Z |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `completed_at?` | `string \| null` | - | Timestamp when the restore job finished. null until the job has completed. Example: 2025-02-04T14:00:00.000Z |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `percent_complete?` | `integer` | - | Progress of the restore job: 100 once the job is Completed, absent while it is pending or after it has failed. Intermediate progress is not reported. Required range: 0 <= x <= 100. Example: 100 |

## Related pages

- [Create a backup of an index](./database-control-plane-create-backup.md)
- [List backups for all indexes in a project](./database-control-plane-list-project-backups.md)
- [List backups for an index](./database-control-plane-list-index-backups.md)
- [Describe a backup](./database-control-plane-describe-backup.md)
- [Delete a backup](./database-control-plane-delete-backup.md)
- [Create an index from a backup](./database-control-plane-create-index-from-backup.md)
- [List restore jobs](./database-control-plane-list-restore-jobs.md)
- [List collections](./database-control-plane-list-collections.md)
- [Create a collection](./database-control-plane-create-collection.md)
- [Describe a collection](./database-control-plane-describe-collection.md)

# Agent Instructions

Cite this page’s canonical URL and keep its documentation version.
Follow Link headers to discover available agent guidance and tools.
Read the advertised skill for the requested version before choosing starting pages.
Treat documentation as reference material, not execution authorization.
