Mockoon

https://mockoon.com/docs/
Admin
Mockoon is a desktop application, CLI, and serverless package for quickly creating and managing mock...
Tokens:88,100
Snippets:701
Trust Score:9.9
Update:2 days ago
Show doc for...
Tokens:
Raw
### Example response for GET environment variable

Source: https://mockoon.com/docs/latest/admin-api/environment-variables/

Shows the JSON response returned by the GET request, containing the key and value of the environment variable.

```json
{
  "key": "MOCKOON_ENV_VAR",
  "value": "variableValue"
}
```

--------------------------------

### padStart helper example

Source: https://mockoon.com/docs/latest/templating/mockoon-helpers/

Pads the string from the start with the given padding character (default space) until the specified length is reached. The example pads '5' to length 5 with '0', resulting in '00005'.

```handlebars
{{padStart '5' 5 '0'}}

result: 00005
```

--------------------------------

### Request and response for body templating example

Source: https://mockoon.com/docs/latest/templating/overview/

Shows the request and the resulting response for the body templating example above. The request includes a GET to /user/123456?name=john with Accept-Language header, and the response demonstrates the templated output.

```http
GET /user/123456?name=john
Accept-Language: fr-FR,fr;q=0.9,en-US;q=0.8,en;q=0.7

{
  "element": [
    {"title": "My title"}
  ]
}
```

```json
{
  "userId": "5",
  "name": "john",
  "lang": "fr-FR,fr;q=0.9,en-US;q=0.8,en;q=0.7",
  "elementTitle": "My title",
  "ip": "::1",
  "method": "GET",
  "hostname": "localhost",
  "friends": [
    {
      "id": 0,
      "name": "Stephen Bradbury"
    },
    {
      "id": 1,
      "name": "Warren Caffey"
    }
  ],
  "oneItem": "item1",
  "someItemsAsString": "item2",
  "someItemsAsArray": ["item2", "item3"],
  "userName": "John"
}
```

--------------------------------

### uuid and guid helper examples

Source: https://mockoon.com/docs/latest/templating/mockoon-helpers/

Returns a random UUID. Alias of faker 'string.uuid'. Both {{uuid}} and {{guid}} are shown as examples.

```handlebars
{{uuid}}
{{guid}}
```

--------------------------------

### Get local variables with getVar helper and @ prefix

Source: https://mockoon.com/docs/latest/variables/local-variables/

Examples of retrieving local variables using the @ prefix or the getVar helper, including dynamic parameter usage.

```handlebars
# Set a variable
{{setVar 'varname' 'value'}}

# Get a variable
{{@varname}}
{{getVar 'varname'}}
{{getVar (body 'property')}}
```

--------------------------------

### object helper examples

Source: https://mockoon.com/docs/latest/templating/mockoon-helpers/

Examples of creating objects with the object helper using key=value notation. The helper can include nested helpers like array and filter, and the result is shown as a comment after each example.

```handlebars
{{{object type='item1'}}}
result: {type: 'item1'}

{{{object type='item1' category='cat1'}}}
result: {type: 'item1', category: 'cat1'}

{{{object type=(array 1 2 3)}}}
result: {type: [1,2,3]}

{{{object type=(array 1 2 3)}}}
result: {type: [1,2,3]}

{{{object type=(filter (array 1 2 3) 1 3)}}}
result: {type: [1,3]}
```

--------------------------------

### indexOf helper example

Source: https://mockoon.com/docs/latest/templating/mockoon-helpers/

Returns the index of the searched data within the string. The optional third argument sets the starting index (default 0). The example shows the result 5.

```handlebars
{{indexOf 'Some data' 'data' 0}}

result: 5
```

--------------------------------

### substr helper example

Source: https://mockoon.com/docs/latest/templating/mockoon-helpers/

Returns a portion of a string starting at the specified index and extending for a given number of characters. Example shows result: 'data'.

```handlebars
{{substr 'Some data' 5 4}}

result: 'data'
```

