Skip to Content
SeyloDocs
API referenceProjects

Create a project

POST
/api/v1/projects.create

Creates an empty project. Services are added to it afterwards.

Needs projects.create, which owners and admins hold. Available to MCP clients and the assistant.

Authorization

cookieseylo_session<token>

Request Body

application/json
  1. body
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

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 POST 'https://example.com/api/v1/projects.create' \  -H 'Content-Type: application/json' \  -d '{  "name": "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"}

Turn PR previews on or off POST

Turns PR previews on or off and sets their domain pattern and limit. Previews use the same environment as the service, so they reach the same database: turning them on requires acknowledgeSharedEnv true. Turning them off removes open previews. Needs `services.update` on the service (a grant on its project covers it). Available to MCP clients and the assistant.

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.