> ## 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 cloud servers

> Every CLOUD service you own or that's shared with you through a team, newest first. Power state comes from the poller
(`powerState`, `powerCheckedAt`) — the list never calls Proxmox. Without `limit` every server is returned and there's no
`nextCursor`; with it, results are cursor-paged.



## OpenAPI

````yaml /api-reference/openapi.yaml get /v1/cloud
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/cloud:
    get:
      tags:
        - Cloud
      summary: List your cloud servers
      description: >-
        Every CLOUD service you own or that's shared with you through a team,
        newest first. Power state comes from the poller

        (`powerState`, `powerCheckedAt`) — the list never calls Proxmox. Without
        `limit` every server is returned and there's no

        `nextCursor`; with it, results are cursor-paged.
      operationId: publicCloudListServers
      parameters:
        - name: tag
          in: query
          required: false
          description: Only servers carrying this tag name.
          schema:
            type: string
        - name: limit
          in: query
          required: false
          description: Page size. Omit for the full, unpaged list.
          schema:
            type: integer
            minimum: 1
            maximum: 200
        - name: cursor
          in: query
          required: false
          description: The `nextCursor` from the previous page.
          schema:
            type: string
            pattern: ^[A-Za-z0-9_-]{1,64}$
      responses:
        '200':
          description: Your cloud servers.
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - data
                properties:
                  success:
                    type: boolean
                    const: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PublicCloudServiceRow'
                  nextCursor:
                    type:
                      - string
                      - 'null'
                    description: >-
                      Present only when `limit` was given. 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:
    PublicCloudServiceRow:
      type: object
      description: >-
        A Service row as stored, plus its product, tag names and current
        addresses.
      required:
        - id
        - userId
        - teamId
        - productId
        - type
        - status
        - label
        - externalId
        - metadata
        - price
        - currency
        - billingCycle
        - nextDueDate
        - dunningProtection
        - suspendReason
        - createdAt
        - powerState
        - powerCheckedAt
        - product
        - tags
        - ipAddress
        - ipv6Address
      properties:
        id:
          type: string
          format: uuid
        userId:
          type: string
          format: uuid
          description: The owner.
        teamId:
          type:
            - string
            - 'null'
        productId:
          type:
            - string
            - 'null'
        type:
          type: string
          const: CLOUD
        status:
          type: string
          enum:
            - ACTIVE
            - SUSPENDED
            - TERMINATED
            - CANCELLED
            - PENDING
        label:
          type: string
        externalId:
          type:
            - string
            - 'null'
        metadata:
          type: object
          additionalProperties: true
          description: >-
            Free-form service metadata (e.g. `planId`, `os`). `ipAddress` and
            `ipv6Address` are always filled from the VM.
          properties:
            ipAddress:
              type:
                - string
                - 'null'
            ipv6Address:
              type:
                - string
                - 'null'
        price:
          type:
            - integer
            - 'null'
          description: Renewal price per cycle, minor units.
        currency:
          type:
            - string
            - 'null'
        billingCycle:
          type:
            - string
            - 'null'
        nextDueDate:
          type:
            - string
            - 'null'
          format: date-time
        dunningProtection:
          type: string
        suspendReason:
          type:
            - string
            - 'null'
        createdAt:
          type: string
          format: date-time
        powerState:
          type:
            - string
            - 'null'
          enum:
            - 'on'
            - 'off'
            - unknown
            - null
          description: Last poller reading.
        powerCheckedAt:
          type:
            - string
            - 'null'
          format: date-time
        product:
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/PublicCloudProduct'
        tags:
          type: array
          items:
            type: string
        ipAddress:
          type:
            - string
            - 'null'
        ipv6Address:
          type:
            - string
            - 'null'
    PublicCloudProduct:
      type: object
      required:
        - id
        - name
        - description
        - type
        - price
        - currency
        - billingCycle
        - taxable
        - active
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        description:
          type:
            - string
            - 'null'
        type:
          type: string
        price:
          type: integer
          description: Minor units.
        currency:
          type: string
        billingCycle:
          type: string
        taxable:
          type: boolean
        active:
          type: boolean
    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.