Back to Enso

Project Manager HTTP Endpoints

docs/language-server/project-manager-http-endpoints.md

2025.3.41.1 KB
Original Source

HTTP Endpoints

Project Manager exposes a number of HTTP endpoints on the same socket as the JSONRPC protocol.

<!-- MarkdownTOC levels="2" autolink="true" indent=" " --> <!-- /MarkdownTOC -->

/projects/{project_id}/enso-project?projectsDirectory={projects_path}

HTTP endpoint that returns the project structure in .enso-project format. The optional projectsDirectory parameter allows the user to specify a custom path to projects' directory (e.g. if it is in a subfolder).

GET

Returns:

  • 200 OK with the body containing the project structure as a .tar.gz archive
  • 404 Not Found when the project cannot be found by the provided id
  • 500 Internal Server Error in case of errors

Request

text
> GET /projects/730a66ef-4222-46f8-8a03-d766946ab2bd/enso-project HTTP/1.1
> Host: localhost:30535
> User-Agent: curl/8.1.2
> Accept: */*

Response

text
< HTTP/1.1 200 OK
< Server: akka-http/10.2.10
< Date: Thu, 13 Jul 2023 16:20:08 GMT
< Content-Type: application/gzip
< Content-Length: 2527
<
[2527 bytes data]