GET
/
projects
/
by-name
/
{name}
curl --request GET \
  --url https://www.orgo.ai/api/projects/by-name/{name} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "name": "<string>",
  "status": "starting",
  "desktop": {
    "webUrl": "<string>",
    "vncHost": "<string>",
    "vncPort": 123,
    "webPort": 123,
    "id": "<string>",
    "name": "<string>",
    "customDomain": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
name
string
required

Name of the project to retrieve

Response

200
application/json
Project details
​
id
string

Unique identifier for the project

​
name
string

Name of the project

​
status
enum<string>

Current status of the project

Available options:
starting,
running,
stopped,
error
​
desktop
object