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

# Create a share code

> Makes a code that lets another workspace create sandboxes from the template. The other workspace sends the code as `template` when it creates a sandbox. It cannot see, list, or download the template or its files. The response shows the code one time. A template can have 20 share codes. Needs the `templates:write` scope.



## OpenAPI

````yaml /api-reference/openapi.json post /v1/templates/{id}/share-codes
openapi: 3.1.0
info:
  title: VMS API
  version: 1.0.0
  description: >-
    The public API of a VMS workspace. Each request needs an API key of the
    workspace in the Authorization header.
servers:
  - url: https://vms.dev/api
    description: The VMS API
security:
  - apiKey: []
paths:
  /v1/templates/{id}/share-codes:
    post:
      tags:
        - Templates
      summary: Create a share code
      description: >-
        Makes a code that lets another workspace create sandboxes from the
        template. The other workspace sends the code as `template` when it
        creates a sandbox. It cannot see, list, or download the template or its
        files. The response shows the code one time. A template can have 20
        share codes. Needs the `templates:write` scope.
      operationId: createShareCode
      parameters:
        - in: path
          name: id
          schema:
            type: string
            example: tpl_06d8k3m7q2v9x4b1n5c0e8f2ja
          required: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateShareCodeBody'
      responses:
        '201':
          description: The share code, with the code.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatedShareCode'
        '400':
          description: The request is not valid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: The API key is missing, not correct, revoked, or expired.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: The API key does not have the scope of the endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: The workspace has no template with this ID.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: The template has 20 share codes.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: The API key sent more than 1,200 requests in one minute.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    CreateShareCodeBody:
      type: object
      properties:
        label:
          description: A note that tells you who has the code.
          type: string
          minLength: 1
          maxLength: 100
    CreatedShareCode:
      type: object
      properties:
        id:
          type: string
          example: tsc_06d8k3m7q2v9x4b1n5c0e8f2ja
        templateId:
          type: string
          example: tpl_06d8k3m7q2v9x4b1n5c0e8f2ja
        label:
          description: A note that tells you who has the code.
          example: partner-team
          type:
            - string
            - 'null'
        codeEnd:
          type: string
          description: The last 4 characters of the code.
          example: 8f2j
        lastUsedAt:
          anyOf:
            - type: string
              format: date-time
              pattern: >-
                ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
            - type: 'null'
          description: >-
            When a sandbox was last created with the code. Null if no sandbox
            was created with it.
        createdAt:
          type: string
          format: date-time
          pattern: >-
            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
        code:
          type: string
          description: >-
            The share code. Send it as `template` when you create a sandbox. The
            API shows it only in this response.
          example: share_9x4b1n5c0e8f2ja06d8k3m7q2v9x4b1n5c0e8f2j
      required:
        - id
        - templateId
        - label
        - codeEnd
        - lastUsedAt
        - createdAt
        - code
      additionalProperties: false
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: no_capacity
            message:
              type: string
            requestId:
              type:
                - string
                - 'null'
            retryAfterSeconds:
              type: integer
              minimum: 0
              maximum: 9007199254740991
            sandboxId:
              description: The sandbox that the error is about.
              type: string
          required:
            - code
            - message
            - requestId
          additionalProperties: false
      required:
        - error
      additionalProperties: false
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: An API key that starts with vms_. Make one in Settings > API keys.

````

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