POST /workspaces
This endpoint allows you to create a workspace and populate it with entities like collections, environments, mocks and monitors using their uid.
On successful creation of the workspace, the response returns the workspcae name and id.
Requires API Key as
X-Api-Keyrequest header orapikeyURL query parameter.
Servers
- https://api.getpostman.com
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
workspace |
Object | No | |
workspace.environments[] |
Array | No | |
workspace.environments[].id |
String | No | |
workspace.environments[].name |
String | No | |
workspace.environments[].uid |
String | No | |
workspace.name |
String | No | |
workspace.description |
String | No | |
workspace.monitors[] |
Array | No | |
workspace.monitors[].id |
String | No | |
workspace.type |
String | No | |
workspace.collections[] |
Array | No | |
workspace.collections[].id |
String | No | |
workspace.collections[].name |
String | No | |
workspace.collections[].uid |
String | No | |
workspace.mocks[] |
Array | No | |
workspace.mocks[].id |
String | No |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.