Share feedback
Answers are generated based on the documentation.

Experimental

Product manualDownload OpenAPI specificationMarkdown

RenewSandboxTimeout sets a TTL when timeout renewal is supported.

POST/v1/sandboxes/{sandbox}/renew-timeout

RenewSandboxTimeout sets a TTL when timeout renewal is supported. The TTL starts at acceptance, and the response returns the new expires_at with the sandbox's timeout configuration preserved. Action: the TTL restarts at acceptance, so the result is not a value the caller could PUT.

Returns unimplemented when this operation is unavailable. Support does not grant permission.

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"
}

Request and responses

Request

application/json

Type: object

RenewSandboxTimeoutRequest sets a new remaining TTL.
timeout · required

Schema: Duration

timeout is the new TTL relative to server acceptance time.
All schema constraints and annotations
{
  "$ref": "#/components/schemas/Duration",
  "description": "timeout is the new TTL relative to server acceptance time."
}
All schema constraints and annotations
{
  "additionalProperties": false,
  "description": "RenewSandboxTimeoutRequest sets a new remaining TTL.",
  "properties": {
    "timeout": {
      "$ref": "#/components/schemas/Duration",
      "description": "timeout is the new TTL relative to server acceptance time."
    }
  },
  "required": [
    "timeout"
  ],
  "title": "RenewSandboxTimeoutRequest",
  "type": "object"
}

Response 200

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: Sandbox

Response 501

This operation is not available on this service.

application/json

Schema: Error

unimplemented

{
  "code": "unimplemented",
  "message": "This operation is not available on this service."
}

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/Duration

#/components/schemas/Error

#/components/schemas/Sandbox

Complete operation contract
{
  "description": "RenewSandboxTimeout sets a TTL when timeout renewal is supported. The TTL starts at acceptance, and the response returns the new expires_at with the sandbox's timeout configuration preserved.\nAction: the TTL restarts at acceptance, so the result is not a value the caller could\nPUT.\n\nReturns unimplemented when this operation is unavailable. Support does not grant permission.",
  "operationId": "renewSandboxTimeout",
  "parameters": [
    {
      "description": "The sandbox id.",
      "in": "path",
      "name": "sandbox",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "additionalProperties": false,
          "description": "RenewSandboxTimeoutRequest sets a new remaining TTL.",
          "properties": {
            "timeout": {
              "$ref": "#/components/schemas/Duration",
              "description": "timeout is the new TTL relative to server acceptance time."
            }
          },
          "required": [
            "timeout"
          ],
          "title": "RenewSandboxTimeoutRequest",
          "type": "object"
        }
      }
    },
    "required": true
  },
  "responses": {
    "200": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Sandbox"
          }
        }
      },
      "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"
          }
        }
      }
    },
    "501": {
      "content": {
        "application/json": {
          "examples": {
            "unimplemented": {
              "summary": "This operation is not available on this service.",
              "value": {
                "code": "unimplemented",
                "message": "This operation is not available on this service."
              }
            }
          },
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "This operation is not available on this service."
    },
    "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": "RenewSandboxTimeout sets a TTL when timeout renewal is supported.",
  "tags": [
    "Sandboxes"
  ],
  "x-sbx-authenticated-only": false,
  "x-sbx-conditional-permissions": [],
  "x-sbx-error-responses": [
    {
      "code": "UNIMPLEMENTED",
      "description": "This operation is not available on this service."
    }
  ],
  "x-sbx-plane": "control",
  "x-sbx-required-permissions": [
    "sandboxesLifecycle"
  ],
  "x-sbx-serving-surface": "management"
}