> ## 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 Servers

> Returns your servers, newest first.



## OpenAPI

````yaml /api-reference/openapi.json get /servers
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:
  /servers:
    get:
      tags:
        - Servers
      summary: List Servers
      description: Returns your servers, newest first.
      operationId: list_servers_servers_get
      parameters:
        - name: status
          in: query
          required: false
          schema:
            anyOf:
              - enum:
                  - provisioning
                  - running
                  - stopped
                  - restarting
                  - reinstalling
                  - restoring
                  - deleting
                  - suspended
                  - pre_order
                type: string
              - type: 'null'
            description: Filter by status. `provisioning` also matches failed builds.
            title: Status
          description: Filter by status. `provisioning` also matches failed builds.
        - 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_Server_'
        '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'
        '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_Server_:
      properties:
        data:
          items:
            $ref: '#/components/schemas/Server'
          type: array
          title: Data
        pagination:
          $ref: '#/components/schemas/Pagination'
      type: object
      required:
        - data
        - pagination
      title: Page[Server]
    ErrorResponse:
      properties:
        error:
          $ref: '#/components/schemas/ErrorDetail'
      type: object
      required:
        - error
      title: ErrorResponse
    Server:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        hostname:
          type: string
          title: Hostname
        status:
          $ref: '#/components/schemas/VMStatus'
        location:
          type: string
          title: Location
          description: Location code, such as `fra`.
        plan:
          type: string
          title: Plan
          description: Plan slug.
        plan_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Plan Name
        cpu_cores:
          type: integer
          title: Cpu Cores
        ram_gb:
          type: integer
          title: Ram Gb
        storage_gb:
          type: integer
          title: Storage Gb
        bandwidth_tb:
          type: integer
          title: Bandwidth Tb
        ipv4:
          anyOf:
            - type: string
            - type: 'null'
          title: Ipv4
          description: Null until the server is set up.
        ipv6:
          anyOf:
            - type: string
            - type: 'null'
          title: Ipv6
          description: IPv6 address, or null if none is assigned.
        os:
          type: string
          title: Os
        login_user:
          anyOf:
            - type: string
            - type: 'null'
          title: Login User
          description: OS user to sign in as. Null in list responses.
        labels:
          items:
            type: string
          type: array
          title: Labels
        delete_protection:
          type: boolean
          title: Delete Protection
          description: True blocks `DELETE`.
        billing_period:
          type: string
          title: Billing Period
          description: '`monthly`, `quarterly`, `semi_annual` or `yearly`.'
        price:
          type: number
          title: Price
          description: Price per billing period, in USD.
        next_due_date:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          title: Next Due Date
          description: Next renewal date.
        cancel_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Cancel At
          description: Date a scheduled cancellation takes effect, or null if none.
        created_at:
          type: string
          format: date-time
          title: Created At
      type: object
      required:
        - id
        - hostname
        - status
        - location
        - plan
        - plan_name
        - cpu_cores
        - ram_gb
        - storage_gb
        - bandwidth_tb
        - ipv4
        - ipv6
        - os
        - login_user
        - labels
        - delete_protection
        - billing_period
        - price
        - next_due_date
        - cancel_at
        - created_at
      title: Server
    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
    VMStatus:
      type: string
      enum:
        - provisioning
        - running
        - stopped
        - restarting
        - reinstalling
        - restoring
        - error
        - deleting
        - suspended
        - pre_order
      title: VMStatus
      description: VM status enumeration.
  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.