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

# Get a runtime config

> One saved runtime config, with its sealed fields named but not answered.



## OpenAPI

````yaml /openapi.yaml get /v1/runtimes/{ref}
openapi: 3.1.0
info:
  title: Mirage API
  version: '0.1'
servers:
  - url: http://127.0.0.1:8765
    description: A local daemon on its default port
security:
  - bearerAuth: []
paths:
  /v1/runtimes/{ref}:
    get:
      tags:
        - Saved runtimes
      summary: Get a runtime config
      description: One saved runtime config, with its sealed fields named but not answered.
      operationId: get_entry_v1_runtimes__ref__get
      parameters:
        - in: path
          name: ref
          required: true
          schema:
            type: string
          description: The runtime config's name.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SavedEntryDetail'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
        '429':
          $ref: '#/components/responses/429'
        '501':
          $ref: '#/components/responses/501'
components:
  schemas:
    SavedEntryDetail:
      allOf:
        - $ref: '#/components/schemas/SavedEntry'
        - type: object
          properties:
            sealed:
              type: array
              items:
                type: string
              description: The sealed fields, by name.
          required:
            - sealed
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    SavedEntry:
      type: object
      properties:
        id:
          type: string
          description: The entry's id; the daemon uses its name.
        name:
          type: string
        kind:
          type: string
          enum:
            - vfs
            - cli
            - runtime
        type:
          type: string
          description: The VFS, CLI or runtime type, such as s3.
        builtin:
          type: boolean
        config:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/FieldValue'
          description: The plain fields. Sealed fields are never answered.
        captures:
          type: array
          items: {}
          description: A runtime's captures; runtimes only.
        created_by:
          type:
            - string
            - 'null'
        created_at:
          type:
            - string
            - 'null'
        updated_at:
          type:
            - string
            - 'null'
        used_by:
          type: integer
          description: How many templates name the entry; in a list only.
      required:
        - id
        - name
        - kind
        - type
        - builtin
        - config
    Error:
      type: object
      properties:
        detail:
          description: What went wrong, as text or a structured record.
        errno:
          type: string
          description: The errno of a failed file call, such as ENOENT.
        refusal:
          type: object
          description: The policy refusal, when a policy refused the call.
      required:
        - detail
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    FieldValue:
      description: >-
        A field's value, or a pointer to a saved store's secret for a string
        field.
      anyOf:
        - type: string
        - type: number
        - type: boolean
        - type: array
          items: {}
        - $ref: '#/components/schemas/SecretPointer'
    SecretPointer:
      type: object
      properties:
        from:
          type: string
          description: The saved store holding the secret.
        ref:
          type: string
          description: The secret in that store.
        key:
          type: string
          description: The key inside that secret whose value the field takes.
      required:
        - from
        - ref
        - key
  responses:
    '401':
      description: The token is missing or wrong
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
        text/plain:
          schema:
            type: string
            description: The Python daemon answers Unauthorized as plain text.
    '404':
      description: The workspace, session, job or file does not exist
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    '429':
      description: Past a rate limit, or a new session past max_sessions
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      headers:
        Retry-After:
          description: Seconds to wait before retrying.
          schema:
            type: integer
            minimum: 0
    '501':
      description: >-
        The server requires accounts; saved configs are kept only on a server of
        one account
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        The server's token (MIRAGE_AUTH_TOKEN) or a JWT. A daemon in the default
        local mode with no token accepts requests without one.

````

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