oCoreoCore Docs
API Reference

Servers

List servers

Returns all servers belonging to the current organization.

GET
/servers

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

curl -X GET "//api.ocore.dev/api/servers" \
  -H "Authorization: <token>"

OK

{
  "servers": [
    {
      "authMethod": "string",
      "cpuCores": 0,
      "createdAt": "string",
      "description": "string",
      "host": "string",
      "id": "string",
      "lastSeenAt": "string",
      "maxSshSessions": 0,
      "name": "string",
      "osName": "string",
      "osVersion": "string",
      "port": 0,
      "provisioningStep": "string",
      "proxyType": "string",
      "ramTotalBytes": 0,
      "sshUser": "string",
      "status": "string",
      "statusMessage": "string",
      "updatedAt": "string",
      "warning": "string"
    }
  ]
}

Create a new server

Creates a new server record with SSH connection details and enqueues a validation job. Requires manage:servers permission.

POST
/servers

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Request Body

application/jsonRequired

Server creation details

authMethodstring
hoststring
maxSshSessionsinteger
namestring
portinteger
sshPasswordstring
sshPrivateKeystring
sshUserstring
curl -X POST "//api.ocore.dev/api/servers" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "authMethod": "string",
    "host": "string",
    "maxSshSessions": 0,
    "name": "string",
    "port": 0,
    "sshPassword": "string",
    "sshPrivateKey": "string",
    "sshUser": "string"
  }'

Created

{
  "authMethod": "string",
  "cpuCores": 0,
  "createdAt": "string",
  "description": "string",
  "host": "string",
  "id": "string",
  "lastSeenAt": "string",
  "maxSshSessions": 0,
  "name": "string",
  "osName": "string",
  "osVersion": "string",
  "port": 0,
  "provisioningStep": "string",
  "proxyType": "string",
  "ramTotalBytes": 0,
  "sshUser": "string",
  "status": "string",
  "statusMessage": "string",
  "updatedAt": "string",
  "warning": "string"
}

Get server details

Returns detailed server information including hardware specs, status, and capacity estimate.

GET
/servers/{id}

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Path Parameters

idRequiredstring

Server UUID

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

OK

{
  "agentLastSeenAt": "string",
  "agentStatus": "string",
  "agentVersion": "string",
  "architecture": "string",
  "authMethod": "string",
  "capacity": {
    "cpuAvailable": 0,
    "diskAvailableGB": 0,
    "maxConcurrentUsers": 0,
    "maxInstances": 0,
    "ramAvailableMB": 0,
    "reasoning": "string"
  },
  "cpuCores": 0,
  "createdAt": "string",
  "description": "string",
  "diskTotalBytes": 0,
  "dockerVersion": "string",
  "host": "string",
  "hostKeyFingerprint": "string",
  "id": "string",
  "kernelVersion": "string",
  "lastSeenAt": "string",
  "maxSshSessions": 0,
  "measuredNonOcoreMemoryBytes": 0,
  "memoryReserveBytes": 0,
  "name": "string",
  "osName": "string",
  "osVersion": "string",
  "port": 0,
  "provisioningStep": "string",
  "proxyType": "string",
  "ramTotalBytes": 0,
  "sshUser": "string",
  "status": "string",
  "statusMessage": "string",
  "updatedAt": "string"
}

Delete server

Marks a server for asynchronous removal and enqueues a cleanup job. Requires manage:servers permission.

DELETE
/servers/{id}

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Path Parameters

idRequiredstring

Server UUID

curl -X DELETE "//api.ocore.dev/api/servers/<string>" \
  -H "Authorization: <token>"

Accepted

{
  "message": "string"
}

Update server

Updates server fields. If connection-affecting fields change, re-enqueues validation. memoryReserveBytes (0 clears it) is the memory the Odoo budget leaves to the OS and to workloads oCore does not manage; it is refused with 400 SERVER_INVALID_MEMORY_RESERVE while the server's RAM is unknown or when it is at or above 90% of it. Requires manage:servers permission.

