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

WSO2 Environments API

The Environments API from WSO2 — 3 operation(s) for environments.

WSO2 Environments API is one of 90 APIs that WSO2 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Environments. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 6 operations across 3 paths, and defines 9 schemas. It is described by OpenAPI 3.0.1, at version v4.

Requests are made against a single base URL, https://apis.wso2.com/api/am/admin/v4.

6 operations 3 paths 9 schemas 1 DELETE3 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
v4
Base URL
https://apis.wso2.com
Authentication
OAuth 2.0
Contact
License
Resource Areas
1

Authentication & Security 1

WSO2 Environments API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2Security) using the password flow, exposing 41 scopes.

Paths & Operations 6

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

Environments 6
GET
/environments
Get all registered Environments
→ 200
POST
/environments
Add an Environment
body → 201400
GET
/environments/{environmentId}
Get a Gateway Environment Configuration
1 param → 200404406
PUT
/environments/{environmentId}
Update an Environment
1 param body → 200400404
DELETE
/environments/{environmentId}
Delete an Environment
1 param → 200404
GET
/environments/{environmentId}/gateways
Get Gateway Instances in a Gateway Environment
1 param → 200400404406

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are Environment (17 properties), VHost (8 properties), Error (5 properties), GatewayInstance (3 properties). Each schema is shown below with its type and property counts.

GatewayEnvironmentProtocolURI
object
2 properties 2 required
AdditionalProperty
object
2 properties
ErrorListItem
object
2 properties 2 required
GatewayInstance
object
3 properties 1 required
Environment
object
17 properties 2 required
EnvironmentList
object
2 properties
Error
object
5 properties 2 required
VHost
object
8 properties 1 required
GatewayInstanceList
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wso2-environments-api-openapi.yml Raw ↑

Other APIs WSO2 publishes across the network.

WSO2 Advanced Policy (Collection) API
WSO2 Advanced Policy (Individual) API
WSO2 AIServiceProvider API
WSO2 AIServiceProviders API
WSO2 Alert Subscriptions API
WSO2 Alerts API
WSO2 Api Artifact API
WSO2 API Categories API
WSO2 API Category (Collection) API
WSO2 API Category (Individual) API
WSO2 API Chat API
WSO2 API Documents API