Share feedback
Answers are generated based on the documentation.

Experimental

Product manualDownload OpenAPI specificationMarkdown

CreatePort makes one sandbox port reachable outside the sandbox.

POST/v1/sandboxes/{sandbox}/ports
CreatePort makes one sandbox port reachable outside the sandbox.

Connection and access

API connection and authentication guidance

https://connect.docker.com/sandboxes — The API base URL. Append the /v1 paths while preserving this URL's path prefix.

Use one of these alternatives. Requirements within an alternative apply together.

  • bearer

Parameters

sandbox path Required

The sandbox id.

Type: string

All schema constraints and annotations
{
  "type": "string"
}

Idempotency-Key header

Replay key. Reusing it with a different payload fails with failedPrecondition; accepted keys are retained for at least 24 hours.

Type: string

Idempotency key. A replay returns the first result; the same key with a different payload fails with FAILED_PRECONDITION; retained at least 24 hours.
All schema constraints and annotations
{
  "description": "Idempotency key. A replay returns the first result; the same key with a different payload fails with FAILED_PRECONDITION; retained at least 24 hours.",
  "title": "Idempotency-Key",
  "type": "string"
}

Request and responses

Request

application/json

Type: object

CreatePortRequest publishes one sandbox port.
port · required

Schema: CreatePortRequestPortInput

port is the requested publication.
All schema constraints and annotations
{
  "$ref": "#/components/schemas/CreatePortRequestPortInput",
  "description": "port is the requested publication."
}
All schema constraints and annotations
{
  "additionalProperties": false,
  "description": "CreatePortRequest publishes one sandbox port.",
  "properties": {
    "port": {
      "$ref": "#/components/schemas/CreatePortRequestPortInput",
      "description": "port is the requested publication."
    }
  },
  "required": [
    "port"
  ],
  "title": "CreatePortRequest",
  "type": "object"
}

Response 201

Success

application/json

Headers

ETag

The etag of the resource this response carries, which the next mutation of it sends as If-Match.

{
  "description": "The etag of the resource this response carries, which the next mutation of it sends as If-Match.",
  "schema": {
    "type": "string"
  }
}

Schema: Port

Response 409

Creation conflicts with an existing resource (ALREADY_EXISTS).

The sandbox already publishes this port number.

The Idempotency-Key was already used with a different payload.

application/json

Schema: Error

alreadyExists

{
  "code": "alreadyExists",
  "message": "The sandbox already publishes this port number."
}

failedPrecondition

{
  "code": "failedPrecondition",
  "message": "The Idempotency-Key was already used with a different payload."
}

Response default

The structured Error body identifies the failure with a stable code and optional typed details.

application/json

Schema: Error

Schema example

{
  "code": "notFound",
  "details": [],
  "message": "sandbox not found"
}

Referenced schemas

#/components/schemas/CreatePortRequestPortInput

#/components/schemas/Error

#/components/schemas/Port

Complete operation contract
{
  "description": "CreatePort makes one sandbox port reachable outside the sandbox.",
  "operationId": "createPort",
  "parameters": [
    {
      "description": "The sandbox id.",
      "in": "path",
      "name": "sandbox",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "description": "Replay key. Reusing it with a different payload fails with failedPrecondition; accepted keys are retained for at least 24 hours.",
      "in": "header",
      "name": "Idempotency-Key",
      "schema": {
        "description": "Idempotency key. A replay returns the first result; the same key with a different payload fails with FAILED_PRECONDITION; retained at least 24 hours.",
        "title": "Idempotency-Key",
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "additionalProperties": false,
          "description": "CreatePortRequest publishes one sandbox port.",
          "properties": {
            "port": {
              "$ref": "#/components/schemas/CreatePortRequestPortInput",
              "description": "port is the requested publication."
            }
          },
          "required": [
            "port"
          ],
          "title": "CreatePortRequest",
          "type": "object"
        }
      }
    },
    "required": true
  },
  "responses": {
    "201": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Port"
          }
        }
      },
      "description": "Success",
      "headers": {
        "ETag": {
          "description": "The etag of the resource this response carries, which the next mutation of it sends as If-Match.",
          "schema": {
            "type": "string"
          }
        }
      }
    },
    "409": {
      "content": {
        "application/json": {
          "examples": {
            "alreadyExists": {
              "summary": "The sandbox already publishes this port number.",
              "value": {
                "code": "alreadyExists",
                "message": "The sandbox already publishes this port number."
              }
            },
            "failedPrecondition": {
              "summary": "The Idempotency-Key was already used with a different payload.",
              "value": {
                "code": "failedPrecondition",
                "message": "The Idempotency-Key was already used with a different payload."
              }
            }
          },
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "Creation conflicts with an existing resource (ALREADY_EXISTS).\n\nThe sandbox already publishes this port number.\n\nThe Idempotency-Key was already used with a different payload."
    },
    "default": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "The structured Error body identifies the failure with a stable code and optional typed details."
    }
  },
  "security": [
    {
      "bearer": []
    }
  ],
  "summary": "CreatePort makes one sandbox port reachable outside the sandbox.",
  "tags": [
    "Sandboxes"
  ],
  "x-sbx-authenticated-only": false,
  "x-sbx-conditional-permissions": [],
  "x-sbx-error-responses": [
    {
      "code": "ALREADY_EXISTS",
      "description": "The sandbox already publishes this port number."
    },
    {
      "code": "FAILED_PRECONDITION",
      "description": "The Idempotency-Key was already used with a different payload."
    }
  ],
  "x-sbx-plane": "control",
  "x-sbx-required-permissions": [
    "sandboxesPorts"
  ],
  "x-sbx-serving-surface": "management"
}