Sign in

v1

latestOpenAPI 3.1.02026-07-13154170539.0 KB
Contexts

Delete Context

Deletes a context from a project. This will not delete the logs or artifacts within the context, but will remove their association with this context.

When include_children is True (default), all child contexts sharing the same prefix will also be deleted. For Assistants/UnityTests projects, logs that exist in sibling contexts (All/X, User/All/X) will also have their associations cleaned up.

delete/v0/project/{project_name}/contexts/{context_name}

Path parameters

project_namestring required

Name of the project to delete context from.

Name of the project to delete context from.

context_namestring required

Name of the context to delete.

Name of the context to delete.

Query parameters

include_childrenboolean

Whether to delete child contexts (which share the same '/' separated prefix). When True, deleting 'experiments' will also delete 'experiments/trial1', 'experiments/trial2', etc. The parent context does not need to exist for children to be deleted.

Whether to delete child contexts (which share the same '/' separated prefix). When True, deleting 'experiments' will also delete 'experiments/trial1', 'experiments/trial2', etc. The parent context does not need to exist for children to be deleted.

Response

Successful Response

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