Share feedback
Answers are generated based on the documentation.

Experimental

Product manualDownload OpenAPI specificationMarkdown

IssueSSHCert signs a caller-held public key for sandbox SSH access.

POST/v1/sandboxes/{sandbox}/ssh-certificates

IssueSSHCert signs a caller-held public key for sandbox SSH access. A create: each call mints one certificate under the sandbox's certificate collection.

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

IssueSSHCertRequest asks the backend to sign a caller-held public key.
publicKey · required

Type: string

public_key is the caller-held SSH public key.
All schema constraints and annotations
{
  "description": "public_key is the caller-held SSH public key.",
  "minLength": 1,
  "type": "string"
}
ttl

Schema: Duration

ttl is the requested certificate lifetime.
All schema constraints and annotations
{
  "$ref": "#/components/schemas/Duration",
  "description": "ttl is the requested certificate lifetime."
}
All schema constraints and annotations
{
  "additionalProperties": false,
  "description": "IssueSSHCertRequest asks the backend to sign a caller-held public key.",
  "properties": {
    "publicKey": {
      "description": "public_key is the caller-held SSH public key.",
      "minLength": 1,
      "type": "string"
    },
    "ttl": {
      "$ref": "#/components/schemas/Duration",
      "description": "ttl is the requested certificate lifetime."
    }
  },
  "required": [
    "publicKey"
  ],
  "title": "IssueSSHCertRequest",
  "type": "object"
}

Response 201

Success

application/json

Headers

Cache-Control

{
  "required": true,
  "schema": {
    "const": "no-store",
    "type": "string"
  }
}

Schema: IssueSSHCertResponse

Response 409

Creation conflicts with an existing resource (ALREADY_EXISTS).

application/json

Headers

Cache-Control

{
  "required": true,
  "schema": {
    "enum": [
      "no-store"
    ],
    "type": "string"
  }
}

Schema: Error

Schema example

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

Response 501

This operation is not available on this service.

application/json

Headers

Cache-Control

{
  "required": true,
  "schema": {
    "enum": [
      "no-store"
    ],
    "type": "string"
  }
}

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

Headers

Cache-Control

{
  "required": true,
  "schema": {
    "enum": [
      "no-store"
    ],
    "type": "string"
  }
}

Schema: Error

Schema example

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

Referenced schemas

#/components/schemas/Duration

#/components/schemas/Error

#/components/schemas/IssueSSHCertResponse

Complete operation contract
{
  "description": "IssueSSHCert signs a caller-held public key for sandbox SSH access.\nA create: each call mints one certificate under the sandbox's certificate collection.\n\nReturns unimplemented when this operation is unavailable. Support does not grant permission.",
  "operationId": "issueSSHCert",
  "parameters": [
    {
      "description": "The sandbox id.",
      "in": "path",
      "name": "sandbox",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "additionalProperties": false,
          "description": "IssueSSHCertRequest asks the backend to sign a caller-held public key.",
          "properties": {
            "publicKey": {
              "description": "public_key is the caller-held SSH public key.",
              "minLength": 1,
              "type": "string"
            },
            "ttl": {
              "$ref": "#/components/schemas/Duration",
              "description": "ttl is the requested certificate lifetime."
            }
          },
          "required": [
            "publicKey"
          ],
          "title": "IssueSSHCertRequest",
          "type": "object"
        }
      }
    },
    "required": true
  },
  "responses": {
    "201": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/IssueSSHCertResponse"
          }
        }
      },
      "description": "Success",
      "headers": {
        "Cache-Control": {
          "required": true,
          "schema": {
            "const": "no-store",
            "type": "string"
          }
        }
      }
    },
    "409": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "Creation conflicts with an existing resource (ALREADY_EXISTS).",
      "headers": {
        "Cache-Control": {
          "required": true,
          "schema": {
            "enum": [
              "no-store"
            ],
            "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.",
      "headers": {
        "Cache-Control": {
          "required": true,
          "schema": {
            "enum": [
              "no-store"
            ],
            "type": "string"
          }
        }
      }
    },
    "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.",
      "headers": {
        "Cache-Control": {
          "required": true,
          "schema": {
            "enum": [
              "no-store"
            ],
            "type": "string"
          }
        }
      }
    }
  },
  "security": [
    {
      "bearer": []
    }
  ],
  "summary": "IssueSSHCert signs a caller-held public key for sandbox SSH access.",
  "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": [
    "sandboxesSsh"
  ],
  "x-sbx-serving-surface": "management"
}