--------------------------------

### Pagination examples

Source: https://mockoon.com/docs/latest/api-endpoints/crud-routes/

Use `page` and `limit` query parameters. `limit` defaults to 10 if omitted; `page` defaults to first items. Examples show second set of 25, first 50, and second set of 10.

```http
GET /path?page=2&limit=25
```

```http
GET /path?limit=50
```

```http
GET /path?page=2
```

--------------------------------

### Transaction logs response example

Source: https://mockoon.com/docs/latest/admin-api/transaction-logs/

Example JSON response from the GET /mockoon-admin/logs endpoint. Sensitive headers are redacted, but auth scheme is preserved. Bodies are not modified.

```json
[
  {
    "request": {
      "method": "get",
      "urlPath": "/users/5",
      "route": "/users/:id",
      "params": [
        {
          "name": "id",
          "value": "5"
        }
      ],
      "query": "",
      "queryParams": {},
      "body": "",
      "headers": [
        { "key": "host", "value": "localhost:3000" },
        { "key": "Authorization", "value": "Bearer [REDACTED]" }
      ]
    },
    "response": {
      "statusCode": 200,
      "statusMessage": "OK",
      "headers": [{ "key": "content-type", "value": "application/json; charset=utf-8" }],
      "body": "ok"
    },
    "routeResponseUUID": "c0a61351-c542-4d80-902d-4305047aff17",
    "routeUUID": "7e950e12-dc21-425a-930c-e84a381281ee",
    "proxied": false,
    "timestampMs": 1714399178682
  }
]
```

--------------------------------

### Get a global variable value - Example response

Source: https://mockoon.com/docs/latest/admin-api/global-variables/

Example JSON response returned when fetching a global variable. Contains the variable key and its current value.

```json
{
  "key": "my_var",
  "value": "variableValue"
}
```

--------------------------------

### now helper example

Source: https://mockoon.com/docs/latest/templating/mockoon-helpers/

Displays the current time in the specified format. The format syntax is based on date-fns v4 format function and is optional (defaults to ISO string). The example uses the format 'yyyy-MM-DD'.

```handlebars
{{now 'yyyy-MM-DD'}}
```

--------------------------------

### base64 helper examples

Source: https://mockoon.com/docs/latest/templating/mockoon-helpers/

Encodes a value as base64. Can be used inline or as a block helper. The inline example encodes 'test'. The block example encodes a generated CSV-like content with repeated faker data.

```handlebars
{{base64 'test'}}

{{#base64}}
  firstname,lastname,countryCode
  {{#repeat 10}}
    {{faker 'person.firstName'}},{{faker 'person.lastName'}},{{faker 'address.countryCode'}}
  {{/repeat}}
{{/base64}}
```

--------------------------------

### add helper examples

Source: https://mockoon.com/docs/latest/templating/mockoon-helpers/

Shows how to use the add helper to add numbers passed as parameters. Unrecognized strings are ignored. The examples demonstrate adding numbers, numeric strings, and a mix with an ignored string.

```handlebars
{{add 1 1}}
result: '2'

{{add '1' '1'}}
result: '2'

{{add '1' 'foo' 1}}
result: '2'
```

--------------------------------

### padEnd helper example

Source: https://mockoon.com/docs/latest/templating/mockoon-helpers/

Pads the string from the end with the given padding character (default space) until the specified length is reached. The example pads '5' to length 5 with '0', resulting in '50000'.

```handlebars
{{padEnd '5' 5 '0'}}

result: 50000
```

--------------------------------

### Retrieve transaction logs - GET requests

Source: https://mockoon.com/docs/latest/admin-api/transaction-logs/

Example requests to retrieve transaction logs. Supports optional 'page' and 'limit' query parameters with defaults of 1 and 10 respectively.

```http
GET /mockoon-admin/logs
GET /mockoon-admin/logs?page=2
GET /mockoon-admin/logs?page=2&limit=20
```

