SandboxesManagement

Rename a sandbox

Set or remove the name of a sandbox. A name is unique among the live sandboxes of the project: a name that another live sandbox holds returns 409. A sandbox in failed, deleting or deleted holds no name for this check. Rename is not allowed while the sandbox is deleting or deleted.

PUT
/v1/sandboxes/{idOrName}/rename
AuthorizationBearer <token>

API key starting with tektona_. Create one at app-dev.tektona.ai under API Keys.

In: header

Path Parameters

idOrName*string

Sandbox ID (ULID) or name

Query Parameters

org?string

Required when the path names the sandbox by name.

project?string

Required when the path names the sandbox by name.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*|

Sandbox name: lowercase letters, digits and hyphens, 1 to 40 characters, no hyphen at the start or the end. Unique among the live sandboxes of the project. It must not be a ULID (the sandbox ID format). Send null to remove the name.

Match^[a-z0-9]([a-z0-9-]*[a-z0-9])?$
Lengthlength <= 40

Response Body

application/json

application/problem+json

curl -X PUT "https://example.com/v1/sandboxes/string/rename" \  -H "Content-Type: application/json" \  -d '{    "name": "api-dev"  }'
{  "id": "string",  "name": "string"}