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

> What this deployment can reach, checked rather than described.

**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/egress
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/egress:
    get:
      tags:
        - Deployment
      summary: Deployment Egress
      description: >-
        What this deployment can reach, checked rather than described.


        **Who may call it:** admin. A workspace API key is refused here: this is
        an act that belongs to a named person.
      operationId: deployment_egress_v1_deployment_egress_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EgressOut'
      security:
        - bearerToken: []
components:
  schemas:
    EgressOut:
      properties:
        airgapped:
          type: boolean
          title: Airgapped
        targets:
          items:
            $ref: '#/components/schemas/EgressTargetOut'
          type: array
          title: Targets
        enforcement:
          anyOf:
            - $ref: '#/components/schemas/EgressEnforcementOut'
            - type: 'null'
        leaves_deployment:
          items:
            type: string
          type: array
          title: Leaves Deployment
        verdict:
          type: string
          title: Verdict
        checked_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Checked At
      type: object
      required:
        - airgapped
        - targets
        - verdict
      title: EgressOut
    EgressTargetOut:
      properties:
        target:
          type: string
          title: Target
        setting:
          type: string
          title: Setting
        value:
          anyOf:
            - type: string
            - type: 'null'
          title: Value
        configured:
          type: boolean
          title: Configured
        contacts:
          anyOf:
            - type: string
            - type: 'null'
          title: Contacts
        leaves_deployment:
          type: boolean
          title: Leaves Deployment
        satisfiable_in_a_closed_network:
          type: boolean
          title: Satisfiable In A Closed Network
        purpose:
          type: string
          title: Purpose
        state:
          type: string
          title: State
        detail:
          anyOf:
            - type: string
            - type: 'null'
          title: Detail
        status_code:
          anyOf:
            - type: integer
            - type: 'null'
          title: Status Code
        latency_ms:
          anyOf:
            - type: integer
            - type: 'null'
          title: Latency Ms
      type: object
      required:
        - target
        - setting
        - configured
        - leaves_deployment
        - satisfiable_in_a_closed_network
        - purpose
        - state
      title: EgressTargetOut
    EgressEnforcementOut:
      properties:
        refusing_outside_connections:
          type: boolean
          title: Refusing Outside Connections
        inside_networks_declared:
          items:
            type: string
          type: array
          title: Inside Networks Declared
        proxy_variables_ignored:
          items:
            type: string
          type: array
          title: Proxy Variables Ignored
        refused_since_start:
          additionalProperties:
            type: integer
          type: object
          title: Refused Since Start
      type: object
      required:
        - refusing_outside_connections
      title: EgressEnforcementOut
      description: What an airgapped deployment is doing about outside addresses.
  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.