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

# Deployment Configuration

> Every setting safe to display, its source, and any findings.

**Who may call it:** admin. A workspace API key is refused here: this is an act that belongs to a named person.



## OpenAPI

````yaml /api/openapi.json get /v1/deployment/configuration
openapi: 3.1.0
info:
  title: RotaGrant API
  version: 0.1.0
  description: >-
    The HTTP API of a RotaGrant deployment, made from the product's own route
    definitions at the commit named in `x-rotascale-source`. Nothing here is
    written by hand.


    There is no shared endpoint. RotaGrant runs in your environment, and your
    deployment serves its own copy of this description at `/api/docs`. That copy
    is the authority on what your version has and which features are switched
    on; this one is the reference for one commit of the main line. The version
    is 0.1.0: routes and shapes can still change.


    Every route says who may call it. Most need a bearer token from the identity
    provider your deployment uses, held by a person with the role named. The
    routes an SDK calls also accept a workspace API key. A few are open, and say
    why.
servers:
  - url: https://{deployment}
    description: Your own deployment. There is no shared endpoint.
    variables:
      deployment:
        default: rotagrant.internal.example
        description: The host your deployment answers on.
security: []
paths:
  /v1/deployment/configuration:
    get:
      tags:
        - Deployment
      summary: Deployment Configuration
      description: >-
        Every setting safe to display, its source, and any findings.


        **Who may call it:** admin. A workspace API key is refused here: this is
        an act that belongs to a named person.
      operationId: deployment_configuration_v1_deployment_configuration_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigurationOut'
      security:
        - bearerToken: []
components:
  schemas:
    ConfigurationOut:
      properties:
        groups:
          items:
            $ref: '#/components/schemas/SettingGroupOut'
          type: array
          title: Groups
        signing:
          $ref: '#/components/schemas/SigningOut'
        findings:
          items:
            $ref: '#/components/schemas/ConfigFindingOut'
          type: array
          title: Findings
        withheld:
          items:
            $ref: '#/components/schemas/WithheldOut'
          type: array
          title: Withheld
        disclosure:
          type: string
          title: Disclosure
      type: object
      required:
        - groups
        - signing
        - findings
        - withheld
        - disclosure
      title: ConfigurationOut
      description: Everything this deployment is set to do, and what is wrong with it.
    SettingGroupOut:
      properties:
        group:
          type: string
          title: Group
        settings:
          items:
            $ref: '#/components/schemas/SettingOut'
          type: array
          title: Settings
      type: object
      required:
        - group
        - settings
      title: SettingGroupOut
    SigningOut:
      properties:
        key_ref:
          type: string
          title: Key Ref
        custody:
          type: string
          title: Custody
        custody_means:
          type: string
          title: Custody Means
        ephemeral:
          type: boolean
          title: Ephemeral
      type: object
      required:
        - key_ref
        - custody
        - custody_means
        - ephemeral
      title: SigningOut
    ConfigFindingOut:
      properties:
        code:
          type: string
          title: Code
        severity:
          type: string
          title: Severity
        title:
          type: string
          title: Title
        detail:
          type: string
          title: Detail
        remedy:
          type: string
          title: Remedy
      type: object
      required:
        - code
        - severity
        - title
        - detail
        - remedy
      title: ConfigFindingOut
    WithheldOut:
      properties:
        setting:
          type: string
          title: Setting
        reason:
          type: string
          title: Reason
      type: object
      required:
        - setting
        - reason
      title: WithheldOut
    SettingOut:
      properties:
        setting:
          type: string
          title: Setting
        value:
          title: Value
        means:
          type: string
          title: Means
        source:
          type: string
          title: Source
        note:
          anyOf:
            - type: string
            - type: 'null'
          title: Note
      type: object
      required:
        - setting
        - means
        - source
      title: SettingOut
  securitySchemes:
    bearerToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        A token from the identity provider your deployment federates with. It
        identifies a person; their roles in the workspace decide what they may
        do.

````

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