{
"errors": [
{
"title": "Invalid JSON",
"detail": "json pointer /mockApi not present; it is required and must have json type object",
"source": {}
}
]
}
{
"errors": [
{
"title": "Invalid JSON",
"detail": "json pointer /mockApi not present; it is required and must have json type object",
"source": {}
}
]
}
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"WireMock Cloud","colors":{"primary":"#234E69","light":"#51AFE9","dark":"#234E69"},"logo":{"light":"https://mintcdn.com/wiremockinc/naAVdBHezo3uA-vt/logo/light.svg?fit=max\u0026auto=format\u0026n=naAVdBHezo3uA-vt\u0026q=85\u0026s=d793ceace787ddb9b53e3a8e828b9635","dark":"https://mintcdn.com/wiremockinc/naAVdBHezo3uA-vt/logo/dark.svg?fit=max\u0026auto=format\u0026n=naAVdBHezo3uA-vt\u0026q=85\u0026s=810f6c4093990be5f0ed074a7b863d80","href":"https://www.wiremock.io"},"favicon":"https://mintcdn.com/wiremockinc/m4BUFp24THf4QtFv/favicon.svg?fit=max\u0026auto=format\u0026n=m4BUFp24THf4QtFv\u0026q=85\u0026s=251fb2a34172427153d66e0068127eb9","api":{"openapi":"api-reference/openapi.yaml"},"navbar":{"links":[{"href":"mailto:support@wiremock.io","label":"Get Support"}],"primary":{"type":"button","label":"Login","href":"https://app.wiremock.cloud"}},"footer":{"socials":{"slack":"https://slack.wiremock.org/","x":"https://x.com/wiremockorg","github":"https://github.com/wiremock","linkedin":"https://www.linkedin.com/company/wiremock"}},"seo":{"organization":{"sameAs":["https://wiremock.org","https://www.wiremock.io","https://slack.wiremock.org/","https://x.com/wiremockorg","https://github.com/wiremock","https://www.linkedin.com/company/wiremock/"]}},"integrations":{"ga4":{"measurementId":"G-QGY5DELWWQ"},"gtm":{"tagId":"GTM-PVHGF5P4"},"intercom":{"appId":"xjme6u4w"}},"contextual":{"options":["download-spec"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Slack community","icon":"slack","href":"https://slack.wiremock.org"},{"anchor":"Blog","icon":"newspaper","href":"https://wiremock.io/blog"},{"anchor":"Install With Cursor","icon":"robot","href":"cursor://anysphere.cursor-deeplink/mcp/install?name=WireMock\u0026config=eyJjb21tYW5kIjoid2lyZW1vY2sgbWNwIn0="},{"anchor":"Self-paced Training","icon":"pen","href":"https://wiremockcloud.learnworlds.com/"},{"anchor":"Change Log","icon":"newspaper","href":"https://changes.wiremock.io/"},{"anchor":"System Status","icon":"bell","href":"https://status.wiremock.io/"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"wiremockinc","hasAudioNarration":false,"actualSubdomain":"wiremockinc","customDomains":["docs.wiremock.io"],"gitSource":{"type":"github","owner":"wiremock-inc","repo":"public-api-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae2eadfd4f3f1a7afdfbb1c","collectionId":"28818abd-3589-4243-9e15-6eea2ca7a1ac","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae2eadfd4f3f1a7afdfbb1c"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae88db40522e59c033ba84e","clientVersion":"0.0.4074","searchFilterCounts":[{"language":"default","tag":"Documentation","count":120},{"language":"default","tag":"API Reference","count":104},{"language":"default","tag":"How-to Guides","count":77},{"language":"default","tag":"Reference","count":26},{"language":"default","tag":"Settings","count":16},{"language":"default","tag":"Templating","count":15},{"language":"default","tag":"Concepts","count":14},{"language":"default","tag":"Stub Mappings","count":11},{"language":"default","tag":"CLI","count":10},{"language":"default","tag":"Requests","count":10}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"code.language-handlebars .block{display:inline-block}"}],"page":{"pagePath":"api-reference/mock-apis/update-mock-api","slug":"/api-reference/mock-apis/update-mock-api","pageMetadata":{"title":"Update mock API","description":"Update a mock API's metadata, such as its name.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v1/mock-apis/{mockApiId}","href":"/api-reference/mock-apis/update-mock-api","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Update a mock API’s metadata, such as its name.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Update mock API","description":"Update a mock API's metadata, such as its name.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v1/mock-apis/{mockApiId}","href":"/api-reference/mock-apis/update-mock-api","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/wiremockinc/029d9f60e6edd2c0/scripts/generate-llms-txt.js"],"openApiReferenceData":{"operation":{"operationId":"updateMockApi","summary":"Update mock API","description":"Update a mock API's metadata, such as its name.","tags":["Mock APIs"],"responses":{"200":"24bc1bc7-4c5d-46ad-a23a-790b9a9eeb0d","403":"c97b46a8-cc4d-45fd-b5e4-67765ed44973","422":"c6f55b23-6ae5-4823-995f-ce04f914877f"},"requestBody":"4cd1aebc-d550-4dc5-84da-9c5f035a1413","method":"put","type":"path","servers":["a13d4194-717e-4e90-b312-a2c7c4d0e819","dbda8819-a4d7-4a7c-9a5b-4dc283aaa08e"],"security":["8c8df9e3-f290-4e7a-ac3c-ff5c2187f75b"],"path":"/v1/mock-apis/{mockApiId}","baseUrlOptions":["https://wmc.wiremockapi.cloud","https://api.wiremock.cloud"],"title":"Update mock API","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"c814c848-5130-4b01-a09b-18957bef02bf":{"in":"path","name":"mockApiId","description":"The ID of the Mock API","required":true,"schema":{"type":"string","minLength":5,"maxLength":10,"example":"jjl8y","isRequired":true,"description":"The ID of the Mock API","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"mockApi":{"type":"object","properties":{"name":{"type":"string","maxLength":256,"description":"The display name of the mock API.","isRequired":true,"uniqueKey":"mockApi.name","typeLabel":"string"},"description":{"type":"string","maxLength":256,"description":"The description of the mock API.","uniqueKey":"mockApi.description","typeLabel":"string"},"adminSecurityEnabled":{"type":"boolean","description":"Whether security is enabled on the mock API's `/acl/*` endpoints.","uniqueKey":"mockApi.adminSecurityEnabled","typeLabel":"boolean"},"hostname":{"type":"string","description":"The friendly, unqualified domain name for this mock API's base URL\ne.g. in the SaaS edition, for a base URL of `https://my-api.wiremockapi.cloud` this value should be set to `my-api`.\n","uniqueKey":"mockApi.hostname","typeLabel":"string"}},"required":["name"],"isRequired":true,"uniqueKey":"mockApi","typeLabel":"object"}},"required":["mockApi"],"uniqueKey":"","typeLabel":"object"},"examples":{"main":{"title":"main","value":{"mockApi":{"name":"My modified mock API","hostname":"my-new-mock-api","adminSecurityEnabled":false}}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"24bc1bc7-4c5d-46ad-a23a-790b9a9eeb0d":{"description":"200 response","content":{"application/json":{"schema":{"type":"object","properties":{"mockApi":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"mockApi.id","typeLabel":"string"},"name":{"type":"string","maxLength":256,"description":"The display name of the mock API.","isRequired":true,"uniqueKey":"mockApi.name","typeLabel":"string"},"state":{"type":"string","description":"Whether the API is running or stopped.","isRequired":true,"uniqueKey":"mockApi.state","typeLabel":"string"},"adminSecurityEnabled":{"type":"boolean","description":"Whether security is enabled on the mock API's `/__admin/*` endpoints.","isRequired":true,"uniqueKey":"mockApi.adminSecurityEnabled","typeLabel":"boolean"},"createdDate":{"type":"string","isRequired":true,"uniqueKey":"mockApi.createdDate","typeLabel":"string"},"links":{"type":"object","properties":{"self":{"type":"string","isRequired":true,"uniqueKey":"mockApi.links.self","typeLabel":"string"},"requests":{"type":"string","isRequired":true,"uniqueKey":"mockApi.links.requests","typeLabel":"string"},"mappings":{"type":"string","isRequired":true,"uniqueKey":"mockApi.links.mappings","typeLabel":"string"},"scenarios":{"type":"string","isRequired":true,"uniqueKey":"mockApi.links.scenarios","typeLabel":"string"},"recordings":{"type":"object","properties":{"start":{"type":"string","isRequired":true,"uniqueKey":"mockApi.links.recordings.start","typeLabel":"string"},"stop":{"type":"string","isRequired":true,"uniqueKey":"mockApi.links.recordings.stop","typeLabel":"string"},"status":{"type":"string","isRequired":true,"uniqueKey":"mockApi.links.recordings.status","typeLabel":"string"},"snapshot":{"type":"string","isRequired":true,"uniqueKey":"mockApi.links.recordings.snapshot","typeLabel":"string"}},"required":["start","stop","status","snapshot"],"isRequired":true,"uniqueKey":"mockApi.links.recordings","typeLabel":"object"},"imports":{"type":"string","isRequired":true,"uniqueKey":"mockApi.links.imports","typeLabel":"string"},"organisation":{"type":"string","isRequired":true,"uniqueKey":"mockApi.links.organisation","typeLabel":"string"},"invitations":{"type":"string","isRequired":true,"uniqueKey":"mockApi.links.invitations","typeLabel":"string"},"acl":{"type":"string","description":"The link to the access control list for this mock API.","isRequired":true,"uniqueKey":"mockApi.links.acl","typeLabel":"string"},"versionHistoryCommits":{"type":"string","isRequired":true,"uniqueKey":"mockApi.links.versionHistoryCommits","typeLabel":"string"},"securitySettings":{"type":"string","uniqueKey":"mockApi.links.securitySettings","typeLabel":"string"},"exports":{"type":"object","properties":{"wiremock":{"type":"string","isRequired":true,"uniqueKey":"mockApi.links.exports.wiremock","typeLabel":"string"}},"required":["wiremock"],"uniqueKey":"mockApi.links.exports","typeLabel":"object"}},"required":["self","requests","mappings","scenarios","recordings","imports","organisation","invitations","acl","versionHistoryCommits"],"isRequired":true,"uniqueKey":"mockApi.links","typeLabel":"object"},"domainNames":{"type":"array","items":{"type":"object","properties":{"domainName":{"type":"string","isRequired":true,"uniqueKey":"mockApi.domainNames.items.[INDEX].domainName","typeLabel":"string"},"urls":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string","isRequired":true,"uniqueKey":"mockApi.domainNames.items.[INDEX].urls.items.[INDEX].url","typeLabel":"string"}},"required":["url"],"uniqueKey":"mockApi.domainNames.items.[INDEX].urls.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"mockApi.domainNames.items.[INDEX].urls","typeLabel":"object[]"}},"required":["domainName","urls"],"uniqueKey":"mockApi.domainNames.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"mockApi.domainNames","typeLabel":"object[]"},"baseUrl":{"type":"string","isRequired":true,"uniqueKey":"mockApi.baseUrl","typeLabel":"string"},"domains":{"type":"array","description":"The list of domain names that can be used to address this mock API.","items":{"type":"string","uniqueKey":"mockApi.domains.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"mockApi.domains","typeLabel":"string[]"},"description":{"type":"string","maxLength":256,"description":"The description of the mock API.","uniqueKey":"mockApi.description","typeLabel":"string"},"type":{"oneOf":[{"type":"string","description":"The type of the mock API. Defaults to the \"unstructured\" type if not specified.","enum":["openapi","grpc","graphql"],"uniqueKey":"mockApi.type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"The type of the mock API. Defaults to the \"unstructured\" type if not specified.","enum":["openapi","grpc","graphql"],"uniqueKey":"mockApi.type.oneOf.1","typeLabel":"null"}],"uniqueKey":"mockApi.type","typeLabel":"enum\u003cstring> | null"},"aclObject":{"description":"The ACL object ID of the entity.","type":"string","uniqueKey":"mockApi.aclObject","typeLabel":"string"},"mockHost":{"oneOf":[{"description":"The ID of the mock host where this mock API is located.","type":"string","uniqueKey":"mockApi.mockHost.oneOf.0","typeLabel":"string"},{"description":"The ID of the mock host where this mock API is located.","type":"null","uniqueKey":"mockApi.mockHost.oneOf.1","typeLabel":"null"}],"uniqueKey":"mockApi.mockHost","typeLabel":"string | null"}},"required":["id","name","state","adminSecurityEnabled","exportState","createdDate","links","domainNames","baseUrl","domains"],"isRequired":true,"uniqueKey":"mockApi","typeLabel":"object"}},"required":["mockApi"],"uniqueKey":"","typeLabel":"object"},"examples":{"main":{"title":"main","value":{"mockApi":{"id":"jjl8y","aclObject":"gkqjy","name":"My modified mock API","description":"This is a modified mock API for testing purposes.","state":"RUNNING","adminSecurityEnabled":true,"exportState":"EXPORT_ALLOWED","createdDate":"2024-08-23T21:34:36.595372Z","openApiGitIntegration":"jjl8y-openapi-integration-git","links":{"self":"/v1/mock-apis/jjl8y","requests":"/v1/mock-apis/jjl8y/requests","mappings":"/v1/mock-apis/jjl8y/mappings","scenarios":"/v1/mock-apis/jjl8y/scenarios","recordings":{"start":"/v1/mock-apis/jjl8y/recordings/start","stop":"/v1/mock-apis/jjl8y/recordings/stop","status":"/v1/mock-apis/jjl8y/recordings/status","snapshot":"/v1/mock-apis/jjl8y/recordings/snapshot"},"imports":"/v1/mock-apis/jjl8y/imports","organisation":"/v1/organisations/mgk7g","apiTemplate":"/v1/api-templates/8nd5x","aclObject":"/v1/acl/objects/gkqjy","aclRoles":"/v1/acl/objects/gkqjy/roles","invitations":"/v1/mock-apis/jjl8y/invitations","acl":"/v1/mock-apis/jjl8y/acl{?subjectId}","versionHistoryCommits":"/v1/mock-apis/jjl8y/version-history/commits"},"baseUrl":"https://jjl8y.wiremockapi.cloud","domainNames":[{"domainName":"my-new-mock-api.wiremockapi.cloud","editableSubdomainPart":"my-new-mock-api","urls":[{"url":"https://my-new-mock-api.wiremockapi.cloud"},{"url":"http://my-new-mock-api.wiremockapi.cloud"}]},{"domainName":"jjl8y.wiremockapi.cloud","urls":[{"url":"https://jjl8y.wiremockapi.cloud"},{"url":"http://jjl8y.wiremockapi.cloud"}]}],"domains":["jjl8y.wiremockapi.cloud","my-new-mock-api.wiremockapi.cloud"]}}}},"exampleType":"examples"}},"exampleType":"examples"},"c97b46a8-cc4d-45fd-b5e4-67765ed44973":{"description":"403 Unauthorized response","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].title","typeLabel":"string"},"code":{"type":"number","uniqueKey":"errors.items.[INDEX].code","typeLabel":"number"},"detail":{"type":"string","uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"source":{"type":"object","uniqueKey":"errors.items.[INDEX].source","typeLabel":"object"}},"required":["title"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"required":["errors"],"uniqueKey":"","typeLabel":"object"},"example":{"errors":[{"title":"Forbidden","source":{}}]},"examples":{"Example":{"title":"Example","value":{"errors":[{"title":"Forbidden","source":{}}]}}},"exampleType":"examples"}},"exampleType":"examples"},"c6f55b23-6ae5-4823-995f-ce04f914877f":{"description":"422 Bad Entity response","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].title","typeLabel":"string"},"code":{"type":"number","uniqueKey":"errors.items.[INDEX].code","typeLabel":"number"},"detail":{"type":"string","uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"source":{"type":"object","uniqueKey":"errors.items.[INDEX].source","typeLabel":"object"}},"required":["title"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"required":["errors"],"uniqueKey":"","typeLabel":"object"},"example":{"errors":[{"title":"Invalid JSON","detail":"json pointer /mockApi not present; it is required and must have json type object","source":{}}]},"examples":{"Example":{"title":"Example","value":{"errors":[{"title":"Invalid JSON","detail":"json pointer /mockApi not present; it is required and must have json type object","source":{}}]}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"8c8df9e3-f290-4e7a-ac3c-ff5c2187f75b":{"tokenAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Your [API key](https://app.wiremock.cloud/account/security) prefixed by 'Token '","scopes":[]}}},"servers":{"a13d4194-717e-4e90-b312-a2c7c4d0e819":{"url":"https://wmc.wiremockapi.cloud","description":"Mock"},"dbda8819-a4d7-4a7c-9a5b-4dc283aaa08e":{"url":"https://api.wiremock.cloud","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"Authorization","description":"Your [API key](https://app.wiremock.cloud/account/security) prefixed by 'Token '","scopes":[]},"schema":{"title":"Authorization","type":"string","description":"Your [API key](https://app.wiremock.cloud/account/security) prefixed by 'Token '","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"tokenAuth","name":"Authorization"}],"title":"tokenAuth"}]},"originalFileLocation":"api-reference/openapi.yaml"},"subdomain":"wiremockinc","siteName":"WireMock Cloud","title":"Update mock API - WireMock Cloud","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-22T08:40:36.287Z","originalFileLocation":"api-reference/mock-apis/update-mock-api.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Update a mock API\u0026#x27;s metadata, such as its name.\">\u003cmeta data-mint-head name=\"application-name\" content=\"WireMock Cloud\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/wiremockinc/CECzM-LCKYF2F3LU/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/wiremockinc/CECzM-LCKYF2F3LU/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/wiremockinc/CECzM-LCKYF2F3LU/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/wiremockinc/CECzM-LCKYF2F3LU/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/wiremockinc/CECzM-LCKYF2F3LU/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/wiremockinc/CECzM-LCKYF2F3LU/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/wiremockinc/CECzM-LCKYF2F3LU/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/wiremockinc/CECzM-LCKYF2F3LU/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/wiremockinc/CECzM-LCKYF2F3LU/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update mock API - WireMock Cloud\">\u003cmeta data-mint-head property=\"og:description\" content=\"Update a mock API\u0026#x27;s metadata, such as its name.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"WireMock Cloud\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.wiremock.io/api-reference/mock-apis/update-mock-api\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://wiremockinc.mintlify.site/_mintlify/api/og/v2?division=Mock+APIs\u0026amp;title=Update+mock+API\u0026amp;description=Update+a+mock+API%27s+metadata%2C+such+as+its+name.\u0026amp;theme=bd6b655a49d3bdf06e9a283b\u0026amp;signature=61962307cbef09bd9c9d9747b221d12a2cf7424d368e9d4a314b4f3dacbc1e0d\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Update mock API - WireMock Cloud\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Update a mock API\u0026#x27;s metadata, such as its name.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://wiremockinc.mintlify.site/_mintlify/api/og/v2?division=Mock+APIs\u0026amp;title=Update+mock+API\u0026amp;description=Update+a+mock+API%27s+metadata%2C+such+as+its+name.\u0026amp;theme=bd6b655a49d3bdf06e9a283b\u0026amp;signature=61962307cbef09bd9c9d9747b221d12a2cf7424d368e9d4a314b4f3dacbc1e0d\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/wiremockinc/CECzM-LCKYF2F3LU/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"WireMock Cloud\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#234E69\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.wiremock.io/api-reference/mock-apis/update-mock-api\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/mock-apis/update-mock-api.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.wiremock.io/#organization\",\"name\":\"WireMock Cloud\",\"url\":\"https://docs.wiremock.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/wiremockinc/naAVdBHezo3uA-vt/logo/light.svg?fit=max\u0026auto=format\u0026n=naAVdBHezo3uA-vt\u0026q=85\u0026s=d793ceace787ddb9b53e3a8e828b9635\"},\"sameAs\":[\"https://wiremock.org\",\"https://www.wiremock.io\",\"https://slack.wiremock.org/\",\"https://x.com/wiremockorg\",\"https://github.com/wiremock\",\"https://www.linkedin.com/company/wiremock/\"]},{\"@type\":\"WebSite\",\"@id\":\"https://docs.wiremock.io#website\",\"name\":\"WireMock Cloud\",\"url\":\"https://docs.wiremock.io\",\"publisher\":{\"@id\":\"https://docs.wiremock.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.wiremock.io/api-reference/mock-apis/update-mock-api#webpage\",\"url\":\"https://docs.wiremock.io/api-reference/mock-apis/update-mock-api\",\"name\":\"Update mock API\",\"description\":\"Update a mock API's metadata, such as its name.\",\"dateModified\":\"2026-09-22T08:40:36.287Z\",\"isPartOf\":{\"@id\":\"https://docs.wiremock.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.wiremock.io/api-reference/mock-apis/update-mock-api#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.wiremock.io/api-reference/mock-apis/update-mock-api#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Mock APIs\",\"item\":\"https://docs.wiremock.io/api-reference/mock-apis/get-mock-apis-accessible-to-a-user\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Update mock API\",\"item\":\"https://docs.wiremock.io/api-reference/mock-apis/update-mock-api\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.wiremock.io/api-reference/mock-apis/update-mock-api#apireference\",\"headline\":\"Update mock API\",\"name\":\"Update mock API\",\"description\":\"Update a mock API's metadata, such as its name.\",\"url\":\"https://docs.wiremock.io/api-reference/mock-apis/update-mock-api\",\"mainEntityOfPage\":{\"@id\":\"https://docs.wiremock.io/api-reference/mock-apis/update-mock-api#webpage\"},\"dateModified\":\"2026-09-22T08:40:36.287Z\",\"publisher\":{\"@id\":\"https://docs.wiremock.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.wiremock.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"WireMock Cloud\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"WireMock Cloud","nav":{"global":{"anchors":[{"anchor":"Slack community","icon":"slack","href":"https://slack.wiremock.org"},{"anchor":"Blog","icon":"newspaper","href":"https://wiremock.io/blog"},{"anchor":"Install With Cursor","icon":"robot","href":"cursor://anysphere.cursor-deeplink/mcp/install?name=WireMock\u0026config=eyJjb21tYW5kIjoid2lyZW1vY2sgbWNwIn0="},{"anchor":"Self-paced Training","icon":"pen","href":"https://wiremockcloud.learnworlds.com/"},{"anchor":"Change Log","icon":"newspaper","href":"https://changes.wiremock.io/"},{"anchor":"System Status","icon":"bell","href":"https://status.wiremock.io/"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/overview"}]},{"tab":"API Reference","groups":[{"group":"WireMock Cloud API","pages":[{"title":"Introduction","href":"/api-reference/introduction"}]},{"group":"Users","pages":[{"title":"Get self","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/users/self","href":"/api-reference/users/get-self"},{"title":"Get user by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/users/{userId}","href":"/api-reference/users/get-user-by-id"},{"title":"Update user","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v1/users/{userId}","href":"/api-reference/users/update-user"},{"title":"Delete user by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v1/users/{userId}","href":"/api-reference/users/delete-user-by-id"}]},{"group":"Mock APIs","pages":[{"title":"Get mock APIs accessible to a user","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/users/{userId}/apis","href":"/api-reference/mock-apis/get-mock-apis-accessible-to-a-user"},{"title":"Create a new mock API","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/mock-apis","href":"/api-reference/mock-apis/create-a-new-mock-api"},{"title":"Get mock API by ID","description":"Retrieve a single mock API's metadata, such as its name, mock host and configuration.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/mock-apis/{mockApiId}","href":"/api-reference/mock-apis/get-mock-api-by-id"},{"title":"Update mock API","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v1/mock-apis/{mockApiId}","href":"/api-reference/mock-apis/update-mock-api"},{"title":"Delete mock API","description":"Permanently delete a mock API, including its stub mappings, request journal and settings.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v1/mock-apis/{mockApiId}","href":"/api-reference/mock-apis/delete-mock-api"},{"title":"Move a mock API to a different mock host","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v1/mock-apis/{mockApiId}/host","href":"/api-reference/mock-apis/move-a-mock-api-to-a-different-mock-host"}]},{"group":"Teams","pages":[{"title":"Get all teams readable by a user","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/users/{userId}/teams","href":"/api-reference/teams/get-all-teams-readable-by-a-user"},{"title":"Get all teams in an organisation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/organisations/{organisationId}/teams","href":"/api-reference/teams/get-all-teams-in-an-organisation"},{"title":"Create a team","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/teams","href":"/api-reference/teams/create-a-team"},{"title":"Get a team by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/teams/{teamId}","href":"/api-reference/teams/get-a-team-by-id"},{"title":"Update a team by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v1/teams/{teamId}","href":"/api-reference/teams/update-a-team-by-id"},{"title":"Delete a team by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v1/teams/{teamId}","href":"/api-reference/teams/delete-a-team-by-id"},{"title":"Get team members","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/teams/{teamId}/members","href":"/api-reference/teams/get-team-members"},{"title":"Add team member","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/teams/{teamId}/members","href":"/api-reference/teams/add-team-member"},{"title":"Delete a team member","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v1/teams/{teamId}/members/{userId}","href":"/api-reference/teams/delete-a-team-member"}]},{"group":"Organisations","pages":[{"title":"Get organisation by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/organisations/{organisationId}","href":"/api-reference/organisations/get-organisation-by-id"},{"title":"Update organisation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v1/organisations/{organisationId}","href":"/api-reference/organisations/update-organisation"},{"title":"Delete organisation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v1/organisations/{organisationId}","href":"/api-reference/organisations/delete-organisation"},{"title":"Get users in an organisation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/organisations/{organisationId}/users","href":"/api-reference/organisations/get-users-in-an-organisation"},{"title":"Get pending invitations for organisation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/organisations/{organisationId}/invitations","href":"/api-reference/organisations/get-pending-invitations-for-organisation"},{"title":"Invite a user to an organisation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/organisations/{organisationId}/invitations","href":"/api-reference/organisations/invite-a-user-to-an-organisation"},{"title":"Delete organisation member user","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v1/organisations/{organisationId}/members/{userId}","href":"/api-reference/organisations/delete-organisation-member-user"},{"title":"Retrieve an organisation's mock hosts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/organisations/{organisationId}/hosts","href":"/api-reference/organisations/retrieve-an-organisations-mock-hosts"}]},{"group":"Security","pages":[{"title":"Regenerate a user's API token","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/users/{userId}/regenerate-api-token","href":"/api-reference/security/regenerate-a-users-api-token"}]},{"group":"Data sources","pages":[{"title":"Get data sources accessible by a user","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/users/{userId}/data-sources","href":"/api-reference/data-sources/get-data-sources-accessible-by-a-user"},{"title":"Create a data source","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/users/{userId}/data-sources","href":"/api-reference/data-sources/create-a-data-source"},{"title":"Get data source by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/data-sources/{dataSourceId}","href":"/api-reference/data-sources/get-data-source-by-id"},{"title":"Update data source","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v1/data-sources/{dataSourceId}","href":"/api-reference/data-sources/update-data-source"},{"title":"Delete data source by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v1/data-sources/{dataSourceId}","href":"/api-reference/data-sources/delete-data-source-by-id"},{"title":"Update data source CSV data","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v1/data-sources/{dataSourceId}/data","href":"/api-reference/data-sources/update-data-source-csv-data"}]},{"group":"Database connections","pages":[{"title":"Get database connections accessible by a user","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/users/{userId}/database-connections","href":"/api-reference/database-connections/get-database-connections-accessible-by-a-user"},{"title":"Create a database connection","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/users/{userId}/database-connections","href":"/api-reference/database-connections/create-a-database-connection"},{"title":"Get database connection by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/database-connections/{databaseConnectionId}","href":"/api-reference/database-connections/get-database-connection-by-id"},{"title":"Delete database connection by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v1/database-connections/{databaseConnectionId}","href":"/api-reference/database-connections/delete-database-connection-by-id"},{"title":"Update database connection","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v1/database-connections/{databaseConnectionId}","href":"/api-reference/database-connections/update-database-connection"},{"title":"Test a database connection","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/users/{userId}/database-connections/test","href":"/api-reference/database-connections/test-a-database-connection"}]},{"group":"Usage","pages":[{"title":"Get usage","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/subscriptions/{subscriptionId}/usage","href":"/api-reference/usage/get-usage"}]},{"group":"Access control","pages":[{"title":"Get ACL candidates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/{entityCollection}/{entityId}/acl/candidates","href":"/api-reference/access-control/get-acl-candidates"},{"title":"Update an entity's ACL","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v1/{entityCollection}/{entityId}/acl/{subjectType}/{subjectEntityId}","href":"/api-reference/access-control/update-an-entitys-acl"},{"title":"Delete an entry from an entity's ACL.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v1/{entityCollection}/{entityId}/acl/{subjectType}/{subjectEntityId}","href":"/api-reference/access-control/delete-an-entry-from-an-entitys-acl"}]},{"group":"Stub Mappings","pages":[{"title":"Get all stub mappings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/mock-apis/{mockApiId}/mappings","href":"/api-reference/stub-mappings/get-all-stub-mappings"},{"title":"Create a new stub mapping","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/mock-apis/{mockApiId}/mappings","href":"/api-reference/stub-mappings/create-a-new-stub-mapping"},{"title":"Delete all stub mappings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v1/mock-apis/{mockApiId}/mappings","href":"/api-reference/stub-mappings/delete-all-stub-mappings"},{"title":"Reset stub mappings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/mock-apis/{mockApiId}/mappings/reset","href":"/api-reference/stub-mappings/reset-stub-mappings"},{"title":"Persist stub mappings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/mock-apis/{mockApiId}/mappings/save","href":"/api-reference/stub-mappings/persist-stub-mappings"},{"title":"Import stub mappings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/mock-apis/{mockApiId}/mappings/import","href":"/api-reference/stub-mappings/import-stub-mappings"},{"title":"Get stub mapping by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/mock-apis/{mockApiId}/mappings/{stubMappingId}","href":"/api-reference/stub-mappings/get-stub-mapping-by-id"},{"title":"Update a stub mapping","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v1/mock-apis/{mockApiId}/mappings/{stubMappingId}","href":"/api-reference/stub-mappings/update-a-stub-mapping"},{"title":"Delete a stub mapping","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v1/mock-apis/{mockApiId}/mappings/{stubMappingId}","href":"/api-reference/stub-mappings/delete-a-stub-mapping"},{"title":"Find stub mappings matching metadata","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/mock-apis/{mockApiId}/mappings/find-by-metadata","href":"/api-reference/stub-mappings/find-stub-mappings-matching-metadata"},{"title":"Delete stub mappings matching metadata","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/mock-apis/{mockApiId}/mappings/remove-by-metadata","href":"/api-reference/stub-mappings/delete-stub-mappings-matching-metadata"}]},{"group":"Requests","pages":[{"title":"Get all requests in journal","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/mock-apis/{mockApiId}/requests","href":"/api-reference/requests/get-all-requests-in-journal"},{"title":"Delete all requests in journal","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v1/mock-apis/{mockApiId}/requests","href":"/api-reference/requests/delete-all-requests-in-journal"},{"title":"Get request by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/mock-apis/{mockApiId}/requests/{requestId}","href":"/api-reference/requests/get-request-by-id"},{"title":"Delete request by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v1/mock-apis/{mockApiId}/requests/{requestId}","href":"/api-reference/requests/delete-request-by-id"},{"title":"Empty the request journal","deprecated":true,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/mock-apis/{mockApiId}/requests/reset","href":"/api-reference/requests/empty-the-request-journal"},{"title":"Count requests by criteria","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/mock-apis/{mockApiId}/requests/count","href":"/api-reference/requests/count-requests-by-criteria"},{"title":"Remove requests by criteria","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/mock-apis/{mockApiId}/requests/remove","href":"/api-reference/requests/remove-requests-by-criteria"},{"title":"Delete requests mappings matching metadata","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/mock-apis/{mockApiId}/requests/remove-by-metadata","href":"/api-reference/requests/delete-requests-mappings-matching-metadata"},{"title":"Find requests by criteria","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/mock-apis/{mockApiId}/requests/find","href":"/api-reference/requests/find-requests-by-criteria"},{"title":"Find unmatched requests","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/mock-apis/{mockApiId}/requests/unmatched","href":"/api-reference/requests/find-unmatched-requests"}]},{"group":"Recordings","pages":[{"title":"Start recording","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/mock-apis/{mockApiId}/recordings/start","href":"/api-reference/recordings/start-recording"},{"title":"Stop recording","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/mock-apis/{mockApiId}/recordings/stop","href":"/api-reference/recordings/stop-recording"},{"title":"Get recording status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/mock-apis/{mockApiId}/recordings/status","href":"/api-reference/recordings/get-recording-status"},{"title":"Take a snapshot recording","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/mock-apis/{mockApiId}/recordings/snapshot","href":"/api-reference/recordings/take-a-snapshot-recording"}]},{"group":"State","pages":[{"title":"Get all scenarios","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/mock-apis/{mockApiId}/scenarios","href":"/api-reference/state/get-all-scenarios"},{"title":"Reset all state","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/mock-apis/{mockApiId}/scenarios/reset","href":"/api-reference/state/reset-all-state"}]},{"group":"Settings","pages":[{"title":"Get chaos settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/mock-apis/{mockApiId}/settings/chaos","href":"/api-reference/settings/get-chaos-settings"},{"title":"Update chaos settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v1/mock-apis/{mockApiId}/settings/chaos","href":"/api-reference/settings/update-chaos-settings"},{"title":"Get OpenAPI settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/mock-apis/{mockApiId}/settings/openapi","href":"/api-reference/settings/get-openapi-settings"},{"title":"Update OpenAPI settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v1/mock-apis/{mockApiId}/settings/openapi","href":"/api-reference/settings/update-openapi-settings"},{"title":"Get state settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/mock-apis/{mockApiId}/settings/state","href":"/api-reference/settings/get-state-settings"},{"title":"Update state settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v1/mock-apis/{mockApiId}/settings/state","href":"/api-reference/settings/update-state-settings"},{"title":"Get delay distribution","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/mock-apis/{mockApiId}/settings/delayDistribution","href":"/api-reference/settings/get-delay-distribution"},{"title":"Update delay distribution","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v1/mock-apis/{mockApiId}/settings/delayDistribution","href":"/api-reference/settings/update-delay-distribution"},{"title":"Get all rate limits","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/mock-apis/{mockApiId}/settings/rateLimits","href":"/api-reference/settings/get-all-rate-limits"},{"title":"Replace all rate limits","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v1/mock-apis/{mockApiId}/settings/rateLimits","href":"/api-reference/settings/replace-all-rate-limits"},{"title":"Create a rate limit","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/mock-apis/{mockApiId}/settings/rateLimits","href":"/api-reference/settings/create-a-rate-limit"},{"title":"Get a rate limit by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/mock-apis/{mockApiId}/settings/rateLimits/{rateLimitId}","href":"/api-reference/settings/get-a-rate-limit-by-id"},{"title":"Update a rate limit","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v1/mock-apis/{mockApiId}/settings/rateLimits/{rateLimitId}","href":"/api-reference/settings/update-a-rate-limit"},{"title":"Delete a rate limit","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v1/mock-apis/{mockApiId}/settings/rateLimits/{rateLimitId}","href":"/api-reference/settings/delete-a-rate-limit"},{"title":"Get mock API certificate settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/mock-apis/{mockApiId}/settings/certificate","href":"/api-reference/settings/get-mock-api-certificate-settings"},{"title":"Set mock API certificate settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v1/mock-apis/{mockApiId}/settings/certificate","href":"/api-reference/settings/set-mock-api-certificate-settings"}]},{"group":"OpenAPI","pages":[{"title":"Get OpenAPI document for mock API","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/mock-apis/{mockApiId}/open-api","href":"/api-reference/openapi/get-openapi-document-for-mock-api"},{"title":"Update OpenAPI document for mock API","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v1/mock-apis/{mockApiId}/open-api","href":"/api-reference/openapi/update-openapi-document-for-mock-api"},{"title":"Pull OpenAPI document from Git","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/mock-apis/{mockApiId}/open-api/pull","href":"/api-reference/openapi/pull-openapi-document-from-git"},{"title":"Push OpenAPI document to Git","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v1/mock-apis/{mockApiId}/open-api/push","href":"/api-reference/openapi/push-openapi-document-to-git"}]},{"group":"Imports","pages":[{"title":"Import into a mock API","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/mock-apis/{mockApiId}/imports","href":"/api-reference/imports/import-into-a-mock-api"}]},{"group":"Jobs","pages":[{"title":"Get job by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/mock-apis/{mockApiId}/jobs/{jobId}","href":"/api-reference/jobs/get-job-by-id"}]},{"group":"Mock API versioning","pages":[{"title":"Get a mock API's versions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/mock-apis/{mockApiId}/version-history/commits","href":"/api-reference/mock-api-versioning/get-a-mock-apis-versions"},{"title":"Get a version by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/mock-apis/{mockApiId}/version-history/commits/{versionCommitId}","href":"/api-reference/mock-api-versioning/get-a-version-by-id"},{"title":"Get all entities in a given version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/mock-apis/{mockApiId}/version-history/commits/{versionCommitId}/items","href":"/api-reference/mock-api-versioning/get-all-entities-in-a-given-version"},{"title":"Get all changes between one version and another","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/mock-apis/{mockApiId}/version-history/commits/{versionCommitId}/changes","href":"/api-reference/mock-api-versioning/get-all-changes-between-one-version-and-another"},{"title":"Get the change to an entity between one version and another","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/mock-apis/{mockApiId}/version-history/commits/{versionCommitId}/changes/{entityType}/{entityId}","href":"/api-reference/mock-api-versioning/get-the-change-to-an-entity-between-one-version-and-another"},{"title":"Get the contents of a entity at a given version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/mock-apis/{mockApiId}/version-history/commits/{versionCommitId}/blob/{entityType}/{entityId}","href":"/api-reference/mock-api-versioning/get-the-contents-of-a-entity-at-a-given-version"},{"title":"Restore the contents of an entity to a given version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/mock-apis/{mockApiId}/version-history/commits/{versionCommitId}/restore/{entityType}/{entityId}","href":"/api-reference/mock-api-versioning/restore-the-contents-of-an-entity-to-a-given-version"},{"title":"Restore the contents of all mock API entities to a given version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/mock-apis/{mockApiId}/version-history/commits/{versionCommitId}/restore","href":"/api-reference/mock-api-versioning/restore-the-contents-of-all-mock-api-entities-to-a-given-version"}]},{"group":"Mock Hosts","pages":[{"title":"Retrieve a mock host by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/hosts/{mockHostId}","href":"/api-reference/mock-hosts/retrieve-a-mock-host-by-id"},{"title":"Update a mock host","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v1/hosts/{mockHostId}","href":"/api-reference/mock-hosts/update-a-mock-host"}]}]}]},"basePath":"","title":"Update mock API - WireMock Cloud","buildId":"dpl_BLQvU86QFwq3AhPofSTw6q8dGWKm","deploymentId":"dpl_BLQvU86QFwq3AhPofSTw6q8dGWKm","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Myd8dsju.js","utils-C2HkQgW0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-8rSppmTv.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B6MjiCFm.js","snippetPresets-DwrSAONL.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-1-a5UQKQ.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C541m7wZ.js","shallow-CWELCZ77.js","getApiPlaygroundDisplay-CTo5Zn03.js","CodeSnippet-D--dzvnl.js","CodeSnippets-DM3cXEDh.js","Page-CxAy5y67.js","getPastedJson-C-VECgcL.js","icon-BPq2-Mg3.js","MethodPill-D9J5cUHd.js","DuplicateIcon-BqHaxUnD.js","createIcon-CIbcZHp9.js","DynamicMarkdown-BKiHAm_d.js","SectionHeading-DstQXt3H.js","axios-vUo_bRtp.js","Markdown-CpxgzsKA.js","clsx-C5EfhVm0.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CJ9Oly2E.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Mk6P3qvh.js"]}