zGrid-api/docs/paths/home/rotate_key.yaml

operationId: homeRotateKey
summary: Rotate API Key
security:
  - UserAuth: []
description: Rotate the API key
tags: [Home]
parameters:
  - name: home_id
    in: path
    description: ID of home
    required: true
    schema:
      type: string
      format: uuid
      example: c27f3ac5-c6e7-4cda-a383-26115e6f5620
requestBody:
  content:
    application/json:
      schema:
        type: object
        required:
          - email
          - password
        properties:
          email:
            type: string
            format: email
            description: Email of user that is admin for home
            example: john.smith@mail.com
          password:
            type: string
            description: Current user password
            example: password123

responses:
  "200":
    description: "API key changed (always returns '{success: true}')"
    content:
      application/json:
        schema:
          type: object
          properties:
            success:
              type: boolean
  "400":
    $ref: "#/components/responses/400"
  "401":
    $ref: "#/components/responses/401"
  "403":
    $ref: "#/components/responses/403"
  "404":
    $ref: "#/components/responses/404"
  "500":
    $ref: "#/components/responses/500"