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

# Set Share

> Reference for merged 0.6.0 source. The latest verified binary release is 0.5.5; use your Engine’s /api/openapi.json for its installed contract.



## OpenAPI

````yaml /engine/openapi.json put /api/services/{name}/share
openapi: 3.1.0
info:
  title: nerditd
  version: 0.6.0
  description: >-
    Current source interface (0.6.0); verify your installed Engine version. This
    is not a claim that 0.6.0 is released.
servers:
  - url: http://127.0.0.1:9321
    description: Default local Engine; use your configured endpoint.
security: []
paths:
  /api/services/{name}/share:
    put:
      tags:
        - Exposure
      summary: Set Share
      description: >-
        Reference for merged 0.6.0 source. The latest verified binary release is
        0.5.5; use your Engine’s /api/openapi.json for its installed contract.
      operationId: set_share
      parameters:
        - name: name
          in: path
          required: true
          schema:
            type: string
            title: Name
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ShareRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShareView'
          description: HTTP 200 response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: HTTP 422 response
components:
  schemas:
    ShareRequest:
      properties:
        access:
          type: string
          enum:
            - private
            - public
          title: Access
          default: private
        consent:
          type: boolean
          title: Consent
          default: false
      additionalProperties: false
      type: object
      title: ShareRequest
    ShareView:
      properties:
        service_name:
          type: string
          title: Service Name
        access:
          type: string
          enum:
            - private
            - public
          title: Access
        url:
          anyOf:
            - type: string
            - type: 'null'
          title: Url
        state:
          type: string
          enum:
            - ready
            - link_down
            - not_entitled
          title: State
        created_at:
          type: string
          format: date-time
          title: Created At
        origin:
          $ref: '#/components/schemas/ShareOrigin'
      type: object
      required:
        - service_name
        - access
        - url
        - state
        - created_at
        - origin
      title: ShareView
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ShareOrigin:
      properties:
        status:
          $ref: '#/components/schemas/JobStatus'
        answers:
          type: boolean
          title: Answers
        hint:
          anyOf:
            - type: string
            - type: 'null'
          title: Hint
      type: object
      required:
        - status
        - answers
      title: ShareOrigin
    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
    JobStatus:
      type: string
      enum:
        - pending
        - scheduled
        - running
        - paused
        - completed
        - failed
        - cancelled
        - retrying
        - building
        - degraded
        - restarting
        - stopped
      title: JobStatus

````