--------------------------------

### lowercase helper example

Source: https://mockoon.com/docs/latest/templating/mockoon-helpers/

Returns the first string parameter lowercased. The example shows input 'ABCD' producing 'abcd'.

```handlebars
{{lowercase 'ABCD'}}

result: 'abcd'
```

--------------------------------

### uppercase helper example

Source: https://mockoon.com/docs/latest/templating/mockoon-helpers/

Returns the first string parameter uppercased. The example shows input 'abcd' producing 'ABCD'.

```handlebars
{{uppercase 'abcd'}}

result: 'ABCD'
```

--------------------------------

### Start CLI with admin API token

Source: https://mockoon.com/docs/latest/admin-api/overview/

Use the --admin-api-token flag to provide a custom token for the admin API when starting the mock server with the CLI. The token can also be set via the MOCKOON_ADMIN_API_TOKEN environment variable.

```bash
mockoon-cli start --admin-api-token mytoken -d ./mock.json
```

--------------------------------

### queryParamRaw usage examples

Source: https://mockoon.com/docs/latest/templating/mockoon-request-helpers/

Shows various ways to use the queryParamRaw helper: without a path to get the full query string, with object-path and JSONPath syntax, with a default value, and inside each and if helpers.

```handlebars
{{queryParamRaw}}

<!-- Using object-path syntax -->
{{queryParamRaw 'path.to.property'}}
{{queryParamRaw 'deep.property\.with\.dot'}}

<!-- using JSONPath syntax -->
{{queryParamRaw '$.array.[*].property'}}

{{queryParamRaw 'path' 'default value'}}

{{#each (queryParamRaw 'path.to.array.query' 'default value')}}
  value
{{/each}}

{{#if (queryParamRaw 'path.to.boolean.query' 'default value')}}
  value
{{/if}}
```

--------------------------------

### modulo helper examples

Source: https://mockoon.com/docs/latest/templating/mockoon-helpers/

Computes the modulo of the first parameter by the second. Unrecognized strings are ignored. Examples show numeric, string, and mixed arguments.

```handlebars
{{modulo 5 4}}
result: '1'

{{modulo '5' '4'}}
result: '1'

{{modulo '5' 'foo' 4}}
result: '1'
```

--------------------------------

### objectPath helper examples

Source: https://mockoon.com/docs/latest/templating/mockoon-helpers/

Examples of using the objectPath helper to retrieve values from objects, including nested objects and arrays, with an optional default value.

```handlebars
{{objectPath (object key1='value1' key2='value2') 'key1'}}

{{objectPath (bodyRaw) 'key2'}}

{{objectPath (dataRaw 'Users') '0.name' 'defaultName'}}
```

--------------------------------

### sortBy helper examples

Source: https://mockoon.com/docs/latest/templating/mockoon-helpers/

Shows how to use the sortBy helper to sort an array of objects by a given key, with optional sort order. The first example sorts by 'key1' in ascending order (default). The second example sorts a data bucket 'Users' by 'name' in descending order.

```handlebars
{{sortBy (array (object key1=10 key2=20) (object key1=30 key2=30) (object key1=15 key2=25)) 'key1'}}
result: [{"key2": 20, "key1": 10}, {"key2": 25, "key1": 15}, {"key2": 30, "key1": 30}]

{{sortBy (dataRaw 'Users') 'name' 'desc'}}
```

--------------------------------

### jsonPath helper examples

Source: https://mockoon.com/docs/latest/templating/mockoon-helpers/

Examples of using the jsonPath helper to retrieve values from JSON objects using JSONPath Plus syntax, with an optional default value.

```handlebars
{{jsonPath (object key1='value1' key2='value2') '$.key1'}}

{{jsonPath (bodyRaw) '$.key2'}}

{{jsonPath (dataRaw 'Users') '$[0].name' 'defaultName'}}
```

--------------------------------

### divide helper examples

