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

# Get Valkey Instance

> Requires the `valkey.read` token ability.

Valkey is a per-account singleton, so this returns one object rather than a
list. The absence of an instance is reported as `activated: false`, not a 404.



## OpenAPI

````yaml /api-reference/openapi.json get /valkey
openapi: 3.1.0
info:
  title: Hosting Panel API
  version: 1.0.0
  description: >-
    The customer-facing hosting panel API. A request is scoped to the hosting
    account its bearer token belongs to; the token abilities decide which
    endpoints it may call.
servers:
  - url: https://hosting-panel.net/api/v1
security:
  - sanctum: []
tags:
  - name: Account
  - name: Domains
  - name: DNS
  - name: Email Accounts
  - name: Forwarders
  - name: Databases
  - name: FTP Accounts
  - name: Cron Jobs
  - name: URL Schedules
  - name: Node.js Applications
  - name: Valkey
  - name: Photon Optimizer
  - name: Statistics
  - name: PSI Metrics
  - name: PHP Versions
paths:
  /valkey:
    get:
      tags:
        - Valkey
      summary: Get Valkey Instance
      description: >-
        Requires the `valkey.read` token ability.


        Valkey is a per-account singleton, so this returns one object rather
        than a

        list. The absence of an instance is reported as `activated: false`, not
        a 404.
      operationId: valkey.show
      responses:
        '200':
          description: '`ValkeyResource`'
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/ValkeyResource'
                required:
                  - data
        '401':
          $ref: '#/components/responses/AuthenticationException'
components:
  schemas:
    ValkeyResource:
      type: object
      properties:
        activated:
          type: boolean
        maxmemory:
          type: string
        maxmemory_policy:
          type: string
        persistent:
          type: boolean
      required:
        - activated
        - maxmemory
        - maxmemory_policy
        - persistent
      title: ValkeyResource
  responses:
    AuthenticationException:
      description: Unauthenticated
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                description: Error overview.
            required:
              - message
  securitySchemes:
    sanctum:
      type: http
      description: >-
        An API access token, sent as `Authorization: Bearer <token>`. Its
        abilities decide which endpoints it may call.
      scheme: bearer

````