v1

latestOpenAPI 3.1.02026-07-13154170539.0 KB
Contexts

Rename Context

Rename an existing context within a project.

patch/v0/project/{project_name}/contexts/{context_name}/rename

Path parameters

project_namestring required
context_namestring required

Query parameters

include_childrenboolean

Whether to rename child contexts (which share the same '/' separated prefix). When True, renaming 'A' to 'E' will also rename 'A/B/C' to 'E/B/C', 'A/B/D' to 'E/B/D', etc.

Whether to rename child contexts (which share the same '/' separated prefix). When True, renaming 'A' to 'E' will also rename 'A/B/C' to 'E/B/C', 'A/B/D' to 'E/B/D', etc.

Request body

namestring required

New name for the context, must meet naming rules

Example request

{
  "name": "experiment2/trial3"
}

Response

Context renamed successfully

{"stackTrail":"paths:/v0/project/{project_name}/contexts/{context_name}/rename:patch:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}