Source: https://mockoon.com/docs/latest/templating/mockoon-helpers/

Divides the first parameter by the other numbers passed as parameters. Unrecognized strings are ignored. Examples show numeric, string, and mixed arguments.

```handlebars
{{divide 4 2}}
result: '2'

{{divide '4' '2'}}
result: '2'

{{divide '4' 'foo' 2}}
result: '2'
```

--------------------------------

### Example URL with query parameters

Source: https://mockoon.com/docs/latest/requests/query-parameters/

Shows a URL with query parameters including arrays and nested objects, plus alternative array syntaxes. The URL is used to demonstrate how Mockoon parses query strings.

```text
http://localhost:3000/route?param1=test&param2=test2&array[]=value1&array[]=value2&obj[prop1]=value

// alternative array syntaxes
array[0]=value1&array[1]=value2
array=value1,value2
```

--------------------------------

### Filter with regex patterns for like, start, end

Source: https://mockoon.com/docs/latest/api-endpoints/crud-routes/

The `like`, `start`, and `end` operators support regex patterns. Examples show matching names starting with 'john' and IDs matching a set of numbers.

```http
GET /path?user.name_like=^john
```

```http
GET /path?user.id_like=^(123|456|789)$
```

--------------------------------

### PUT /mockoon-admin/environment request example

Source: https://mockoon.com/docs/latest/admin-api/environment-configuration-update/

Example HTTP request to fully update the environment configuration. The body must include the complete environment configuration; no merging is performed. Since version 9.6.0, most options apply immediately, but server port, hostname, and TLS options require a restart.

```http
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",
          ...
        }
      ],
      ...
    }
  ]
}
```

--------------------------------

### padStart

Source: https://mockoon.com/docs/latest/templating/mockoon-helpers/

Pads a string with a given string (repeated, if needed) until the resulting string reaches the given length. The padding is applied from the start of the string.

```APIDOC
## padStart

### Description
Pads a string with a given string (repeated, if needed) until the resulting string reaches the given length. The padding is applied from the start of the string.

### Arguments
| Argument | Type | Description |
| --- | --- | --- |
| 0 | string | String to pad |
| 1 | number | pad length |
| [2 = ' '] | string | Padding character(s) (default to blank space) |

### Example
```
{{padStart '5' 5 '0'}}

result: 00005
```
```

--------------------------------

### Get a global variable value - Example request

Source: https://mockoon.com/docs/latest/admin-api/global-variables/

HTTP GET request to retrieve the value of a global variable. The variable name is specified in the URL path as :key.

```http
GET /mockoon-admin/global-vars/my_var
```

--------------------------------

### Get data buckets status - response

Source: https://mockoon.com/docs/latest/admin-api/data-buckets/

Example JSON response from the GET /mockoon-admin/data-buckets endpoint, showing an array of objects with id, name, parsed, and validJson fields.

```json
[
  {
    "id": "jb18",
    "name": "data 1",
    "parsed": true,
    "validJson": true
  },
  {
    "id": "fhcj",
    "name": "data 2",
    "parsed": true,
    "validJson": false
  }
]
```

--------------------------------

### lorem helper example with argument

Source: https://mockoon.com/docs/latest/templating/mockoon-helpers/

Returns random lorem ipsum text. Alias of faker 'lorem.sentence'. Accepts an optional argument for the number of words.

```handlebars
{{lorem 50}}
```

--------------------------------

### Get a data bucket value - response

Source: https://mockoon.com/docs/latest/admin-api/data-buckets/

Example JSON response from the GET /mockoon-admin/data-buckets/:nameOrId endpoint, containing the data bucket's name, id, and value as a JSON object.

```json
{
  "name": "myData",
  "id": "abcd",
  "value": { "property": "value" }
}
```

--------------------------------

### slice helper example

Source: https://mockoon.com/docs/latest/templating/mockoon-helpers/

