Mock Scenarios

List scenarios for a workspace

get

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

workspacestringRequired

Responses

200

Scenario summaries

No content

403

Forbidden - Requires role: owner, member, application

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

HTTPcURLJavaScriptPython

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

No content

Start capturing a scenario

post

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

workspacestringRequired

Body

application/json

namestringRequired

Responses

201

Recording started

No content

403

Forbidden - Requires role: owner, member, application

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

HTTPcURLJavaScriptPython

POST /sfp/api/mocks/workspaces/{workspace}/scenarios HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}

No content

Stop capturing — journal slice becomes steps

post

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

workspacestringRequired

namestringRequired

Responses

200

Scenario captured with step summary

No content

403

Forbidden - Requires role: owner, member, application

post/sfp/api/mocks/workspaces/{workspace}/scenarios/{name}/stop

HTTPcURLJavaScriptPython

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

No content

Get a scenario with steps

get

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

workspacestringRequired

namestringRequired

Responses

200

Full scenario

No content

403

Forbidden - Requires role: owner, member, application

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

HTTPcURLJavaScriptPython

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

No content

Delete a scenario

delete

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

workspacestringRequired

namestringRequired

Responses

200

Scenario removed

No content

403

Forbidden - Requires role: owner, member, application

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

HTTPcURLJavaScriptPython

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

No content

Edit a step's replayed response

put

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

workspacestringRequired

namestringRequired

seqstringRequired

Body

application/json

Responses

200

Step updated

No content

403

Forbidden - Requires role: owner, member, application

put/sfp/api/mocks/workspaces/{workspace}/scenarios/{name}/steps/{seq}

HTTPcURLJavaScriptPython

PUT /sfp/api/mocks/workspaces/{workspace}/scenarios/{name}/steps/{seq} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 94

{
  "response": {
    "status": 1,
    "body": null,
    "headers": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "delayMs": 1
  }
}

No content

Arm — replay this scenario on the next clickthrough

post

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

workspacestringRequired

namestringRequired

Responses

200

Scenario armed; per-service stub counts

No content

403

Forbidden - Requires role: owner, member, application

post/sfp/api/mocks/workspaces/{workspace}/scenarios/{name}/arm

HTTPcURLJavaScriptPython

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

No content

Disarm — baseline rules apply again

delete

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

workspacestringRequired

namestringRequired

Responses

200

Scenario disarmed

No content

403

Forbidden - Requires role: owner, member, application

delete/sfp/api/mocks/workspaces/{workspace}/scenarios/{name}/arm

HTTPcURLJavaScriptPython

DELETE /sfp/api/mocks/workspaces/{workspace}/scenarios/{name}/arm HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Rewind sequences to the first response

post

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

workspacestringRequired

namestringRequired

Responses

200

Sequences restarted

No content

403

Forbidden - Requires role: owner, member, application

post/sfp/api/mocks/workspaces/{workspace}/scenarios/{name}/rewind

HTTPcURLJavaScriptPython

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

No content

Export as a committable scenario playbook

get

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

workspacestringRequired

namestringRequired

Responses

200

scenario yaml

No content

403

Forbidden - Requires role: owner, member, application

get/sfp/api/mocks/workspaces/{workspace}/scenarios/{name}/export.yaml

HTTPcURLJavaScriptPython

GET /sfp/api/mocks/workspaces/{workspace}/scenarios/{name}/export.yaml HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content