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 Global Variables API

The **Global Variables** endpoints enable you to manage global [variables](https://learning.postman.com/docs/sending-requests/variables/). Global variables are available throughout a workspace and have the broadest scope in Postman.

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

Global Variables 2

The Global Variables endpoints enable you to manage global [variables](https://learning.postman.com/docs/sending-requests/variables/). Global variables are available throughout a…

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

Schemas 2

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

workspaceId
string
globalVariable
object
Information about the global variable.
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-global-variables-api-openapi.yml Raw ↑