Skip to content

Restore the console to a previous commit (as a new commit)

POST
/api/workspaces/{workspaceId}/consoles/{id}/restore
curl --request POST \
--url http://localhost:8080/api/workspaces/example/consoles/example/restore \
--header 'Content-Type: application/json' \
--cookie auth_session=<auth_session> \
--data '{ "sha": "example" }'

Sets the console back to its content at sha and commits that on main. Nothing is rewritten: the versions in between stay in the history.

workspaceId
required
string
id
required
string
Media typeapplication/json
object
sha
required
string
/^[0-9a-f]{7,40}$/

Example generated

{
"sha": "example"
}

Successful response

Media typeapplication/json
object
success

Whether the request succeeded.

boolean
data

Endpoint-specific response payload.

message
string
error
string

Example

{
"message": "Operation completed",
"error": "Error message"
}

Invalid request

Media typeapplication/json
object
success
boolean
error
string

Example

{
"error": "Error message"
}

Internal server error

Media typeapplication/json
object
success
boolean
error
string

Example

{
"error": "Error message"
}