--- title: Clearing & Resetting description: Clear or reset MockServer state selectively by type (expectations, logs, or all) or by request matcher, with curl, Java, and JavaScript examples. layout: page pageOrder: 4 section: 'General' subsection: true sitemap: priority: 0.7 changefreq: 'monthly' lastmod: 2019-11-10T08:00:00+01:00 ---
MockServer has the following internal state:
State can be cleared from MockServer selectively:
How clearing works: when logLevel is INFO or lower (the default), cleared log entries are soft-deleted rather than physically removed. This means:
If you want cleared log entries to be physically removed from memory, set the log level to WARN or higher.
new MockServerClient("localhost", 1080).clear(
request(),
ClearType.LOG
);
var mockServerClient = require('mockserver-client').mockServerClient;
mockServerClient("localhost", 1080)
.clear({}, 'LOG')
.then(
function () {
console.log("cleared recorded requests and logs that matches request matcher");
},
function (error) {
console.log(error);
}
);
See REST API for full JSON specification
curl -v -X PUT "http://localhost:1080/mockserver/clear?type=log"
See REST API for full JSON specification
new MockServerClient("localhost", 1080).clear(
request()
.withPath("/some/path")
);
var mockServerClient = require('mockserver-client').mockServerClient;
mockServerClient("localhost", 1080)
.clear({
'path': '/some/path'
})
.then(
function () {
console.log("cleared state that matches request matcher");
},
function (error) {
console.log(error);
}
);
See REST API for full JSON specification
curl -v -X PUT "http://localhost:1080/mockserver/clear" -d '{
"path": "/some/path"
}'
See REST API for full JSON specification
new MockServerClient("localhost", 1080).clear(
openAPI(
"https://raw.githubusercontent.com/mock-server/mockserver-monorepo/master/mockserver/mockserver-integration-testing/src/main/resources/org/mockserver/openapi/openapi_petstore_example.json",
"showPetById"
)
);
var mockServerClient = require('mockserver-client').mockServerClient;
mockServerClient("localhost", 1080)
.clear({
"specUrlOrPayload": "https://raw.githubusercontent.com/mock-server/mockserver-monorepo/master/mockserver/mockserver-integration-testing/src/main/resources/org/mockserver/openapi/openapi_petstore_example.json",
"operationId": "showPetById"
})
.then(
function () {
console.log("cleared state that matches request matcher");
},
function (error) {
console.log(error);
}
);
See REST API for full JSON specification
curl -v -X PUT "http://localhost:1080/mockserver/clear" -d '{
"specUrlOrPayload": "https://raw.githubusercontent.com/mock-server/mockserver-monorepo/master/mockserver/mockserver-integration-testing/src/main/resources/org/mockserver/openapi/openapi_petstore_example.json",
"operationId": "showPetById"
}'
See REST API for full JSON specification
new MockServerClient("localhost", 1080)
.clear("31e4ca35-66c6-4645-afeb-6e66c4ca0559");
var mockServerClient = require('mockserver-client').mockServerClient;
mockServerClient("localhost", 1080)
.clearById("31e4ca35-66c6-4645-afeb-6e66c4ca0559")
.then(
function () {
console.log("cleared state that matches expectation id");
},
function (error) {
console.log(error);
}
);
See REST API for full JSON specification
curl -X PUT "http://localhost:1080/mockserver/clear" -d '{
"id": "31e4ca35-66c6-4645-afeb-6e66c4ca0559"
}'
See REST API for full JSON specification
new MockServerClient("localhost", 1080).clear(
request()
.withPath("/some/path"),
ClearType.LOG
);
var mockServerClient = require('mockserver-client').mockServerClient;
mockServerClient("localhost", 1080)
.clear({
'path': '/some/path'
}, 'LOG')
.then(
function () {
console.log("cleared recorded requests and logs that matches request matcher");
},
function (error) {
console.log(error);
}
);
See REST API for full JSON specification
curl -v -X PUT "http://localhost:1080/mockserver/clear?type=log" -d '{
"path": "/some/path"
}'
See REST API for full JSON specification
new MockServerClient("localhost", 1080).clear(
openAPI(
"https://raw.githubusercontent.com/mock-server/mockserver-monorepo/master/mockserver/mockserver-integration-testing/src/main/resources/org/mockserver/openapi/openapi_petstore_example.json",
"showPetById"
),
ClearType.LOG
);
var mockServerClient = require('mockserver-client').mockServerClient;
mockServerClient("localhost", 1080)
.clear({
"specUrlOrPayload": "https://raw.githubusercontent.com/mock-server/mockserver-monorepo/master/mockserver/mockserver-integration-testing/src/main/resources/org/mockserver/openapi/openapi_petstore_example.json",
"operationId": "showPetById"
}, 'LOG')
.then(
function () {
console.log("cleared state that matches request matcher");
},
function (error) {
console.log(error);
}
);
See REST API for full JSON specification
curl -v -X PUT "http://localhost:1080/mockserver/clear?type=log" -d '{
"specUrlOrPayload": "https://raw.githubusercontent.com/mock-server/mockserver-monorepo/master/mockserver/mockserver-integration-testing/src/main/resources/org/mockserver/openapi/openapi_petstore_example.json",
"operationId": "showPetById"
}'
See REST API for full JSON specification
new MockServerClient("localhost", 1080).clear(
request()
.withPath("/some/path"),
ClearType.EXPECTATIONS
);
var mockServerClient = require('mockserver-client').mockServerClient;
mockServerClient("localhost", 1080)
.clear({
'path': '/some/path'
}, 'EXPECTATIONS')
.then(
function () {
console.log("cleared expectations that matches request matcher");
},
function (error) {
console.log(error);
}
);
See REST API for full JSON specification
curl -v -X PUT "http://localhost:1080/mockserver/clear?type=expectations" -d '{
"path": "/some/path"
}'
See REST API for full JSON specification
MockServer can be reset completely, as follows:
new MockServerClient("localhost", 1080).reset();
var mockServerClient = require('mockserver-client').mockServerClient;
mockServerClient("localhost", 1080)
.reset()
.then(
function () {
console.log("reset all state");
},
function (error) {
console.log(error);
}
);
See REST API for full JSON specification
curl -v -X PUT "http://localhost:1080/mockserver/reset"
See REST API for full JSON specification