Skip to main content
PUT
/
v1
/
mock-apis
/
{mockApiId}
/
settings
/
openapi
Update OpenAPI settings
curl --request PUT \
  --url https://wmc.wiremockapi.cloud/v1/mock-apis/{mockApiId}/settings/openapi \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "openapi": {
    "portalEnabled": true,
    "portalSecurity": {
      "type": "OIDC"
    },
    "validationMode": "soft",
    "generateOpenApiFromStubs": true,
    "generateStubsFromOpenApi": true,
    "generateDefaultStubs": false
  }
}
'
{
  "openapi": {
    "portalEnabled": true,
    "portalSecurity": {},
    "generateOpenApiFromStubs": true,
    "generateStubsFromOpenApi": true,
    "generateDefaultStubs": true
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.wiremock.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Your API key prefixed by 'Token '

Path Parameters

​
mockApiId
string
required

The ID of the Mock API

Required string length: 5 - 10
Example:

"jjl8y"

Body

application/json
​
openapi
object
required

OpenAPI integration settings for the mock API.

Response

Settings successfully updated

​
openapi
object

OpenAPI integration settings for the mock API.