{ "opencollection": "1.0.0", "info": { "name": "APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Workspaces API", "version": "1.0.0" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Workspaces", "type": "folder" }, "items": [ { "info": { "name": "APIs.io Engineering Platform Get all workspaces", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/workspaces", "params": [ { "name": "type", "value": "", "type": "query", "description": "The type of workspace to filter the response by." }, { "name": "createdBy", "value": "", "type": "query", "description": "Return only workspaces created by a specific user ID. For multiple users, pass this value as a comma-separated list of user IDs. The response only returns workspaces that you have access to." }, { "name": "include", "value": "", "type": "query", "description": "Include the following information in the endpoint's response:\n- `mocks:deactivated` — Include all deactivated mock servers in the response.\n- `scim` — Return the SCIM user IDs of the workspace creator and who last modified it.\n" } ] }, "docs": "Gets all [workspaces](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/creating-workspaces/). The response includes your workspaces and any workspaces that you have access to.\n\n**Note:**\n\nThis endpoint's response contains the visibility field. Visibility determines who can access the workspace:\n- `personal` — Only you can access the workspace.\n- `team` — All team members can access the workspace.\n- `private` — Only invited team members can access the workspace ([**Prof" }, { "info": { "name": "APIs.io Engineering Platform Create a workspace", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/workspaces", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new [workspace](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/creating-workspaces/).\n\n**Note:**\n\nThis endpoint returns a 403 `Forbidden` response if the user does not have permission to create workspaces. [Admins and Super Admins](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#team-roles) can configure workspace permissions to restrict users and/or user groups from creating workspaces or require approvals for the creation" }, { "info": { "name": "APIs.io Engineering Platform Get all roles", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/workspaces-roles" }, "docs": "Gets information about all roles in a workspace, based on the team's [plan](https://www.postman.com/pricing/).\n" }, { "info": { "name": "APIs.io Engineering Platform Get a workspace", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/workspaces/:workspaceId", "params": [ { "name": "workspaceId", "value": "", "type": "path", "description": "The workspace's ID." }, { "name": "include", "value": "", "type": "query", "description": "Include the following information in the endpoint's response:\n- `mocks:deactivated` — Include all deactivated mock servers in the response.\n- `scim` — Return the SCIM user IDs of the workspace creator and who last modified it.\n" } ] }, "docs": "Gets information about a workspace.\n\n**Note:**\n\nThis endpoint's response contains the `visibility` field. [Visibility](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/managing-workspaces/#changing-workspace-visibility) determines who can access the workspace:\n- `personal` — Only you can access the workspace.\n- `team` — All team members can access the workspace.\n- `private` — Only invited team members can access the workspace ([**Professional** and **Enterprise** plans" }, { "info": { "name": "APIs.io Engineering Platform Update a workspace", "type": "http" }, "http": { "method": "PUT", "url": "http://apigateway.{region}.amazonaws.com/workspaces/:workspaceId", "params": [ { "name": "workspaceId", "value": "", "type": "path", "description": "The workspace's ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a workspace.\n\n### Important\n\nWe deprecated linking collections or environments between workspaces. We do not recommend that you do this.\n\nIf you have a linked collection or environment, note the following:\n- The endpoint does not create a clone of a collection or environment.\n- Any changes you make to a linked collection or environment changes them in all workspaces.\n- If you delete a collection or environment linked between workspaces, the system deletes it in all the workspaces.\n" }, { "info": { "name": "APIs.io Engineering Platform Delete a workspace", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/workspaces/:workspaceId", "params": [ { "name": "workspaceId", "value": "", "type": "path", "description": "The workspace's ID." } ] }, "docs": "Deletes an existing workspace.\n\n### Important\n\nIf you delete a workspace that has a linked collection or environment with another workspace, this will delete the collection and environment in all workspaces.\n" }, { "info": { "name": "APIs.io Engineering Platform Get global variables", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/workspaces/:workspaceId/global-variables", "params": [ { "name": "workspaceId", "value": "", "type": "path", "description": "The workspace's ID." } ] }, "docs": "Gets a workspace's global [variables](https://learning.postman.com/docs/sending-requests/variables/#variable-scopes)." }, { "info": { "name": "APIs.io Engineering Platform Update global variables", "type": "http" }, "http": { "method": "PUT", "url": "http://apigateway.{region}.amazonaws.com/workspaces/:workspaceId/global-variables", "params": [ { "name": "workspaceId", "value": "", "type": "path", "description": "The workspace's ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates and replaces a workspace's global [variables](https://learning.postman.com/docs/sending-requests/variables/#variable-scopes). This endpoint replaces all existing global variables with the variables you pass in the request body." }, { "info": { "name": "APIs.io Engineering Platform Get a workspace's roles", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/workspaces/:workspaceId/roles", "params": [ { "name": "workspaceId", "value": "", "type": "path", "description": "The workspace's ID." }, { "name": "include", "value": "", "type": "query", "description": "Include the following information in the endpoint's response:\n- `scim` — Return IDs as SCIM user and group IDs.\n" } ] }, "docs": "Gets the roles of users and user groups in a workspace:\n- `Viewer` — Can view, fork, and export workspace resources.\n- `Editor` — Can create and edit workspace resources.\n- `Admin` — Can manage workspace details and members.\n" }, { "info": { "name": "APIs.io Engineering Platform Update user or user group roles", "type": "http" }, "http": { "method": "PATCH", "url": "http://apigateway.{region}.amazonaws.com/workspaces/:workspaceId/roles", "headers": [ { "name": "identifierType", "value": "" } ], "params": [ { "name": "workspaceId", "value": "", "type": "path", "description": "The workspace's ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the roles of [users](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#team-roles) or [user groups](https://learning.postman.com/docs/collaborating-in-postman/user-groups/) in a workspace. To get a list of roles, use the `GET /workspace-roles` endpoint.\n\n**Note:**\n\n- To use SCIM IDs, include the `identifierType=scim` header when you call this endpoint. To get SCIM user IDs, include the `include=scim` query parameter when calling the GET `/workspaces/{works" } ] } ], "bundled": true }