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

# List your servers

> Every cloud and dedicated server the caller can see — their own and their teams' — in one cursor-paged list, newest first
(createdAt then id, descending). Database only: `power` is the poller's last reading, never a live call.
`q` matches the label, hostname, primary IPv4 (prefix), service id (prefix), the TenantOS id (exact) and tag names.



## OpenAPI

````yaml /api-reference/openapi.yaml get /v1/services
openapi: 3.1.0
info:
  title: Server.Express API
  version: 1.0.0
  description: >-
    The customer-facing Server.Express API: auth, billing, tickets, cloud and
    dedicated servers, hosting, reselling and account management. Every response
    uses the `{ success, data | error }` envelope.
  contact:
    name: Server.Express
    url: https://server.express
servers:
  - url: https://my.server.express/api
    description: Production
security:
  - bearerAuth: []
  - apiToken: []
tags:
  - name: API Tokens
  - name: Account
  - name: Auth
  - name: Cloud
  - name: Coupons
  - name: Credits
  - name: Dashboard
  - name: Dedicated
  - name: Health
  - name: Hosting
  - name: Integrations
  - name: Invoices
  - name: Livechat
  - name: Notifications
  - name: Passkeys
  - name: Payments
  - name: Products
  - name: Public
  - name: Public Invoices
  - name: Public Tools
  - name: Reseller
  - name: SSH Keys
  - name: Services
  - name: Tasks
  - name: Teams
  - name: Tickets
  - name: Web Hosting
  - name: Webhooks
paths:
  /v1/services:
    get:
      tags:
        - Services
      summary: List your servers
      description: >-
        Every cloud and dedicated server the caller can see — their own and
        their teams' — in one cursor-paged list, newest first

        (createdAt then id, descending). Database only: `power` is the poller's
        last reading, never a live call.

        `q` matches the label, hostname, primary IPv4 (prefix), service id
        (prefix), the TenantOS id (exact) and tag names.
      operationId: publicUserListServices
      parameters:
        - name: type
          in: query
          required: false
          description: >-
            cloud covers CLOUD and VPS services; dedicated covers DEDICATED.
            Omit for both.
          schema:
            type: string
            enum:
              - cloud
              - dedicated
        - name: status
          in: query
          required: false
          schema:
            type: string
            enum:
              - active
              - pending
              - suspended
              - cancelled
              - terminated
        - name: tag
          in: query
          required: false
          description: Exact tag name (lowercased before matching).
          schema:
            type: string
        - name: q
          in: query
          required: false
          description: Free-text search; trimmed and cut to 100 characters.
          schema:
            type: string
            maxLength: 100
        - name: cursor
          in: query
          required: false
          description: Opaque cursor from a previous page's `nextCursor`.
          schema:
            type: string
            pattern: ^[A-Za-z0-9_-]{1,64}$
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 200
            default: 50
      responses:
        '200':
          description: One page of servers.
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - data
                properties:
                  success:
                    type: boolean
                    const: true
                  data:
                    type: object
                    required:
                      - items
                      - nextCursor
                    properties:
                      items:
                        type: array
                        items:
                          $ref: '#/components/schemas/PublicUserServiceRow'
                      nextCursor:
                        type:
                          - string
                          - 'null'
                        description: >-
                          Pass as `cursor` for the next page; null on the last
                          page.
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/ServerError'
      security:
        - bearerAuth: []
        - apiToken: []
components:
  schemas:
    PublicUserServiceRow:
      type: object
      description: One server as a list row — a light cut of the full Machine shape.
      required:
        - id
        - type
        - kind
        - flavour
        - label
        - hostname
        - status
        - power
        - ipv4
        - location
        - tags
        - renewal
        - os
        - spec
      properties:
        id:
          type: string
        type:
          type: string
          enum:
            - DEDICATED
            - CLOUD
            - VPS
        kind:
          type: string
          enum:
            - vm
            - metal
        flavour:
          type: string
          enum:
            - linux
            - windows
        label:
          type: string
        hostname:
          type: string
          description: Falls back to the label.
        status:
          type: string
          enum:
            - pending
            - active
            - suspended
            - cancelled
            - terminated
        power:
          type: object
          required:
            - state
            - at
          properties:
            state:
              type: string
              enum:
                - 'on'
                - 'off'
                - unknown
            at:
              type:
                - string
                - 'null'
              format: date-time
              description: When the poller last checked.
        ipv4:
          type:
            - string
            - 'null'
        location:
          type:
            - string
            - 'null'
          description: Location slug (cloud) or datacenter (dedicated).
        tags:
          type: array
          items:
            type: string
        renewal:
          type: object
          required:
            - nextDueDate
            - cycle
            - amountMinor
            - currency
          properties:
            nextDueDate:
              type:
                - string
                - 'null'
              format: date-time
            cycle:
              type:
                - string
                - 'null'
            amountMinor:
              type:
                - integer
                - 'null'
              description: Renewal price in minor units.
            currency:
              type: string
              description: Defaults to GBP.
        os:
          type:
            - object
            - 'null'
          required:
            - name
            - family
          properties:
            name:
              type: string
            family:
              type: string
              description: e.g. "windows", "debian", "ubuntu".
        spec:
          type:
            - object
            - 'null'
          description: Null when we know nothing about the hardware yet.
          required:
            - cpu
            - cores
            - ramMb
            - diskGb
          properties:
            cpu:
              type: string
              description: '"vCPU" for a VM; the CPU model for metal.'
            cores:
              type: integer
            ramMb:
              type: integer
            diskGb:
              type: number
              description: All disks added up.
    ErrorResponse:
      type: object
      required:
        - success
        - error
      properties:
        success:
          type: boolean
          const: false
        error:
          type: string
          description: Human-readable error message.
      additionalProperties: true
  responses:
    BadRequest:
      description: Validation failed or the request is malformed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Missing, invalid or expired credentials.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Forbidden:
      description: >-
        Authenticated but not allowed (missing scope, not an admin, or not your
        resource).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    ServerError:
      description: Unexpected server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Session access token (JWT) from POST /v1/auth/login or /v1/auth/refresh.
        A session satisfies every API scope.
    apiToken:
      type: http
      scheme: bearer
      bearerFormat: se_live_<prefix>_<secret>
      description: >-
        Personal API token created under Settings → API tokens. Only routes
        guarded by verifyApiAuth accept it, and the token must carry the scope
        named in the operation's x-required-scope.

````

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