The slice helper returns a copy of a portion of an array from start index (inclusive) to end index (exclusive). The example slices from index 0 to 2, returning the first two items.

```handlebars
{{slice (array 'item1' 'item2' 'item3') 0 2}}
result: ['item1', 'item2']
```

--------------------------------

### ipv4 helper example

Source: https://mockoon.com/docs/latest/templating/mockoon-helpers/

Returns a random IP v4. Alias of faker 'internet.ipv4'.

```handlebars
{{ipv4}}
```

--------------------------------

### body helper examples

Source: https://mockoon.com/docs/latest/templating/mockoon-request-helpers/

Shows how to use the body helper to retrieve values from the request body. Supports object-path and JSONPath syntaxes, default values, and a stringify option.

```handlebars
{{body}}

<!-- Using object-path syntax -->
{{body 'path.to.property'}}
{{body 'deep.property\.with\.dot'}}

<!-- using JSONPath syntax -->
{{body '$.array.[*].property'}}

{{body 'path' 'default value'}}
{{body 'path' 'default value' true}}
```

--------------------------------

### Example URL-encoded body

Source: https://mockoon.com/docs/latest/requests/supported-body-formats/

A sample URL-encoded body demonstrating nested arrays and alternative array syntaxes supported by the qs parser.

```text
key1=value1&key2=value2&array[]=value1&array[]=value2

// alternative array syntaxes
array[0]=value1&array[1]=value2
array=value1,value2
```

--------------------------------

### time helper example

Source: https://mockoon.com/docs/latest/templating/mockoon-helpers/

Returns a random formatted time between the given starting and ending times. Uses faker 'date.between' to generate the random time. The format string is passed to date-fns v4 format function.

```handlebars
{{time '09:00' '10:00' 'HH:mm'}}
```

--------------------------------

### jsonParse helper usage examples

Source: https://mockoon.com/docs/latest/templating/mockoon-helpers/

Shows how to use jsonParse to parse JSON strings and use the result with helpers like if, eq, oneOf, lookup, and queryParam. Includes a comment about calling with a query string.

```handlebars
{{#if (jsonParse 'true')}}
  value
{{/if}}

{{#if (eq (jsonParse '25') 25)}}
  value
{{/if}}

{{oneOf (jsonParse '[5, 56, 98]')}}
result: 5 or 56 or 98

{{lookup (jsonParse '{"data":"test"}') 'data'}}
result: test

<!-- Calling with a query string: ?json={"data":"test"} -->
{{lookup (jsonParse (queryParam 'json')) 'data'}}
result: test
```

--------------------------------

### date helper example

Source: https://mockoon.com/docs/latest/templating/mockoon-helpers/

Returns a random formatted date between the given starting and ending dates. Uses faker 'date.between' to generate the random date. The format string is passed to date-fns v4 format function.

```handlebars
{{date '2020-11-20' '2020-11-25' "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'"}}
```

--------------------------------

### find helper usage examples

Source: https://mockoon.com/docs/latest/templating/mockoon-helpers/

Shows practical usage of the find helper with arrays, data buckets, and mixed data types.

```handlebars
<!-- Simple OR find -->
{{find (array 1 2 3) 1 3}}
result: 1

<!-- Simple OR find -->
{{find (array 'item1' 'item2' 'item3' 'item4' 'item3') 'item1' 'item2' 'item3'}}
result: item1

<!-- Data bucket get first user with type='item1' -->
{{find (dataRaw 'Users') (object type='item1')}}

<!-- Data bucket get first user with type='item1' OR type='item2' OR type='item3' -->
{{find (dataRaw 'Users') (object type='item1') (object type='item2') (object type='item3')}}

<!-- Data bucket get first user with type='item1' AND category='some-category' -->
{{find (dataRaw 'Users') (object type='item1' category='some-category')}}

<!-- Data bucket get first user with type='item1' OR category='some-category' -->
{{find (dataRaw 'Users') (array (object type='item1') (object category='some-category'))}}

<!-- Mixed data find -->
{{find (array 'item1' 'item2' (object type='type1') (object type='type2')) 'item1' (object type='type2')}}
```

