Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

APIs.io Engineering Platform Workspaces API

The **Workspaces** endpoints enable you to manage your [workspaces](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/creating-workspaces/). The Workspaces endpoints let you manage your workspaces. Workspaces enable you to organize your Postman work and collaborate with teammates.

This API exposes 10 operations across 5 paths, and defines 3 schemas. It is described by OpenAPI 3.0.0, at version 2015-07-09.

Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.

10 operations 5 paths 3 schemas 1 DELETE5 GET1 PATCH1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2015-07-09
Base URL
https://{bucketname}.s3.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

APIs.io Engineering Platform Workspaces API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 10

Across 5 paths, the API surfaces 10 operations — 1 DELETE, 5 GET, 1 PATCH, 1 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Workspaces 10

The Workspaces endpoints enable you to manage your [workspaces](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/creating-workspaces/). The Workspaces e…

GET
/workspaces
APIs.io Engineering Platform Get all workspaces
getWorkspaces 3 params → 200401500
POST
/workspaces
APIs.io Engineering Platform Create a workspace
createWorkspace body → 200400401403500
GET
/workspaces-roles
APIs.io Engineering Platform Get all roles
getAllWorkspaceRoles → 200401403500
GET
/workspaces/{workspaceId}
APIs.io Engineering Platform Get a workspace
getWorkspace 2 params → 200401404500
PUT
/workspaces/{workspaceId}
APIs.io Engineering Platform Update a workspace
updateWorkspace 1 param body → 200400403404500
DELETE
/workspaces/{workspaceId}
APIs.io Engineering Platform Delete a workspace
deleteWorkspace 1 param → 200400401500
GET
/workspaces/{workspaceId}/global-variables
APIs.io Engineering Platform Get global variables
getWorkspaceGlobalVariables 1 param → 200500
PUT
/workspaces/{workspaceId}/global-variables
APIs.io Engineering Platform Update global variables
updateWorkspaceGlobalVariables 1 param body → 200500
PATCH
/workspaces/{workspaceId}/roles
APIs.io Engineering Platform Update user or user group roles
updateWorkspaceRoles 2 params body → 200400401403404422500
GET
/workspaces/{workspaceId}/roles
APIs.io Engineering Platform Get a workspace's roles
getWorkspaceRoles 2 params → 200401403404500

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are globalVariable (4 properties), getWorkspaceRoles (1 property). Each schema is shown below with its type and property counts.

getWorkspaceRoles
object
Information about the workspace's roles.
1 property
workspaceId
string
globalVariable
object
Information about the global variable.
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-workspaces-api-openapi.yml Raw ↑