> ## 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.

# Residency

> Where this deployment says it runs, and every configured egress target.

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



## OpenAPI

````yaml /api/openapi.json get /v1/residency
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/residency:
    get:
      tags:
        - Market
      summary: Residency
      description: >-
        Where this deployment says it runs, and every configured egress target.


        **Who may call it:** any role. A workspace API key is refused here: this
        is an act that belongs to a named person.
      operationId: residency_v1_residency_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResidencyOut'
      security:
        - bearerToken: []
components:
  schemas:
    ResidencyOut:
      properties:
        declared_region:
          anyOf:
            - type: string
            - type: 'null'
          title: Declared Region
        declared:
          type: boolean
          title: Declared
        airgapped:
          type: boolean
          title: Airgapped
          default: false
        leaves_deployment:
          items:
            type: string
          type: array
          title: Leaves Deployment
        configured_egress:
          items:
            $ref: '#/components/schemas/EgressTarget'
          type: array
          title: Configured Egress
        finding:
          anyOf:
            - type: string
            - type: 'null'
          title: Finding
      type: object
      required:
        - declared_region
        - declared
        - configured_egress
        - finding
      title: ResidencyOut
      description: Where this deployment says it runs, and everywhere it may talk.
    EgressTarget:
      properties:
        target:
          type: string
          title: Target
        value:
          type: string
          title: Value
        leaves_deployment:
          type: boolean
          title: Leaves Deployment
      type: object
      required:
        - target
        - value
        - leaves_deployment
      title: EgressTarget
  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.