--------------------------------

### method

Source: https://mockoon.com/docs/latest/templating/mockoon-request-helpers/

Gets the HTTP method of the request (e.g., GET, POST).

```APIDOC
## method

### Description
Gets the HTTP method of the request (e.g., GET, POST).

### Examples
```
{{method}}
```
```

--------------------------------

### GET /mockoon-admin/data-buckets

Source: https://mockoon.com/docs/latest/admin-api/data-buckets/

Get the status of all data buckets without their values.

```APIDOC
## GET /mockoon-admin/data-buckets

### Description
Get the status of all data buckets (without their values).

### Method
GET

### Endpoint
/mockoon-admin/data-buckets

### Request Example
GET /mockoon-admin/data-buckets

### Response
#### Success Response (200)
- **id** (string) - The unique id of the data bucket.
- **name** (string) - The name of the data bucket.
- **parsed** (boolean) - Whether the data bucket was parsed.
- **validJson** (boolean) - Whether the data bucket contains valid JSON.

#### Response Example
[
  {
    "id": "jb18",
    "name": "data 1",
    "parsed": true,
    "validJson": true
  },
  {
    "id": "fhcj",
    "name": "data 2",
    "parsed": true,
    "validJson": false
  }
]
```

--------------------------------

### Body templating example with helpers

Source: https://mockoon.com/docs/latest/templating/overview/

Shows a JSON body using various templating helpers: urlParam, queryParam, header, body, ip, method, hostname, repeat, faker, oneOf, someOf, and switch. The template produces a response based on the request.

```handlebars
{
  "userId": "{{urlParam 'id'}}",
  "name": "{{queryParam 'name' 'John'}}",
  "lang": "{{{header 'Accept-Language' 'en'}}}",
  "elementTitle": "{{body 'elements.0.title' 'default'}}",
  "ip": "{{ip}}",
  "method": "{{method}}",
  "hostname": "{{hostname}}",
  "friends": [
    {{#repeat 2}}
    { 
      "id": {{@index}}, 
      "name": "{{faker 'person.firstName'}} {{faker 'person.lastName'}}" 
    }
    {{/repeat}}
  ], 
  "oneItem": "{{oneOf (array 'item1' 'item2' 'item3')}}", 
  "someItemsAsString": "{{someOf (array 'item1' 'item2' 'item3') 1 2}}", 
  "someItemsAsArray": {{{someOf (array 'item1' 'item2' 'item3') 1 2 true}}}, 
  "userName": 
    {{#switch (urlParam 'id')}}
      {{#case '1'}}"John"{{/case}}
      {{#case '2'}}"Jack"{{/case}}
      {{#default}}"Peter"{{/default}}
    {{/switch}}
}
```

--------------------------------

### find helper structure examples

Source: https://mockoon.com/docs/latest/templating/mockoon-helpers/

Shows the structure of the find helper for object keys, nested object keys, OR matching, AND matching, and combined OR/AND conditions.

```handlebars
<!-- find by object keys -->
{{ find (array (object key='value1') (object key='value2')) (object key='value1') }}
<!-- find by nested object keys -->
{{ find (array (object key=(object prop='value1')) (object key=(object prop='value2'))) (object key=(object prop='value1')) }}

<!-- OR matching structure -->
{{ find (array 1 2 3 ... ) condition1 condition2 ... }}
result: find item matching condition1 OR condition2

<!-- AND matching structure -->
{{ find (array x y z) (array condition1 condition2) }}
result: find item matching condition1 AND condition2

<!-- OR and AND conditions -->
{{ find (array x y z) (array a1 a2 a3) (array b1 b2 b3) (array c1 c2 c3) }}
result: find item matching (a1 AND a2 AND a3) OR (b1 AND b2 AND b3) OR (c1 AND c2 AND c3)
```

