Mock Workspaces

List mock workspaces

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Workspace summaries

No content

403

Forbidden - Requires role: owner, member, application

get/sfp/api/mocks/workspaces

GET /sfp/api/mocks/workspaces HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Activate (or re-activate) a mock workspace

post

Registers WireMock stubs for every service in the definition. Re-activation replaces the baseline but preserves session overrides by service name.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

workspacestringRequired

Responses

201

Workspace activated; returns per-service stub counts and data-plane paths

No content

403

Forbidden - Requires role: owner, member, application

post/sfp/api/mocks/workspaces

POST /sfp/api/mocks/workspaces HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 758

{
  "workspace": "text",
  "context": {
    "repository": "text",
    "prNumber": 1,
    "branch": "text",
    "environment": "text"
  },
  "services": [
    {
      "name": "text",
      "namedCredential": "text",
      "packageName": "text",
      "specSource": "source",
      "spec": "text",
      "baselineRules": [
        {
          "request": {
            "method": "text",
            "path": "text",
            "query": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "bodyContains": "text"
          },
          "response": {
            "status": 1,
            "body": null,
            "headers": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "delayMs": 1
          },
          "scenario": "text",
          "responses": [
            {
              "status": 1,
              "body": null,
              "ANY_ADDITIONAL_PROPERTY": "anything"
            }
          ]
        }
      ]
    }
  ],
  "playbooks": [
    {
      "name": "text",
      "steps": [
        {
          "service": "text",
          "request": {
            "method": "text",
            "path": "text"
          },
          "response": {
            "status": 1,
            "body": null,
            "headers": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "delayMs": 1,
            "ANY_ADDITIONAL_PROPERTY": "anything"
          }
        }
      ]
    }
  ]
}

No content

Get a workspace with effective rules per service

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

workspacestringRequired

Responses

200

Full workspace state

No content

403

Forbidden - Requires role: owner, member, application

get/sfp/api/mocks/workspaces/{workspace}

GET /sfp/api/mocks/workspaces/{workspace} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Tear down a workspace (stubs + record)

delete

restore=true reverts switched credentials first; force=true tears down even when restore fails.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

workspacestringRequired

Query parameters

restorestringRequired

forcestringRequired

Responses

200

Workspace removed

No content

403

Forbidden - Requires role: owner, application

delete/sfp/api/mocks/workspaces/{workspace}

DELETE /sfp/api/mocks/workspaces/{workspace}?restore=text&force=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Set the session rule override for a service (applies immediately)

put

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

workspacestringRequired

servicestringRequired

Body

Responses

200

Override applied and stubs re-registered

No content

403

Forbidden - Requires role: owner, member, application

put/sfp/api/mocks/workspaces/{workspace}/services/{service}/rules

PUT /sfp/api/mocks/workspaces/{workspace}/services/{service}/rules HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 307

{
  "rules": [
    {
      "request": {
        "method": "text",
        "path": "text",
        "query": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "bodyContains": "text"
      },
      "response": {
        "status": 1,
        "body": null,
        "headers": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "delayMs": 1
      },
      "scenario": "text",
      "responses": [
        {
          "status": 1,
          "body": null,
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      ]
    }
  ]
}

No content

Clear the session override; baseline re-applies

delete

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

workspacestringRequired

servicestringRequired

Responses

200

Override cleared and stubs re-registered

No content

403

Forbidden - Requires role: owner, member, application

delete/sfp/api/mocks/workspaces/{workspace}/services/{service}/rules

DELETE /sfp/api/mocks/workspaces/{workspace}/services/{service}/rules HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Incoming-request journal for the workspace

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

workspacestringRequired

Query parameters

servicestringRequired

sincestringRequired

limitstringRequired

Responses

200

Journal entries (newest first), wasMatched flags unanswered callouts

No content

403

Forbidden - Requires role: owner, member, application

get/sfp/api/mocks/workspaces/{workspace}/requests

GET /sfp/api/mocks/workspaces/{workspace}/requests?service=text&since=text&limit=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Export effective rules as yaml (graduate session edits to the repo)

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

workspacestringRequired

servicestringRequired

Responses

200

rules yaml

No content

403

Forbidden - Requires role: owner, member, application

get/sfp/api/mocks/workspaces/{workspace}/services/{service}/rules.yaml

GET /sfp/api/mocks/workspaces/{workspace}/services/{service}/rules.yaml HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Record which org credentials were switched to the mock data plane

post

Called after the org-side switch so restore works from anywhere — first recorded original endpoint wins.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

workspacestringRequired

Responses

201

Switch state recorded

No content

403

Forbidden - Requires role: owner, member, application

post/sfp/api/mocks/workspaces/{workspace}/switch-state

POST /sfp/api/mocks/workspaces/{workspace}/switch-state HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Restore switched credentials to their original endpoints, org-side

post

Resolves review-environment auth from the workspace context; force continues past per-credential failures.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

workspacestringRequired

Responses

200

Per-credential restore outcome

No content

403

Forbidden - Requires role: owner, member, application

post/sfp/api/mocks/workspaces/{workspace}/restore

POST /sfp/api/mocks/workspaces/{workspace}/restore HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Last updated 3 hours ago

Was this helpful?