Get Sandbox Options
Get the JSON Schema for a built-in sandbox provider’s user-facing kwargs.
GET
/
sandboxes
/
{name}
/
options
cURL
curl --request GET \
--url http://127.0.0.1:{port}/sandboxes/{name}/options \
--header 'Authorization: Bearer <token>'from harbor import Harbor
client = Harbor()
result = client.sandboxes.options("docker")
print(result)
client.close()
{
"additionalProperties": false,
"description": "User-facing kwargs for DockerEnvironment.",
"properties": {
"auto_mounting": {
"default": false,
"description": "Automatically bind Harbor output directories on local providers.",
"title": "Auto Mounting",
"type": "boolean"
},
"suppress_override_warnings": {
"default": false,
"deprecated": true,
"description": "Deprecated; resource override warnings are no longer emitted.",
"title": "Suppress Override Warnings",
"type": "boolean"
},
"keep_containers": {
"default": false,
"title": "Keep Containers",
"type": "boolean"
}
},
"title": "DockerOptions",
"type": "object"
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"_tag": "<string>",
"type": "about:blank"
}Authorizations
Response
Successful Response
The response is of type Response Get Sandbox Options Sandboxes Name Options Get · object.
Was this page helpful?
⌘I
cURL
curl --request GET \
--url http://127.0.0.1:{port}/sandboxes/{name}/options \
--header 'Authorization: Bearer <token>'from harbor import Harbor
client = Harbor()
result = client.sandboxes.options("docker")
print(result)
client.close()
{
"additionalProperties": false,
"description": "User-facing kwargs for DockerEnvironment.",
"properties": {
"auto_mounting": {
"default": false,
"description": "Automatically bind Harbor output directories on local providers.",
"title": "Auto Mounting",
"type": "boolean"
},
"suppress_override_warnings": {
"default": false,
"deprecated": true,
"description": "Deprecated; resource override warnings are no longer emitted.",
"title": "Suppress Override Warnings",
"type": "boolean"
},
"keep_containers": {
"default": false,
"title": "Keep Containers",
"type": "boolean"
}
},
"title": "DockerOptions",
"type": "object"
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"_tag": "<string>",
"type": "about:blank"
}
