Skip to Content
SeyloDocs
API referenceEnvironment

List what a service can reference

GET
/api/v1/env.references

Returns every ${{target.VARIABLE}} the service can use: other services of the project with their built-in variables (URL, INTERNAL_URL, EXPOSED_URL, ...) and the project's shared variables, with resolved values for hovers and the nodes each target runs on. The result is the analyzer context for @seylo/env-analyzer.

Needs env.view on the service (a grant on its project covers it). Available to MCP clients and the assistant.

Authorization

cookieseylo_session<token>

Query Parameters

serviceId*string

Panel-issued id.

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

Response Body

Success.

application/json
  1. response
self*
targets*array<>
Example Request
curl -X GET 'https://example.com/api/v1/env.references?serviceId=string'
Example Response
{  "self": {    "serviceId": "string",    "name": "string",    "nodes": [      {        "id": "string",        "name": "string"      }    ]  },  "targets": [    {      "name": "string",      "kind": "service",      "serviceId": "string",      "serviceKind": "string",      "nodes": [        {          "id": "string",          "name": "string"        }      ],      "internalHost": "string",      "exposed": true,      "variables": [        {          "name": "string",          "value": "string",          "scope": "internal",          "sensitive": true,          "description": "string",          "dependsOn": [            {              "target": "string",              "variable": "string"            }          ]        }      ]    }  ]}

Get a project's shared variables GET

Returns the project's shared variables as .env text. Every service of the project can use them as ${{project.NAME}}. Needs `env.view` on the project. Available to MCP clients and the assistant.

Save a service's environment POST

Replaces the service's .env text. Syntax errors are refused; context problems (for example an internal address of a service on another node) are saved and returned as diagnostics. The new values apply on the next deploy or restart. Needs `env.edit` on the service (a grant on its project covers it). Available to MCP clients and the assistant.