> ## 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 OS install profiles for a machine or plan

> Installable TenantOS profiles (rescue, password-reset and disk-wipe profiles removed). Ask by `serverId` for a stock machine,
or by `planSlug` for a plan, which answers from the next available unit. A plan with no TenantOS-backed unit free is built
to order and returns an empty list.



## OpenAPI

````yaml /api-reference/openapi.yaml get /v1/client/dedicated/profiles
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/client/dedicated/profiles:
    get:
      tags:
        - Dedicated
      summary: List OS install profiles for a machine or plan
      description: >-
        Installable TenantOS profiles (rescue, password-reset and disk-wipe
        profiles removed). Ask by `serverId` for a stock machine,

        or by `planSlug` for a plan, which answers from the next available unit.
        A plan with no TenantOS-backed unit free is built

        to order and returns an empty list.
      operationId: publicClientListDedicatedProfiles
      parameters:
        - name: serverId
          in: query
          required: false
          description: TenantOS server id. Required unless `planSlug` is given.
          schema:
            type: string
        - name: planSlug
          in: query
          required: false
          description: >-
            Dedicated plan slug, case-insensitive. Ignored when `serverId` is
            given.
          schema:
            type: string
      responses:
        '200':
          description: Profiles.
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - data
                properties:
                  success:
                    type: boolean
                    const: true
                  data:
                    type: array
                    items:
                      type: object
                      required:
                        - id
                        - name
                        - groupname
                        - logoUrl
                      properties:
                        id:
                          type: integer
                        name:
                          type: string
                        groupname:
                          type: string
                          description: OS family, e.g. Ubuntu.
                        logoUrl:
                          type:
                            - string
                            - 'null'
                          format: uri
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/ServerError'
      security:
        - bearerAuth: []
components:
  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'
  schemas:
    ErrorResponse:
      type: object
      required:
        - success
        - error
      properties:
        success:
          type: boolean
          const: false
        error:
          type: string
          description: Human-readable error message.
      additionalProperties: true
  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.