--------------------------------

### Get request method

Source: https://mockoon.com/docs/latest/templating/mockoon-request-helpers/

Returns the request method (GET, PUT, POST, etc.).

```handlebars
{{method}}
```

--------------------------------

### File input templating with urlParam

Source: https://mockoon.com/docs/latest/templating/overview/

Shows how to use templating in the file input field to dynamically serve files based on request parameters. The example uses a route param :id and the urlParam helper.

```plaintext
c:/.../file{{urlParam 'id'}}.json
```

--------------------------------

### bodyRaw helper usage examples

Source: https://mockoon.com/docs/latest/templating/mockoon-request-helpers/

Shows how to use the bodyRaw helper to fetch raw body values, including object-path and JSONPath syntaxes, default values, and usage within each and if helpers.

```handlebars
{{bodyRaw}}

<!-- Using object-path syntax -->
{{bodyRaw 'path.to.property'}}
{{bodyRaw 'deep.property\.with\.dot'}}

<!-- using JSONPath syntax -->
{{bodyRaw '$.array.[*].property'}}

{{bodyRaw 'path' 'default value'}}

{{#each (bodyRaw 'path.to.array.property' 'default value')}}
  value
{{/each}}

{{#if (bodyRaw 'path.to.boolean.property' 'default value')}}
  value
{{/if}}
```

--------------------------------

### GET /mockoon-admin/data-buckets/:nameOrId

Source: https://mockoon.com/docs/latest/admin-api/data-buckets/

Get the value of a specific data bucket by name or id.

```APIDOC
## GET /mockoon-admin/data-buckets/:nameOrId

### Description
Get the value of a data bucket. The value is returned as a JSON object in the `value` property.

### Method
GET

### Endpoint
/mockoon-admin/data-buckets/:nameOrId

### Parameters
#### Path Parameters
- **nameOrId** (string) - Required - The name or unique id of the data bucket.

### Request Example
GET /mockoon-admin/data-buckets/myData

### Response
#### Success Response (200)
- **name** (string) - The name of the data bucket.
- **id** (string) - The unique id of the data bucket.
- **value** (object) - The value of the data bucket as a JSON object.

#### Response Example
{
  "name": "myData",
  "id": "abcd",
  "value": { "property": "value" }
}
```

--------------------------------

### objectMerge helper examples

Source: https://mockoon.com/docs/latest/templating/mockoon-helpers/

Examples of merging two objects with the objectMerge helper. The second object's properties overwrite the first's on key conflicts. The second example shows adding an id to the request's body.

```handlebars
{{objectMerge (object key1='value1') (object key2='value2')}}
<!-- result: {key1: 'value1', key2: 'value2'} -->

<!-- Adding an id to the request's body -->
{{objectMerge (object id=uuid) (bodyRaw)}}
```

--------------------------------

### switch helper example

Source: https://mockoon.com/docs/latest/templating/mockoon-helpers/

Selects content based on a variable, behaving like a regular switch. The first argument is the value to match against the cases.

```handlebars
{{#switch (urlParam 'id')}}
  {{#case '1'}}"John"{{/case}}
  {{#case '2'}}"Jack"{{/case}}
  {{#default}}"Peter"{{/default}}
{{/switch}}
```

--------------------------------

### Data buckets processed event example

Source: https://mockoon.com/docs/latest/admin-api/events/

Example of a data-bucket-processed event containing an array of data bucket statuses.

```json
{
  "event": "data-bucket-processed",
  "dataBuckets": [
    { "uuid": "3b95903c-4291-4cee-bcf3-824e6793b8a7", "id": "jb18", "name": "data 1", "parsed": true, "validJson": true },
    { "uuid": "7b5ad631-1936-4b37-9334-2bad9fb97c88", "id": "fhcj", "name": "data 2", "parsed": true, "validJson": true }
  ]
}
```

--------------------------------

### queryParam helper examples

