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

# Gets an agent's processors, memory and disks.

> Processors and disks from the agent's last scan, total memory and the hardware type from the
agent's record. Sizes are in bytes.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/assets/agents/{agentAssetId}/hardware
openapi: 3.0.4
info:
  title: Public API
  description: Gorelo Public API documentation.
  version: 1.0.0
servers:
  - url: https://api.usw.gorelo.io
    description: US
  - url: https://api.aue.gorelo.io
    description: Australia
security:
  - ApiKeyAuth: []
tags:
  - name: Attachments
    description: "Uploading a file, for anything that can carry one. One endpoint rather than one per record\r\ntype, because the upload itself is identical - only the record it is checked against differs."
  - name: Alerts
    description: Alerts management operations
  - name: Assets
    description: Assets management operations
  - name: Billing
    description: Billing management operations
  - name: Tickets
    description: Tickets management operations
  - name: Clients
    description: Clients management operations
  - name: Contacts
    description: Contacts management operations
  - name: Deletions
    description: Deletions management operations
  - name: Documents
    description: Documents management operations
  - name: Forms
    description: Forms management operations
  - name: Organization
    description: Organization management operations
  - name: Projects
    description: Projects management operations
paths:
  /v1/assets/agents/{agentAssetId}/hardware:
    get:
      tags:
        - Assets
      summary: Gets an agent's processors, memory and disks.
      description: "Processors and disks from the agent's last scan, total memory and the hardware type from the\r\nagent's record. Sizes are in bytes."
      operationId: get_v1_assets_agents_agentAssetId_hardware
      parameters:
        - name: agentAssetId
          in: path
          description: Agent asset identifier.
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/AgentHardwareModelBaseResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/AgentHardwareModelBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/AgentHardwareModelBaseResponse'
        '401':
          description: Unauthorized
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
        '404':
          description: Not Found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
        '500':
          description: Internal Server Error
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
components:
  schemas:
    AgentHardwareModelBaseResponse:
      type: object
      properties:
        StatusCode:
          $ref: '#/components/schemas/HttpStatusCode'
        IsSuccess:
          type: boolean
        Data:
          $ref: '#/components/schemas/AgentHardwareModel'
        DataContext:
          type: object
          additionalProperties: false
          nullable: true
          example: null
        Notifications:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      additionalProperties: false
    ObjectBaseResponse:
      type: object
      properties:
        StatusCode:
          $ref: '#/components/schemas/HttpStatusCode'
        IsSuccess:
          type: boolean
        Data:
          nullable: true
        DataContext:
          $ref: '#/components/schemas/ErrorDataContext'
        Notifications:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      additionalProperties: false
    HttpStatusCode:
      enum:
        - 100
        - 101
        - 102
        - 103
        - 200
        - 201
        - 202
        - 203
        - 204
        - 205
        - 206
        - 207
        - 208
        - 226
        - 300
        - 301
        - 302
        - 303
        - 304
        - 305
        - 306
        - 307
        - 308
        - 400
        - 401
        - 402
        - 403
        - 404
        - 405
        - 406
        - 407
        - 408
        - 409
        - 410
        - 411
        - 412
        - 413
        - 414
        - 415
        - 416
        - 417
        - 421
        - 422
        - 423
        - 424
        - 426
        - 428
        - 429
        - 431
        - 451
        - 500
        - 501
        - 502
        - 503
        - 504
        - 505
        - 506
        - 507
        - 508
        - 510
        - 511
      type: integer
      format: int32
    AgentHardwareModel:
      type: object
      properties:
        LastScannedOn:
          type: string
          description: >-
            When the agent last reported its disks or processors (UTC); `null`
            when it never has.
          format: date-time
          nullable: true
        HardwareType:
          type: string
          description: "The agent's hardware type: the service provider's custom hardware type when one is set,\r\notherwise the type the device reports. The same value as `HardwareType` on\r\n`GET /v1/assets/agents/{agentAssetId}`."
          nullable: true
          example: Laptop
        Processors:
          type: array
          items:
            $ref: '#/components/schemas/AgentProcessorModel'
          description: The agent's processors. Empty when the agent has reported none.
        TotalMemoryBytes:
          type: integer
          description: >-
            Total installed memory in bytes; `null` when not reported or not
            readable.
          format: int64
          nullable: true
          example: 17179869184
        Disks:
          type: array
          items:
            $ref: '#/components/schemas/AgentDiskModel'
          description: The agent's physical disks.
      additionalProperties: false
      description: An agent's processors, memory and disks.
    Error:
      type: object
      properties:
        Code:
          pattern: ^[0-9]{6}$
          type: string
          description: 6-digit MMTTNN error code. See the Public API error-code registry.
          example: '070101'
        Message:
          type: string
        PropertyName:
          type: string
          nullable: true
        ActionHint:
          type: string
          nullable: true
        DocUrl:
          type: string
          nullable: true
      additionalProperties: false
    ErrorDataContext:
      type: object
      properties:
        TraceId:
          type: string
          description: Request correlation id. Quote this when reporting a problem.
          nullable: true
      additionalProperties: false
      description: "The `DataContext` of an error response: carries the correlation id for the failed\r\nrequest."
    AgentProcessorModel:
      type: object
      properties:
        Model:
          type: string
          description: Processor model.
          example: Intel(R) Core(TM) i5-7200U CPU @ 2.50GHz
        Manufacturer:
          type: string
          description: Manufacturer as the processor reports it; `null` when not reported.
          nullable: true
          example: GenuineIntel
      additionalProperties: false
      description: One processor.
    AgentDiskModel:
      type: object
      properties:
        Name:
          type: string
          description: Disk name.
          nullable: true
          example: Samsung SSD 980 PRO 1TB
        Number:
          type: integer
          description: Disk number.
          format: int32
          example: 0
        HealthStatus:
          type: string
          description: 'Disk health: `Healthy`, `Warning`, `Unhealthy` or `Unknown`.'
          example: Healthy
        IsOnline:
          type: boolean
          description: "`true` when the disk reports itself online; `false` when offline, not ready, without\r\n            media, stopped or failed; `null` when it reported no status."
          nullable: true
        TotalSpaceBytes:
          type: integer
          description: Total size in bytes.
          format: int64
        FreeSpaceBytes:
          type: integer
          description: Free space in bytes.
          format: int64
        UsedSpaceBytes:
          type: integer
          description: 'Used space in bytes: total minus free.'
          format: int64
        Partitions:
          type: array
          items:
            $ref: '#/components/schemas/AgentPartitionModel'
          description: The disk's partitions.
      additionalProperties: false
      description: One physical disk.
    AgentPartitionModel:
      type: object
      properties:
        DriveLetter:
          type: string
          description: Drive letter; `null` when the partition has none.
          nullable: true
          example: C
        Label:
          type: string
          description: Volume label.
          nullable: true
          example: Windows
        FileSystem:
          type: string
          description: File system.
          nullable: true
          example: NTFS
        TotalSpaceBytes:
          type: integer
          description: Total size in bytes.
          format: int64
        FreeSpaceBytes:
          type: integer
          description: Free space in bytes.
          format: int64
        UsedSpaceBytes:
          type: integer
          description: 'Used space in bytes: total minus free.'
          format: int64
        HealthStatus:
          type: string
          description: 'Partition health: `Healthy`, `Warning`, `Unhealthy` or `Unknown`.'
          example: Healthy
        IsBoot:
          type: boolean
          description: Whether this is the boot partition.
        IsBitLockerProtected:
          type: boolean
          description: "`true` when BitLocker protection is on, `false` when it is off, `null` when\r\n            unknown or not reported."
          nullable: true
      additionalProperties: false
      description: One partition of a disk.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      description: >-
        Your Gorelo API key. See [Generate API key](/generate-api-key). If your
        data is hosted in Australia, click the base URL at the top of this page
        and select `https://api.aue.gorelo.io`.
      name: X-API-Key
      in: header

````

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