POST
/
v1
/
mock-apis
/
{mockApiId}
/
recordings
/
snapshot
curl --request POST \
  --url https://wmc.wiremockapi.cloud/v1/mock-apis/{mockApiId}/recordings/snapshot \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "filters": {
    "urlPathPattern": "/api/.*",
    "method": "GET",
    "ids": [
      "40a93c4a-d378-4e07-8321-6158d5dbcb29"
    ]
  },
  "captureHeaders": {
    "Accept": {},
    "Content-Type": {
      "caseInsensitive": true
    }
  },
  "requestBodyPattern": {
    "matcher": "equalToJson",
    "ignoreArrayOrder": false,
    "ignoreExtraElements": true
  },
  "extractBodyCriteria": {
    "textSizeThreshold": "2 kb",
    "binarySizeThreshold": "1 Mb"
  },
  "outputFormat": "FULL",
  "persist": false,
  "repeatsAsScenarios": false,
  "transformers": [
    "modify-response-header"
  ],
  "transformerParameters": {
    "headerValue": "123"
  }
}'
{
  "mappings": [
    {
      "id": "093f1027-e5e0-4921-9e6d-e619dfd5d2c7",
      "name": "recordables_123",
      "request": {
        "url": "/recordables/123",
        "method": "GET"
      },
      "response": {
        "status": 200,
        "body": "{\n  \"message\": \"Congratulations on your first recording!\"\n}",
        "headers": {
          "Content-Type": "application/json"
        }
      },
      "uuid": "093f1027-e5e0-4921-9e6d-e619dfd5d2c7",
      "persistent": true
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

​
mockApiId
string
required

The ID of the Mock API

Required string length: 5 - 10
Example:

"jjl8y"

Body

application/json

Response

200 - application/json

Successfully took a snapshot recording

The response is of type object.