Ā Admin API: Environment configuration updates

This endpoint allows you to partially update the environment definition, such as updating the responses or adding headers without restarting the mock server or the application.

Ā Update the environment configuration

To update the environment configuration, call the /mockoon-admin/environment endpoint with the following parameters:

  • Method: PUT
  • URL: /mockoon-admin/environment
  • Body: JSON object following the environment schema.

Example request:

Copy
PUT /mockoon-admin/environment
Content-Type: application/json

{
  "uuid": "7417c190-8547-442d-aab0-b61f2c3ee381",
  "name": "API mock",
  "routes": [
    {
      "uuid": "ba616755-e6cb-4aec-9b59-2643c347552b",
      "type": "http",
      "method": "get",
      "endpoint": "test",
      "responses": [
        {
          "uuid": "a9ec0e58-94f9-405a-b802-60005c020dd0",
          "body": "hello123",
          ...
        }
      ],
      ...
    }
  ]
}

āš ļø This endpoint only allows you to partially update the environment configuration without restarting the mock.

What will be updated:

  • Some environment properties (headers, proxy headers, latency, etc.).
  • Some route properties (response mode).
  • Adding and removing callbacks.
  • Route responses (headers, latency, status code, callbacks calls, rules, etc.).

What cannot be updated:

  • Route paths and methods.
  • Adding or removing routes.
  • Environment port, hostname, proxy and TLS options.
  • Adding or removing data buckets.