Skip to Content
SeyloDocs
API referenceProjects

Get a project

GET
/api/v1/projects.get

Returns one project by id.

Needs projects.view on the project. Available to MCP clients and the assistant.

Authorization

cookieseylo_session<token>

Query Parameters

projectId*string

Panel-issued id.

Match^[a-z0-9]{16}$

Response Body

Success.

application/json
  1. response
id*string

Panel-issued id.

Match^[a-z0-9]{16}$
name*string

Shown in the sidebar; unique, case-insensitive.

Match^[A-Za-z0-9][A-Za-z0-9 ._-]*$
Length1 <= length <= 40
description*string
Lengthlength <= 500
protected*boolean
serviceCount*integer
Range0 <= value
nodeCount*integer
Range0 <= value
guestCount*integer
Range0 <= value
networkName*string
collapsed*boolean
position*|null
createdAt*string
Formatdate-time
updatedAt*string
Formatdate-time
Example Request
curl -X GET 'https://example.com/api/v1/projects.get?projectId=string'
Example Response
{  "id": "string",  "name": "string",  "description": "string",  "protected": true,  "serviceCount": 0,  "nodeCount": 0,  "guestCount": 0,  "networkName": "string",  "collapsed": true,  "position": 0,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Delete a project POST

Deletes an empty project. Fails while the project still has services, and for the protected Panel project. The caller repeats the project name to confirm. Needs `projects.delete` on the project. Available to MCP clients and the assistant, after a person approves the call.

List projects GET

Lists the projects the caller can see in the caller's sidebar order (then by name), with service, node and guest counts and whether each is collapsed. Any signed-in caller. Available to MCP clients and the assistant.