oCoreoCore Docs
API Reference

Neutralization

Get re-enabled dangerous items

Returns neutralization items that have been re-enabled in dangerous categories (payment providers, carriers).

GET
/environments/{envId}/neutralization/dangerous

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Path Parameters

envIdRequiredstring

Environment ID

Format: "uuid"
curl -X GET "//api.ocore.dev/api/environments/497f6eca-6276-4993-bfeb-53cbbbba6f08/neutralization/dangerous" \
  -H "Authorization: <token>"

OK

{
  "hasDangerousReenabled": true,
  "items": [
    {
      "category": "string",
      "createdAt": "string",
      "enabledAt": "string",
      "enabledBy": "string",
      "environmentId": "string",
      "id": "string",
      "isEnabled": true,
      "odooModel": "string",
      "odooRecordId": 0,
      "recordName": "string",
      "updatedAt": "string"
    }
  ]
}

List neutralization items

Returns all neutralization items for an environment (cron jobs, mail servers, payment providers, etc.).

GET
/environments/{envId}/neutralization/items

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Path Parameters

envIdRequiredstring

Environment ID

Format: "uuid"
curl -X GET "//api.ocore.dev/api/environments/497f6eca-6276-4993-bfeb-53cbbbba6f08/neutralization/items" \
  -H "Authorization: <token>"

OK

{
  "items": [
    {
      "category": "string",
      "createdAt": "string",
      "enabledAt": "string",
      "enabledBy": "string",
      "environmentId": "string",
      "id": "string",
      "isEnabled": true,
      "odooModel": "string",
      "odooRecordId": 0,
      "recordName": "string",
      "updatedAt": "string"
    }
  ],
  "total": 0
}

Toggle neutralization item

Toggles a single neutralization item on or off by executing SQL on the environment's database. Production environments are blocked.

POST
/environments/{envId}/neutralization/items/{itemId}/toggle

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Request Body

application/jsonRequired

Toggle request

enableboolean

Path Parameters

envIdRequiredstring

Environment ID

Format: "uuid"
itemIdRequiredstring

Item ID

Format: "uuid"
curl -X POST "//api.ocore.dev/api/environments/497f6eca-6276-4993-bfeb-53cbbbba6f08/neutralization/items/497f6eca-6276-4993-bfeb-53cbbbba6f08/toggle" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "enable": true
  }'

OK

{
  "category": "string",
  "createdAt": "string",
  "enabledAt": "string",
  "enabledBy": "string",
  "environmentId": "string",
  "id": "string",
  "isEnabled": true,
  "odooModel": "string",
  "odooRecordId": 0,
  "recordName": "string",
  "updatedAt": "string"
}

Trigger manual neutralization

Enqueues a neutralization job for the environment. Only non-production environments in ready status are accepted.

POST
/environments/{envId}/neutralization/neutralize

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Request Body

application/jsonRequired

Neutralization options

confirmTextstring

Path Parameters

envIdRequiredstring

Environment ID

Format: "uuid"
curl -X POST "//api.ocore.dev/api/environments/497f6eca-6276-4993-bfeb-53cbbbba6f08/neutralization/neutralize" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "confirmText": "string"
  }'

Accepted

{
  "environmentId": "string",
  "message": "string"
}

Get neutralization summary

Returns a summary of neutralization items grouped by category with enabled/total counts.

GET
/environments/{envId}/neutralization/summary

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Path Parameters

envIdRequiredstring

Environment ID

Format: "uuid"
curl -X GET "//api.ocore.dev/api/environments/497f6eca-6276-4993-bfeb-53cbbbba6f08/neutralization/summary" \
  -H "Authorization: <token>"

OK

{
  "categories": {
    "property1": {
      "enabledItems": 0,
      "totalItems": 0
    },
    "property2": {
      "enabledItems": 0,
      "totalItems": 0
    }
  },
  "enabledItems": 0,
  "environmentId": "string",
  "isNeutralized": true,
  "totalItems": 0
}

Toggle neutralization category

Toggles all neutralization items in a category on or off for an environment. Production environments are blocked.

POST
/environments/{envId}/neutralization/toggle-category

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Request Body

application/jsonRequired

Category toggle request

categorystring
enableboolean

Path Parameters

envIdRequiredstring

Environment ID

Format: "uuid"
curl -X POST "//api.ocore.dev/api/environments/497f6eca-6276-4993-bfeb-53cbbbba6f08/neutralization/toggle-category" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "category": "string",
    "enable": true
  }'

OK

{
  "items": [
    {
      "category": "string",
      "createdAt": "string",
      "enabledAt": "string",
      "enabledBy": "string",
      "environmentId": "string",
      "id": "string",
      "isEnabled": true,
      "odooModel": "string",
      "odooRecordId": 0,
      "recordName": "string",
      "updatedAt": "string"
    }
  ],
  "total": 0
}

Get neutralization profile

Returns the neutralization profile for a project, creating one with defaults if none exists.

GET
/projects/{projectId}/neutralization/profile

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Path Parameters

projectIdRequiredstring

Project ID

Format: "uuid"
curl -X GET "//api.ocore.dev/api/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/neutralization/profile" \
  -H "Authorization: <token>"

OK

{
  "createdAt": "string",
  "id": "string",
  "mailStrategy": "string",
  "neutralizeCarriers": true,
  "neutralizeCrons": true,
  "neutralizeMail": true,
  "neutralizePayments": true,
  "neutralizeSocial": true,
  "projectId": "string",
  "updatedAt": "string"
}

Update neutralization profile

Updates the neutralization profile settings for a project (mail, crons, payments, carriers, social).

PUT
/projects/{projectId}/neutralization/profile

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Request Body

application/jsonRequired

Profile settings

mailStrategystring
neutralizeCarriersboolean
neutralizeCronsboolean
neutralizeMailboolean
neutralizePaymentsboolean
neutralizeSocialboolean

Path Parameters

projectIdRequiredstring

Project ID

Format: "uuid"
curl -X PUT "//api.ocore.dev/api/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/neutralization/profile" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "mailStrategy": "string",
    "neutralizeCarriers": true,
    "neutralizeCrons": true,
    "neutralizeMail": true,
    "neutralizePayments": true,
    "neutralizeSocial": true
  }'

OK

{
  "createdAt": "string",
  "id": "string",
  "mailStrategy": "string",
  "neutralizeCarriers": true,
  "neutralizeCrons": true,
  "neutralizeMail": true,
  "neutralizePayments": true,
  "neutralizeSocial": true,
  "projectId": "string",
  "updatedAt": "string"
}

Was this page helpful?
Edit on GitHub

O C A

Previous Page

Monitoring

Next Page