Source: https://mockoon.com/docs/latest/templating/mockoon-request-helpers/

Shows usage of the queryParam helper: retrieving the full query string, using object-path and JSONPath syntax, handling escaped dots, and providing default values with optional stringification.

```handlebars
{{queryParam}}

<!-- Using object-path syntax -->
{{queryParam 'path.to.property'}}
{{queryParam 'deep.property\.with\.dot'}}

<!-- using JSONPath syntax -->
{{queryParam '$.array.[*].property'}}

{{queryParam 'path' 'default value'}}
{{queryParam 'path' 'default value' true}}
```

--------------------------------

### Transaction complete event example

Source: https://mockoon.com/docs/latest/admin-api/events/

Example of a transaction-complete event containing transaction data with request and response details.

```json
{
  "event": "transaction-complete",
  "transaction": {
    "request": {
      "method": "get",
      "urlPath": "/test",
      "route": "/test",
      "params": [],
      "query": "",
      "queryParams": {},
      "body": "",
      "headers": [
        { "key": "accept", "value": "*/*" },
        { "key": "accept-encoding", "value": "gzip, br, deflate" },
        { "key": "Authorization", "value": "Bearer [REDACTED]" }
      ]
    },
    "response": {
      "statusCode": 200,
      "statusMessage": "OK",
      "headers": [{ "key": "content-type", "value": "application/json; charset=utf-8" }],
      "body": ""
    },
    "routeResponseUUID": "24571b2f-25ce-4107-9bc7-e24913d21fc4",
    "routeUUID": "1803af89-c34c-45ac-a019-e856f137e3b2",
    "proxied": false,
    "timestampMs": 1741706443013
  }
}
```

--------------------------------

### replaceAll helper example

Source: https://mockoon.com/docs/latest/templating/mockoon-helpers/

Replaces all occurrences of a search string with a replacement string. Returns an empty string if fewer than three arguments are provided or if any argument is not a string. If the search string is empty, the original input is returned.

```handlebars
{{replaceAll 'hello world world' 'world' 'Mockoon'}}

result: hello Mockoon Mockoon
```

--------------------------------

### ipv6 helper example

Source: https://mockoon.com/docs/latest/templating/mockoon-helpers/

Returns a random IP v6. Alias of faker 'internet.ipv6'.

```handlebars
{{ipv6}}
```

--------------------------------

### includes helper example

Source: https://mockoon.com/docs/latest/templating/mockoon-helpers/

Searches whether a string can be found in another string and returns a boolean. Example shows result: true.

```handlebars
{{includes 'Some data' 'data'}}

result: true
```

--------------------------------

### PUT /mockoon-admin/environment

Source: https://mockoon.com/docs/latest/admin-api/environment-configuration-update/

Fully updates the environment configuration. The payload must include the complete environment configuration; no merging is performed. Most configuration is applied immediately, but server port, hostname, and TLS options require a restart.

```APIDOC
## [PUT] /mockoon-admin/environment

### Description
Fully updates the environment definition without restarting the mock server or the application. The payload must include the complete environment configuration. No merging with the existing configuration will be performed.

### Method
PUT

### Endpoint
/mockoon-admin/environment

### Parameters
#### Request Body
The request body must be a JSON object following the environment schema. It includes fields such as:
- **uuid** (string) - Required - Unique identifier of the environment.
- **name** (string) - Required - Name of the environment.
- **routes** (array) - Required - List of route objects, each containing fields like uuid, type, method, endpoint, and responses.

### Request Example
```
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",
          ...
        }
      ],
      ...
    }
  ]
}
```

### Response
#### Success Response (200)
No specific response body is documented. The update is applied successfully.

### Notes
- Since version 9.6.0, most environment configuration can be updated during runtime without restarting the mock server. Updated endpoints, WebSocket servers, and proxy options are applied immediately.
- The server port, hostname, and TLS options cannot be updated during runtime and require a server restart to take effect.
```
Tokens:
Raw