PUT
/servers/{id}

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Request Body

application/jsonRequired

Server fields to update

authMethodstring
descriptionstring
hoststring
maxSshSessionsinteger
memoryReserveBytesinteger

Memory in bytes the Odoo budget leaves to the OS and to workloads oCore does not manage; 0 clears it. Needs the server's RAM to be known and must be under 90% of it.

namestring
portinteger
proxyTypestring
sshPasswordstring
sshPrivateKeystring
sshUserstring

Path Parameters

idRequiredstring

Server UUID

curl -X PUT "//api.ocore.dev/api/servers/<string>" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "authMethod": "string",
    "description": "string",
    "host": "string",
    "maxSshSessions": 0,
    "memoryReserveBytes": 0,
    "name": "string",
    "port": 0,
    "proxyType": "string",
    "sshPassword": "string",
    "sshPrivateKey": "string",
    "sshUser": "string"
  }'

OK

{
  "agentLastSeenAt": "string",
  "agentStatus": "string",
  "agentVersion": "string",
  "architecture": "string",
  "authMethod": "string",
  "capacity": {
    "cpuAvailable": 0,
    "diskAvailableGB": 0,
    "maxConcurrentUsers": 0,
    "maxInstances": 0,
    "ramAvailableMB": 0,
    "reasoning": "string"
  },
  "cpuCores": 0,
  "createdAt": "string",
  "description": "string",
  "diskTotalBytes": 0,
  "dockerVersion": "string",
  "host": "string",
  "hostKeyFingerprint": "string",
  "id": "string",
  "kernelVersion": "string",
  "lastSeenAt": "string",
  "maxSshSessions": 0,
  "measuredNonOcoreMemoryBytes": 0,
  "memoryReserveBytes": 0,
  "name": "string",
  "osName": "string",
  "osVersion": "string",
  "port": 0,
  "provisioningStep": "string",
  "proxyType": "string",
  "ramTotalBytes": 0,
  "sshUser": "string",
  "status": "string",
  "statusMessage": "string",
  "updatedAt": "string"
}

Get server capacity estimate

Returns estimated instance capacity based on server hardware specifications.

GET
/servers/{id}/capacity

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Path Parameters

idRequiredstring

Server UUID

curl -X GET "//api.ocore.dev/api/servers/<string>/capacity" \
  -H "Authorization: <token>"

OK

{
  "cpuAvailable": 0,
  "diskAvailableGB": 0,
  "maxConcurrentUsers": 0,
  "maxInstances": 0,
  "ramAvailableMB": 0,
  "reasoning": "string"
}

Get server provisioning logs

Returns the provisioning step history for a server.

GET
/servers/{id}/provisioning-logs

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Path Parameters

idRequiredstring

Server UUID

curl -X GET "//api.ocore.dev/api/servers/<string>/provisioning-logs" \
  -H "Authorization: <token>"

OK

{
  "logs": [
    {
      "completedAt": "string",
      "durationMs": 0,
      "id": "string",
      "message": "string",
      "startedAt": "string",
      "status": "string",
      "step": "string"
    }
  ]
}

Reset server host key

Clears the stored SSH host key and enqueues dedicated revalidation. Requires manage:servers permission.

POST
/servers/{id}/reset-host-key

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Path Parameters

idRequiredstring

Server UUID

curl -X POST "//api.ocore.dev/api/servers/<string>/reset-host-key" \
  -H "Authorization: <token>"

OK

{
  "message": "string"
}

Retry server provisioning

Re-enqueues a validation job for a server in error or pending status. Requires manage:servers permission.

POST
/servers/{id}/retry

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Path Parameters

idRequiredstring

Server UUID

curl -X POST "//api.ocore.dev/api/servers/<string>/retry" \
  -H "Authorization: <token>"

OK

{
  "message": "string"
}

Was this page helpful?
Edit on GitHub

Audit

Previous Page

Instances

Next Page