# Get image

Gets a build or imported image version

Required permission: Project > Images > General > Read

**Path parameters:**

{object}
- `projectId`: (string) (required) ID of the project
- `imageId`: (string) (required) Object ID of the image version

**Response body:**

{object}
- `data`: {object}
  - `id`: (string) (required) (min length: 24) (max length: 24)
  - `name`: (string) (required)
  - `tag`: (string) (required)
  - `source`: (multiple options) {object}
     - `type`: (string) (required) (enum: build)
     - `buildId`: (string) (required) (min length: 24) (max length: 24)
     - `nfObjectId`: (string) (required) (min length: 24) (max length: 24)
     - `nfObjectType`: (string) (required) (enum: service, job)
     - `branch`: (string) (required) | {object}
     - `type`: (string) (required) (enum: imported)
     - `from`: (string) (required) (enum: ui, external, registry)
  - `group`: (multiple options) (string)
  - `ready`: (boolean) (required)
  - `status`: (string) (required) (enum: AWAITING_UPLOAD, IMPORTING, VALIDATING, READY, FAILURE, EXPIRED)
  - `createdAt`: (string) (required) (format: date-time)
  - `publishedAt`: (string) (format: date-time)
  - `digest`: (string) (pattern: ^sha256:[a-f0-9]{64}$)
  - `supportedArchitectures`: [array of] (string) (enum: linux/amd64, linux/arm64)
  - `imageSizeBytes`: (integer)
  - `validationError`: (string)
  - `reservationExpiresAt`: (string) (format: date-time)
  - `git`: {object}
    - `provider`: (string) (required)
    - `repo`: (string) (required)
    - `branch`: (string) (required)
    - `commit`: (string) (required)

## API reference

GET /v1/projects/{projectId}/images/{imageId}

GET /v1/teams/{teamId}/projects/{projectId}/images/{imageId}

### Example Response

200 OK: Details about the image version.

```json
undefined
```

## CLI reference

$ northflank get image

Options:

- `--projectId <projectId>`: ID of the project

- `--imageId <imageId>`: Object ID of the image version

- `--verbose `: Verbose output

- `--quiet `: No console output

- `-o --output <format>`: Output formatting 

### Example Response

 Details about the image version.

```json
undefined
```

## JavaScript client reference

### Example request



With an organization token, add `parameters.teamId`. [Organization API access](/docs/v1/api/use-the-api#organization-api-access).

```javascript
await apiClient.get.image({
  parameters: {
    "projectId": "default-project",
    "imageId": "string"
  }
});
```

### Example Response

 Details about the image version.

```json
{
  "rawResponse": "...",
  "request": "...",
  "error": "..."
}
```

## Python client reference

### Example request

[Set up the Python client](/docs/v1/api/use-the-python-client#usage).



With an organization token, add `team_id`. [Organization API access](/docs/v1/api/use-the-api#organization-api-access).

Python SDK 2.1.0 has no generated method for this endpoint. Use the API example for this request.

Previous: [Prepare image upload](/docs/v1/api/project/images/prepare-image-upload)

Next: [Initialize project](/docs/v1/api/project/projects/initialize-project)