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 Workspace Tags API

The **Workspace Tags** endpoints enable you to manage workspace tags with Postman's [tagging](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/managing-workspaces/#tagging-a-workspace) feature. Tagging is available on Postman [**Enterprise** plans](https://www.postman.com/pricing/).

This API exposes 2 operations across 1 path, and defines 7 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.

2 operations 1 paths 7 schemas 1 GET1 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 Workspace Tags 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 2

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

Workspace Tags 2

The Workspace Tags endpoints enable you to manage workspace tags with Postman's [tagging](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/managing-work…

GET
/workspaces/{workspaceId}/tags
APIs.io Engineering Platform Get a workspace's tags
getWorkspaceTags 1 param → 200401403404500
PUT
/workspaces/{workspaceId}/tags
APIs.io Engineering Platform Update a workspace's tags
updateWorkspaceTags 1 param body → 200400401403404500

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are tag404Error (5 properties), tag500Error (5 properties), tag400Error (4 properties), tag403Error (4 properties). Each schema is shown below with its type and property counts.

tag401Error
object
4 properties
workspaceId
string
tag403Error
object
4 properties
tag400Error
object
4 properties
tag500Error
object
5 properties
tag404Error
object
5 properties
tagGetPut
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-workspace-tags-api-openapi.yml Raw ↑