oCoreoCore Docs
API Reference

Modules

List installed modules

Returns installed Odoo modules for an instance via SSH.

GET
/instances/{id}/modules

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Path Parameters

idRequiredstring

Instance ID

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

OK

{}

Check module drift

Returns version mismatches between expected and installed modules.

GET
/instances/{id}/modules/drift

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Path Parameters

idRequiredstring

Instance ID

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

OK

{}

Install modules

Enqueues module install jobs for the specified modules.

POST
/instances/{id}/modules/install

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Request Body

application/jsonRequired

Module install request

modulesarray<string>

Path Parameters

idRequiredstring

Instance ID

curl -X POST "//api.ocore.dev/api/instances/<string>/modules/install" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "modules": [
      "string"
    ]
  }'

Accepted

{
  "message": "string"
}

Assess module risk

Evaluates the risk of installing or upgrading a module on an instance.

POST
/instances/{id}/modules/risk-assessment

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Request Body

application/jsonRequired

Risk assessment request

actionstring

install or upgrade

modulestring

Path Parameters

idRequiredstring

Instance ID

curl -X POST "//api.ocore.dev/api/instances/<string>/modules/risk-assessment" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "action": "string",
    "module": "string"
  }'

OK

{
  "dependencies": [
    {
      "installed": true,
      "name": "string",
      "state": "string"
    }
  ],
  "level": "string",
  "recommendation": "string",
  "score": 0,
  "warnings": [
    {
      "code": "string",
      "message": "string",
      "severity": "string"
    }
  ]
}

Uninstall modules

Enqueues module uninstall jobs for the specified modules.

POST
/instances/{id}/modules/uninstall

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Request Body

application/jsonRequired

Module uninstall request

modulesarray<string>

Path Parameters

idRequiredstring

Instance ID

curl -X POST "//api.ocore.dev/api/instances/<string>/modules/uninstall" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "modules": [
      "string"
    ]
  }'

Accepted

{
  "message": "string"
}

Update modules

Enqueues a module update job for the specified modules.

POST
/instances/{id}/modules/update

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Request Body

application/jsonRequired

Module update request

modulesarray<string>

Path Parameters

idRequiredstring

Instance ID

curl -X POST "//api.ocore.dev/api/instances/<string>/modules/update" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "modules": [
      "string"
    ]
  }'

Accepted

{
  "message": "string"
}

Was this page helpful?
Edit on GitHub

Git Hub Integration

Previous Page

Odoo Shell

Next Page