oCoreoCore Docs
API Reference

Dev Tools

Get devcontainer config

Returns the devcontainer.json configuration object for the instance.

GET
/instances/{id}/dev-tools/devcontainer

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Path Parameters

idRequiredstring

Instance ID (UUID)

curl -X GET "//api.ocore.dev/api/instances/<string>/dev-tools/devcontainer" \
  -H "Authorization: <token>"

OK

{}

Returns deep link URIs for VS Code, Cursor, and connection instructions for Zed.

GET
/instances/{id}/dev-tools/editor-links

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Path Parameters

idRequiredstring

Instance ID (UUID)

curl -X GET "//api.ocore.dev/api/instances/<string>/dev-tools/editor-links" \
  -H "Authorization: <token>"

OK

{
  "cursor_url": "string",
  "vscode_url": "string",
  "zed_instructions": "string"
}

Get full dev configuration

Returns comprehensive dev container config including devcontainer.json, launch.json, postCreateCommand, codespace URL, SSH config, and editor links.

GET
/instances/{id}/dev-tools/full-config

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Path Parameters

idRequiredstring

Instance ID (UUID)

curl -X GET "//api.ocore.dev/api/instances/<string>/dev-tools/full-config" \
  -H "Authorization: <token>"

OK

{}

Generate SSH key pair

Generates an SSH key pair for the instance and returns the private key as PEM text.

POST
/instances/{id}/dev-tools/generate-key

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Path Parameters

idRequiredstring

Instance ID (UUID)

curl -X POST "//api.ocore.dev/api/instances/<string>/dev-tools/generate-key" \
  -H "Authorization: <token>"

OK

{
  "private_key": "string"
}

Get SSH config

Returns a generated SSH config snippet for connecting to the instance.

GET
/instances/{id}/dev-tools/ssh-config

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Path Parameters

idRequiredstring

Instance ID (UUID)

curl -X GET "//api.ocore.dev/api/instances/<string>/dev-tools/ssh-config" \
  -H "Authorization: <token>"

OK

{
  "ssh_config": "string"
}

Get development status

Returns development status for the instance including environment type and auto-reload.

GET
/instances/{id}/dev-tools/status

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Path Parameters

idRequiredstring

Instance ID (UUID)

curl -X GET "//api.ocore.dev/api/instances/<string>/dev-tools/status" \
  -H "Authorization: <token>"

OK

{
  "auto_reload": true,
  "environment_type": "string",
  "odoo_version": "string"
}

List instance files

Lists files at the instance's addon directory or a custom path.

GET
/instances/{id}/files

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Path Parameters

idRequiredstring

Instance ID (UUID)

Query Parameters

pathstring

Directory path to list

curl -X GET "//api.ocore.dev/api/instances/<string>/files?path=%3Cstring%3E" \
  -H "Authorization: <token>"

OK

{
  "files": [
    {}
  ],
  "path": "string"
}

Read instance file

Reads a file from the instance's server, scoped to the instance directory.

GET
/instances/{id}/files/read

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Path Parameters

idRequiredstring

Instance ID (UUID)

Query Parameters

pathRequiredstring

File path to read

curl -X GET "//api.ocore.dev/api/instances/<string>/files/read?path=%3Cstring%3E" \
  -H "Authorization: <token>"

OK

{
  "content": "string",
  "path": "string"
}

List instance file tree

Returns a recursive file listing at the instance's addon directory up to a given depth.

GET
/instances/{id}/files/tree

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Path Parameters

idRequiredstring

Instance ID (UUID)

Query Parameters

pathstring

Root path for tree listing

depthinteger

Maximum recursion depth

Default: 3
curl -X GET "//api.ocore.dev/api/instances/<string>/files/tree?path=%3Cstring%3E&depth=3" \
  -H "Authorization: <token>"

OK

{
  "depth": 0,
  "files": [
    {}
  ],
  "path": "string"
}

Write instance file

Writes content to a file on the instance's server. Includes python_file flag for .py files.

PUT
/instances/{id}/files/write

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Request Body

application/jsonRequired

File path and content

contentstring
pathstring

Path Parameters

idRequiredstring

Instance ID (UUID)

curl -X PUT "//api.ocore.dev/api/instances/<string>/files/write" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "content": "string",
    "path": "string"
  }'

OK

{
  "message": "string",
  "path": "string"
}

Was this page helpful?
Edit on GitHub

File Watcher

Previous Page

Terminal

Next Page