oCoreoCore Docs
API Reference

Templates

List templates

Returns all templates owned by the organization.

GET
/templates

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

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

OK

{
  "items": [
    {
      "backupDestinationIds": [
        "string"
      ],
      "backupSchedulePreset": "string",
      "category": "string",
      "createdAt": "string",
      "defaultAddonsPath": "string",
      "defaultEnvVars": {
        "property1": "string",
        "property2": "string"
      },
      "defaultWorkers": 0,
      "description": "string",
      "gitRepoUrl": "string",
      "id": "string",
      "isMarketplace": true,
      "isPublic": true,
      "moduleList": [
        "string"
      ],
      "name": "string",
      "odooConfOverrides": {
        "property1": "string",
        "property2": "string"
      },
      "odooEdition": "string",
      "odooVersion": "string",
      "organizationId": "string",
      "updatedAt": "string",
      "usageCount": 0
    }
  ],
  "total": 0
}

Create template

Creates a new instance template with the specified configuration.

POST
/templates

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Request Body

application/jsonRequired

Template creation request

descriptionstring
namestring
odooEditionstring
odooVersionstring
curl -X POST "//api.ocore.dev/api/templates" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "string",
    "name": "string",
    "odooEdition": "string",
    "odooVersion": "string"
  }'

Created

{
  "backupDestinationIds": [
    "string"
  ],
  "backupSchedulePreset": "string",
  "category": "string",
  "createdAt": "string",
  "defaultAddonsPath": "string",
  "defaultEnvVars": {
    "property1": "string",
    "property2": "string"
  },
  "defaultWorkers": 0,
  "description": "string",
  "gitRepoUrl": "string",
  "id": "string",
  "isMarketplace": true,
  "isPublic": true,
  "moduleList": [
    "string"
  ],
  "name": "string",
  "odooConfOverrides": {
    "property1": "string",
    "property2": "string"
  },
  "odooEdition": "string",
  "odooVersion": "string",
  "organizationId": "string",
  "updatedAt": "string",
  "usageCount": 0
}

Save instance as template

Creates a template from an existing instance configuration.

POST
/templates/from-instance/{instanceId}

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Request Body

application/jsonRequired

Template save request

descriptionstring
namestring

Path Parameters

instanceIdRequiredstring

Instance ID

curl -X POST "//api.ocore.dev/api/templates/from-instance/<string>" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "string",
    "name": "string"
  }'

Created

{
  "backupDestinationIds": [
    "string"
  ],
  "backupSchedulePreset": "string",
  "category": "string",
  "createdAt": "string",
  "defaultAddonsPath": "string",
  "defaultEnvVars": {
    "property1": "string",
    "property2": "string"
  },
  "defaultWorkers": 0,
  "description": "string",
  "gitRepoUrl": "string",
  "id": "string",
  "isMarketplace": true,
  "isPublic": true,
  "moduleList": [
    "string"
  ],
  "name": "string",
  "odooConfOverrides": {
    "property1": "string",
    "property2": "string"
  },
  "odooEdition": "string",
  "odooVersion": "string",
  "organizationId": "string",
  "updatedAt": "string",
  "usageCount": 0
}

List marketplace templates

Returns public marketplace templates with optional filters.

GET
/templates/marketplace

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Query Parameters

pageinteger

Page number

per_pageinteger

Items per page

odoo_versionstring

Filter by Odoo version

editionstring

Filter by edition

categorystring

Filter by category

searchstring

Search term

curl -X GET "//api.ocore.dev/api/templates/marketplace?page=0&per_page=0&odoo_version=%3Cstring%3E&edition=%3Cstring%3E&category=%3Cstring%3E&search=%3Cstring%3E" \
  -H "Authorization: <token>"

OK

{
  "items": [
    {
      "backupDestinationIds": [
        "string"
      ],
      "backupSchedulePreset": "string",
      "category": "string",
      "createdAt": "string",
      "defaultAddonsPath": "string",
      "defaultEnvVars": {
        "property1": "string",
        "property2": "string"
      },
      "defaultWorkers": 0,
      "description": "string",
      "gitRepoUrl": "string",
      "id": "string",
      "isMarketplace": true,
      "isPublic": true,
      "moduleList": [
        "string"
      ],
      "name": "string",
      "odooConfOverrides": {
        "property1": "string",
        "property2": "string"
      },
      "odooEdition": "string",
      "odooVersion": "string",
      "organizationId": "string",
      "updatedAt": "string",
      "usageCount": 0
    }
  ],
  "page": 0,
  "perPage": 0,
  "total": 0
}

Get template

Returns a single template by ID.

GET
/templates/{id}

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Path Parameters

idRequiredstring

Template ID

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

OK

{
  "backupDestinationIds": [
    "string"
  ],
  "backupSchedulePreset": "string",
  "category": "string",
  "createdAt": "string",
  "defaultAddonsPath": "string",
  "defaultEnvVars": {
    "property1": "string",
    "property2": "string"
  },
  "defaultWorkers": 0,
  "description": "string",
  "gitRepoUrl": "string",
  "id": "string",
  "isMarketplace": true,
  "isPublic": true,
  "moduleList": [
    "string"
  ],
  "name": "string",
  "odooConfOverrides": {
    "property1": "string",
    "property2": "string"
  },
  "odooEdition": "string",
  "odooVersion": "string",
  "organizationId": "string",
  "updatedAt": "string",
  "usageCount": 0
}

Delete template

Deletes a template.

DELETE
/templates/{id}

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Path Parameters

idRequiredstring

Template ID

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

No Content

Update template

Updates an existing template configuration.

PUT
/templates/{id}

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Request Body

application/jsonRequired

Template update request

namestring

Path Parameters

idRequiredstring

Template ID

curl -X PUT "//api.ocore.dev/api/templates/<string>" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string"
  }'

OK

{
  "backupDestinationIds": [
    "string"
  ],
  "backupSchedulePreset": "string",
  "category": "string",
  "createdAt": "string",
  "defaultAddonsPath": "string",
  "defaultEnvVars": {
    "property1": "string",
    "property2": "string"
  },
  "defaultWorkers": 0,
  "description": "string",
  "gitRepoUrl": "string",
  "id": "string",
  "isMarketplace": true,
  "isPublic": true,
  "moduleList": [
    "string"
  ],
  "name": "string",
  "odooConfOverrides": {
    "property1": "string",
    "property2": "string"
  },
  "odooEdition": "string",
  "odooVersion": "string",
  "organizationId": "string",
  "updatedAt": "string",
  "usageCount": 0
}

Provision from template

Enqueues an async job to provision an instance from a template.

POST
/templates/{id}/provision

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Request Body

application/jsonRequired

Provision request

overridesobject
serverIdstring

Path Parameters

idRequiredstring

Template ID

curl -X POST "//api.ocore.dev/api/templates/<string>/provision" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "overrides": {},
    "serverId": "string"
  }'

Accepted

{
  "message": "string",
  "status": "string"
}

Was this page helpful?
Edit on GitHub

Database Import/ Export

Previous Page

O C A

Next Page