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

# Register a sandbox

> Registers a machine as one of your organization's sandboxes and returns a single-use tailnet key, valid for an hour, with its envd configuration.



## OpenAPI

````yaml /api-reference/openapi.json post /v1/sandboxes
openapi: 3.1.0
info:
  title: envlink API
  version: 1.0.0
  description: >-
    Lease build environments, wire them to your sandbox, and keep snapshots and
    artifacts.
servers:
  - url: https://envlink-api.projectinwork.com
security:
  - bearerAuth: []
tags:
  - name: Environments
  - name: Templates
  - name: Sandboxes
  - name: Snapshots
  - name: Artifacts
  - name: Projects
  - name: Tokens
  - name: Usage
  - name: Account
paths:
  /v1/sandboxes:
    post:
      tags:
        - Sandboxes
      summary: Register a sandbox
      description: >-
        Registers a machine as one of your organization's sandboxes and returns
        a single-use tailnet key, valid for an hour, with its envd
        configuration.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: >-
                    A name for it on the tailnet; the hostname is used when
                    empty.
      responses:
        '201':
          description: Registered
          content:
            application/json:
              schema:
                type: object
                properties:
                  sandbox:
                    $ref: '#/components/schemas/Sandbox'
                  config:
                    type: object
                  key:
                    type: string
                    description: Single-use; join the tailnet with it.
components:
  schemas:
    Sandbox:
      type: object
      properties:
        id:
          type: string
          examples:
            - sb_in4kbsnlcd2ka5cc
        org:
          type: string
        name:
          type: string
          description: Its tailnet name.
          examples:
            - sb-devi-laptop-8253
        createdBy:
          type: string
        created:
          type: string
          format: date-time
        lastSeen:
          type: string
          format: date-time
        removed:
          type: string
          format: date-time
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: A CLI token or an organization API key.

````

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