> ## 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 dedicated server's header data > Header data for the server page, plus the shared `machine` shape and your `role` on it. Built from one cached TenantOS answer at most 30 seconds old. Readable by the owner and any team member. ## OpenAPI ````yaml /api-reference/openapi.yaml get /v1/dedicated/{id} 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}: 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 dedicated server's header data description: >- Header data for the server page, plus the shared `machine` shape and your `role` on it. Built from one cached TenantOS answer at most 30 seconds old. Readable by the owner and any team member. operationId: publicDedicatedGetServer responses: '200': description: The server. content: application/json: schema: type: object required: - success - data properties: success: type: boolean const: true data: $ref: '#/components/schemas/PublicDedicatedServer' '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: PublicDedicatedServer: type: object required: - id - hostname - servername - description - primaryIp - status - billingStatus - location - owners - cpu - ram - storage - price - currency - billingCycle - machine - role properties: id: type: string format: uuid hostname: type: string servername: type: string description: type: string primaryIp: type: string status: $ref: '#/components/schemas/PublicDedicatedPowerState' billingStatus: $ref: '#/components/schemas/PublicDedicatedServiceStatus' location: type: string owners: type: integer description: Length of TenantOS's owner chain. cpu: type: object required: - model - cores - threads - mhz properties: model: type: string cores: type: integer threads: type: integer mhz: type: string ram: type: object required: - totalGb properties: totalGb: type: integer storage: type: object required: - totalGb - disks properties: totalGb: type: integer disks: type: integer price: type: - integer - 'null' description: Recurring price in minor units. currency: type: string default: GBP billingCycle: type: string default: monthly machine: $ref: '#/components/schemas/PublicDedicatedMachine' role: type: string enum: - OWNER - ADMIN - OPERATOR - VIEWER - STAFF PublicDedicatedPowerState: type: string enum: - 'on' - 'off' - unknown PublicDedicatedServiceStatus: type: string enum: - ACTIVE - SUSPENDED - TERMINATED - CANCELLED - PENDING PublicDedicatedMachine: type: object description: >- The shared Machine shape every server screen reads, whichever backend the server lives on. required: - id - kind - flavour - label - hostname - tags - status - power - specs - ips - location - os - loginUser - renewal - activeTask - rescueActive properties: id: type: string format: uuid kind: type: string enum: - vm - metal flavour: type: string enum: - linux - windows label: type: string hostname: type: string tags: type: array items: type: string status: type: string enum: - pending - active - suspended - cancelled - terminated power: type: object required: - state - at - stale - verbs properties: state: $ref: '#/components/schemas/PublicDedicatedPowerState' at: type: - string - 'null' format: date-time description: When we last heard. stale: type: boolean verbs: type: array items: type: string enum: - start - shutdown - stop - reboot - reset specs: type: object required: - cpu - cores - threads - ramMb - disks - bandwidthTb - portMbps properties: cpu: type: string cores: type: integer threads: type: - integer - 'null' ramMb: type: integer disks: type: array items: type: object required: - sizeGb - kind properties: sizeGb: type: number kind: type: string example: NVMe bandwidthTb: type: - number - 'null' portMbps: type: - integer - 'null' ips: type: object required: - v4 - v6 properties: v4: type: array items: type: object required: - address - primary - rdns properties: address: type: string primary: type: boolean rdns: type: - string - 'null' v6: type: array items: type: object required: - prefix - rdns properties: prefix: type: string example: 2001:db8:1::/64 rdns: type: - string - 'null' location: type: object required: - code - name - country properties: code: type: string name: type: string country: type: string os: type: - object - 'null' required: - name - family properties: name: type: string family: type: string loginUser: type: string example: root renewal: type: object required: - nextDueDate - cycle - amountMinor - currency properties: nextDueDate: type: - string - 'null' format: date-time cycle: type: - string - 'null' amountMinor: type: - integer - 'null' currency: type: string activeTask: type: - object - 'null' required: - id - kind - step - progress - startedAt properties: id: type: string kind: type: string example: reinstall step: type: - string - 'null' progress: type: - number - 'null' startedAt: type: string format: date-time rescueActive: 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: 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__ 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.