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

# Get a server's overview tab

> Hardware, disks, port speed and IPs from the cached TenantOS answer (refreshed if older than 30 seconds; the last
known answer when TenantOS is down). `uptime`, `ram.used`, `network.inbound/outbound` and every `rdns` are always
"—", and `recentEvents` is always empty. Readable by the owner and any team member.



## OpenAPI

````yaml /api-reference/openapi.yaml get /v1/dedicated/{id}/overview
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/dedicated/{id}/overview:
    parameters:
      - name: id
        in: path
        required: true
        description: The dedicated server's service id.
        schema:
          type: string
          format: uuid
    get:
      tags:
        - Dedicated
      summary: Get a server's overview tab
      description: >-
        Hardware, disks, port speed and IPs from the cached TenantOS answer
        (refreshed if older than 30 seconds; the last

        known answer when TenantOS is down). `uptime`, `ram.used`,
        `network.inbound/outbound` and every `rdns` are always

        "—", and `recentEvents` is always empty. Readable by the owner and any
        team member.
      operationId: publicDedicatedGetOverview
      responses:
        '200':
          description: The overview.
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - data
                properties:
                  success:
                    type: boolean
                    const: true
                  data:
                    $ref: '#/components/schemas/PublicDedicatedOverview'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/ServerError'
      security:
        - bearerAuth: []
        - apiToken: []
components:
  schemas:
    PublicDedicatedOverview:
      type: object
      required:
        - id
        - hostname
        - status
        - uptime
        - cpu
        - ram
        - storage
        - network
        - ipAddresses
        - recentEvents
      properties:
        id:
          type: string
          format: uuid
        hostname:
          type: string
        status:
          $ref: '#/components/schemas/PublicDedicatedPowerState'
        uptime:
          type: string
          const: —
        cpu:
          type: object
          required:
            - model
            - cores
            - threads
          properties:
            model:
              type: string
            cores:
              type: integer
            threads:
              type: integer
        ram:
          type: object
          required:
            - total
            - used
          properties:
            total:
              type: string
              example: 64 GB
            used:
              type: string
              const: —
        storage:
          type: array
          items:
            type: object
            required:
              - device
              - size
              - type
            properties:
              device:
                type: string
                example: disk1
              size:
                type: string
                example: 960 GB
              type:
                type: string
                description: Disk model, or "SSD" when TenantOS has no per-disk detail.
        network:
          type: object
          required:
            - speed
            - inbound
            - outbound
          properties:
            speed:
              type: string
            inbound:
              type: string
              const: —
            outbound:
              type: string
              const: —
        ipAddresses:
          type: array
          items:
            type: object
            required:
              - address
              - type
              - rdns
            properties:
              address:
                type: string
              type:
                type: string
                enum:
                  - IPv4
                  - IPv6
              rdns:
                type: string
                const: —
        recentEvents:
          type: array
          maxItems: 0
          items: {}
    PublicDedicatedPowerState:
      type: string
      enum:
        - 'on'
        - 'off'
        - unknown
    ErrorResponse:
      type: object
      required:
        - success
        - error
      properties:
        success:
          type: boolean
          const: false
        error:
          type: string
          description: Human-readable error message.
      additionalProperties: true
  responses:
    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'
    NotFound:
      description: The resource doesn't exist or isn't visible to you.
      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.