> ## Documentation Index
> Fetch the complete documentation index at: https://docs.arct.cloud/llms.txt
> Use this file to discover all available pages before exploring further.

# List OS Images

> Returns OS images per location. Filter with `location`.



## OpenAPI

````yaml /api-reference/openapi.json get /images
openapi: 3.1.0
info:
  title: Arct Cloud API
  description: >-
    Manage Arct Cloud servers over HTTPS with an API token. Errors return an
    `error` object with `code`, `message` and `details`.
  version: 1.0.0
servers:
  - url: https://api.arct.cloud/v1
security: []
tags:
  - name: Account
    description: The account and token behind the request.
  - name: Servers
    description: List, read, create, update, power, reinstall, resize and delete servers.
  - name: Catalog
    description: Locations, plans and OS images you can order.
  - name: Invoices
    description: Your invoices.
  - name: SSH Keys
    description: Keys to install on new and reinstalled servers.
paths:
  /images:
    get:
      tags:
        - Catalog
      summary: List OS Images
      description: Returns OS images per location. Filter with `location`.
      operationId: list_images_images_get
      parameters:
        - name: location
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                pattern: ^[A-Za-z0-9-]{1,10}$
              - type: 'null'
            description: Filter by location code, such as `fra`.
            title: Location
          description: Filter by location code, such as `fra`.
        - name: page
          in: query
          required: false
          schema:
            type: integer
            maximum: 100000
            minimum: 1
            description: Page number.
            default: 1
            title: Page
          description: Page number.
        - name: per_page
          in: query
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
            description: Items per page.
            default: 20
            title: Per Page
          description: Items per page.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Page_Image_'
        '401':
          description: '`invalid_token`, `token_disabled` or `token_expired`.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: '`account_disabled` or `api_access_disabled`.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: '`not_found`: unknown `location`.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: '`validation_error`; see `details.fields`.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: '`rate_limit_exceeded`; see `Retry-After`.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: '`internal_error`.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - bearerAuth: []
components:
  schemas:
    Page_Image_:
      properties:
        data:
          items:
            $ref: '#/components/schemas/Image'
          type: array
          title: Data
        pagination:
          $ref: '#/components/schemas/Pagination'
      type: object
      required:
        - data
        - pagination
      title: Page[Image]
    ErrorResponse:
      properties:
        error:
          $ref: '#/components/schemas/ErrorDetail'
      type: object
      required:
        - error
      title: ErrorResponse
    Image:
      properties:
        id:
          type: string
          format: uuid
          title: Id
          description: Image ID. IDs differ per location.
        name:
          type: string
          title: Name
        version:
          type: string
          title: Version
        display_name:
          type: string
          title: Display Name
        location:
          type: string
          title: Location
        allowed_plans:
          items:
            type: string
          type: array
          title: Allowed Plans
          description: Plan slugs allowed; empty means every plan.
      type: object
      required:
        - id
        - name
        - version
        - display_name
        - location
        - allowed_plans
      title: Image
    Pagination:
      properties:
        page:
          type: integer
          title: Page
        per_page:
          type: integer
          title: Per Page
        total:
          type: integer
          title: Total
        total_pages:
          type: integer
          title: Total Pages
      type: object
      required:
        - page
        - per_page
        - total
        - total_pages
      title: Pagination
    ErrorDetail:
      properties:
        code:
          type: string
          title: Code
        message:
          type: string
          title: Message
        details:
          anyOf:
            - type: object
            - type: 'null'
          title: Details
      type: object
      required:
        - code
        - message
      title: ErrorDetail
  securitySchemes:
    bearerAuth:
      type: http
      description: API token from Dashboard > Settings > API Tokens.
      scheme: bearer
      bearerFormat: arct_...

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.