WSO2

WSO2 Environments API

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

Documentation GitHub OpenAPI

Operations 6

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /environments List gateway environments · Get all registered Environments #

Ask an LLM

“Which gateway environments are registered?”

“What environments can I deploy APIs to?”

Tell an agent

List all gateway environments.

Show the registered gateway environments.

POST /environments Add a gateway environment · Add an Environment #

Ask an LLM

“Can I register a new gateway environment with its own virtual hosts?”

“What gateway type can a new environment use?”

Tell an agent

Add gateway environment {name} with vhosts {vhosts}.

Create environment {name} of gateway type {gatewayType} using vhosts {vhosts}.

GET /environments/{environmentId} Get a gateway environment · Get a Gateway Environment Configuration #

Ask an LLM

“What is the configuration of one gateway environment?”

“Can I look up an environment by its ID?”

Tell an agent

Show gateway environment {environmentId}.

Get the configuration of environment {environmentId}.

PUT /environments/{environmentId} Update a gateway environment · Update an Environment #

Ask an LLM

“Can I change the virtual hosts of an existing environment?”

“How do I edit a gateway environment's settings?”

Tell an agent

Update environment {environmentId} named {name} with vhosts {vhosts}.

Change the display name of environment {environmentId} ({name}, vhosts {vhosts}) to {displayName}.

DELETE /environments/{environmentId} Delete a gateway environment · Delete an Environment #

Ask an LLM

“Can I remove a gateway environment I no longer need?”

“Is deleting an environment possible from the admin side?”

Tell an agent destructive · confirm first

Delete gateway environment {environmentId}.

Remove environment {environmentId}.

GET /environments/{environmentId}/gateways List gateway instances in an environment · Get Gateway Instances in a Gateway Environment #

Ask an LLM

“Which gateway instances are running in an environment?”

“Can I see the gateway nodes attached to one environment?”

Tell an agent

List the gateway instances in environment {environmentId}.

Show the running gateway nodes of environment {environmentId}.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/wso2:wso2-environments-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: WSO2 API Manager - Admin Environments API
  description: This document specifies a **RESTful API** for WSO2 **API Manager** - **Admin Portal**.
  contact:
    name: WSO2
    url: https://wso2.com/api-manager/
    email: architecture@wso2.com
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  version: v4
servers:
- url: https://apis.wso2.com/api/am/admin/v4
tags:
- name: Environments
paths:
  /environments:
    get:
      tags:
      - Environments
      summary: Get all registered Environments
      description: Get all Registered Environments
      responses:
        200:
          description: 'OK.

            Environments returned

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvironmentList'
      security:
      - OAuth2Security:
        - apim:admin
        - apim:environment_read
      x-code-samples:
      - lang: Curl
        source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" "https://127.0.0.1:9443/api/am/admin/v4/environments"'
      operationId: getEnvironments
      x-operation-id-source: derived
    post:
      tags:
      - Environments
      summary: Add an Environment
      description: Add a new gateway environment
      requestBody:
        description: 'Environment object that should to be added

          '
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Environment'
        required: true
      responses:
        201:
          description: 'Created.

            Successful response with the newly created environment as entity in the body.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Environment'
        400:
          $ref: '#/components/responses/BadRequest'
      security:
      - OAuth2Security:
        - apim:admin
        - apim:environment_manage
      x-code-samples:
      - lang: Curl
        source: 'curl -k -X POST -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/admin/v4/environments"'
      operationId: postEnvironments
      x-operation-id-source: derived
  /environments/{environmentId}:
    get:
      tags:
      - Environments
      summary: Get a Gateway Environment Configuration
      description: Retrieve a single Gateway Environment Configuration. We should provide the Id of the Environment as a path parameter.
      parameters:
      - $ref: '#/components/parameters/environmentId'
      responses:
        200:
          description: 'OK.

            Gateway Environment Configuration returned

            '
          headers:
            Content-Type:
              description: 'The content type of the body.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Environment'
        404:
          $ref: '#/components/responses/NotFound'
        406:
          $ref: '#/components/responses/NotAcceptable'
      security:
      - OAuth2Security:
        - apim:admin
        - apim:environment_manage
      x-code-samples:
      - lang: Curl
        source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" "https://127.0.0.1:9443/api/am/admin/v4/environments/8d263942-a6df-4cc2-a804-7a2525501450"'
      operationId: getEnvironmentsByEnvironmentId
      x-operation-id-source: derived
    put:
      tags:
      - Environments
      summary: Update an Environment
      description: Update a gateway Environment by environment Id
      parameters:
      - $ref: '#/components/parameters/environmentId'
      requestBody:
        description: 'Environment object with updated information

          '
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Environment'
        required: true
      responses:
        200:
          description: 'OK.

            Environment updated.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Environment'
        400:
          $ref: '#/components/responses/BadRequest'
        404:
          $ref: '#/components/responses/NotFound'
      security:
      - OAuth2Security:
        - apim:admin
        - apim:environment_manage
      x-code-samples:
      - lang: Curl
        source: 'curl -k -X PUT -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/admin/v4/environments/d7cf8523-9180-4255-84fa-6cb171c1f779"'
      operationId: putEnvironmentsByEnvironmentId
      x-operation-id-source: derived
    delete:
      tags:
      - Environments
      summary: Delete an Environment
      description: Delete a Environment by Environment Id
      parameters:
      - $ref: '#/components/parameters/environmentId'
      responses:
        200:
          description: 'OK.

            Environment successfully deleted.

            '
          content: {}
        404:
          $ref: '#/components/responses/NotFound'
      security:
      - OAuth2Security:
        - apim:admin
        - apim:environment_manage
      x-code-samples:
      - lang: Curl
        source: 'curl -k -X DELETE -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" "https://127.0.0.1:9443/api/am/admin/v4/environments/d7cf8523-9180-4255-84fa-6cb171c1f779"'
      operationId: deleteEnvironmentsByEnvironmentId
      x-operation-id-source: derived
  /environments/{environmentId}/gateways:
    get:
      tags:
      - Environments
      summary: Get Gateway Instances in a Gateway Environment
      description: Retrieve list of gateway Instances in the gateway environment.
      parameters:
      - $ref: '#/components/parameters/environmentId'
      responses:
        200:
          description: 'OK.

            List of gateway Instances in the gateway environment returned

            '
          headers:
            Content-Type:
              description: 'The content type of the body.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GatewayInstanceList'
        400:
          $ref: '#/components/responses/BadRequest'
        404:
          $ref: '#/components/responses/NotFound'
        406:
          $ref: '#/components/responses/NotAcceptable'
      security:
      - OAuth2Security:
        - apim:admin
        - apim:environment_read
      x-code-samples:
      - lang: Curl
        source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" "https://127.0.0.1:9443/api/am/admin/v4/environments/8d263942-a6df-4cc2-a804-7a2525501450/gateways"'
      operationId: getEnvironmentsByEnvironmentIdGateways
      x-operation-id-source: derived
components:
  responses:
    NotFound:
      description: Not Found. The specified resource does not exist.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: 404
            message: Not Found
            description: The specified resource does not exist
            moreInfo: ''
            error: []
    NotAcceptable:
      description: Not Acceptable. The requested media type is not supported.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: 406
            message: Not Acceptable
            description: The requested media type is not supported
            moreInfo: ''
            error: []
    BadRequest:
      description: Bad Request. Invalid request or validation error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: 400
            message: Bad Request
            description: Invalid request or validation error
            moreInfo: ''
            error: []
  schemas:
    GatewayEnvironmentProtocolURI:
      title: Gateway Environment protocols and URIs
      required:
      - protocol
      - endpointURI
      type: object
      properties:
        protocol:
          type: string
          example: default
        endpointURI:
          type: string
          example: default
    GatewayInstance:
      title: Gateway instance in the gateway environment
      type: object
      required:
      - gatewayId
      properties:
        gatewayId:
          type: string
          example: Env1_1372344
        lastActive:
          type: string
          example: '2025-06-26T06:47:50Z'
        status:
          type: string
          example: ACTIVE
          default: ACTIVE
          enum:
          - ACTIVE
          - EXPIRED
    Environment:
      title: Environment
      required:
      - name
      - vhosts
      type: object
      properties:
        id:
          type: string
          readOnly: true
          example: ece92bdc-e1e6-325c-b6f4-656208a041e9
        name:
          maxLength: 255
          minLength: 1
          pattern: ^[a-zA-Z0-9_-]+$
          type: string
          example: us-region
        displayName:
          maxLength: 255
          minLength: 1
          type: string
          example: US Region
        provider:
          type: string
          example: wso2
        type:
          type: string
          default: hybrid
          example: hybrid
        gatewayType:
          type: string
          example: Regular
          default: Regular
        description:
          maxLength: 1023
          type: string
          example: Gateway environment in US Region
        isReadOnly:
          type: boolean
          example: false
          default: false
          deprecated: true
        mode:
          type: string
          enum:
          - READ_ONLY
          - READ_WRITE
          - WRITE_ONLY
          example: READ_WRITE
          default: WRITE_ONLY
          description: 'The mode of the environment. This indicates whether the environment is in read-only or read-write mode.

            **READ_ONLY:** The environment is in read-only mode. API cannot be deployed, only discovery is possible.

            **READ_WRITE:** The environment is in read-write mode. APIs can be deployed and discovered.

            **WRITE_ONLY:** The environment is in write-only mode/ APIs only can be deployed.

            '
        apiDiscoveryScheduledWindow:
          type: integer
          description: 'The time window in minutes to schedule the API discovery task.

            This is used to discover APIs from the API Gateway and update the API list in the environment.

            '
          default: 60
        vhosts:
          type: array
          minItems: 1
          items:
            $ref: '#/components/schemas/VHost'
        endpointURIs:
          type: array
          items:
            $ref: '#/components/schemas/GatewayEnvironmentProtocolURI'
        additionalProperties:
          type: array
          items:
            $ref: '#/components/schemas/AdditionalProperty'
        permissions:
          type: object
          properties:
            permissionType:
              type: string
              example: ALLOW
              default: PUBLIC
              enum:
              - PUBLIC
              - ALLOW
              - DENY
            roles:
              type: array
              items:
                type: string
                example: Internal/everyone
        status:
          type: string
          readOnly: true
          description: For platform gateway environments (gatewayType APIPlatform), connection status to the control plane (Active or Inactive).
          example: Active
          default: Active
          enum:
          - Active
          - Inactive
        vhost:
          type: string
          format: uri
          readOnly: true
          description: For platform gateway environments, the gateway URL (e.g. https://host:9443). Same as Platform Gateways API; only set when this environment represents a platform gateway.
          example: https://mg.wso2.com
        platformGatewayVersions:
          type: array
          readOnly: true
          description: API Platform Gateway versions from config. Set for deploy targets so UI can show version choices in the quick-start guide.
          items:
            type: string
            example: 1.0.0
    EnvironmentList:
      title: Environment List
      type: object
      properties:
        count:
          type: integer
          description: 'Number of Environments returned.

            '
          example: 1
        list:
          type: array
          items:
            $ref: '#/components/schemas/Environment'
    Error:
      title: Error object returned with 4XX HTTP status
      required:
      - code
      - message
      type: object
      properties:
        code:
          type: integer
          description: Error code
          format: int64
        message:
          type: string
          description: Error message.
        description:
          type: string
          description: 'A detail description about the error message.

            '
        moreInfo:
          type: string
          description: 'Preferably an url with more details about the error.

            '
        error:
          type: array
          description: 'If there are more than one error list them out.

            For example, list out validation errors by each field.

            '
          items:
            $ref: '#/components/schemas/ErrorListItem'
    GatewayInstanceList:
      title: Gateway instance list
      type: object
      properties:
        count:
          type: integer
          description: 'Number of Gateway Instances returned.

            '
          example: 1
        list:
          type: array
          items:
            $ref: '#/components/schemas/GatewayInstance'
    AdditionalProperty:
      title: Additional Gateway Properties
      type: object
      properties:
        key:
          type: string
          example: Organization
        value:
          type: string
          example: wso2
    ErrorListItem:
      title: Description of individual errors that may have occurred during a request.
      required:
      - code
      - message
      type: object
      properties:
        code:
          type: string
          description: Error code
        message:
          type: string
          description: 'Description about individual errors occurred

            '
    VHost:
      title: Virtual Host
      required:
      - host
      type: object
      properties:
        host:
          maxLength: 255
          minLength: 1
          type: string
          example: mg.wso2.com
        httpContext:
          maxLength: 255
          minLength: 0
          pattern: ^\/?([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])*$
          type: string
          example: pets
        httpPort:
          type: integer
          example: 80
        httpsPort:
          type: integer
          example: 443
        wsPort:
          type: integer
          example: 9099
        wsHost:
          type: string
          example: mg.wso2.com
        wssPort:
          type: integer
          example: 8099
        wssHost:
          type: string
          example: mg.wso2.com
  parameters:
    environmentId:
      name: environmentId
      in: path
      description: 'Environment UUID (or Environment name defined in config), in case the ID contains special characters it should

        be base64 encoded

        '
      required: true
      schema:
        type: string
  securitySchemes:
    OAuth2Security:
      type: oauth2
      flows:
        password:
          tokenUrl: https://localhost:9443/oauth2/token
          scopes:
            openid: Authorize access to user details
            apim:policies_import_export: Export and import policies related operations
            apim:admin: Manage all admin operations
            apim:tier_view: View throttling policies
            apim:tier_manage: Update and delete throttling policies
            apim:admin_tier_view: View throttling policies
            apim:admin_tier_manage: Update and delete throttling policies
            apim:bl_view: View deny policies
            apim:bl_manage: Update and delete deny policies
            apim:mediation_policy_view: View mediation policies
            apim:mediation_policy_create: Create and update mediation policies
            apim:app_owner_change: Retrieve and manage applications
            apim:app_settings_change: Change Application Settings
            apim:app_import_export: Import and export applications related operations
            apim:api_import_export: Import and export APIs related operations
            apim:api_product_import_export: Import and export API Products related operations
            apim:environment_manage: Manage gateway environments
            apim:environment_read: Retrieve gateway environments
            apim:monetization_usage_publish: Retrieve and publish Monetization related usage records
            apim:api_workflow_approve: Manage workflows
            apim:bot_data: Retrieve bot detection data
            apim:tenantInfo: Retrieve tenant related information
            apim:tenant_theme_manage: Manage tenant themes
            apim:admin_operations: Manage API categories and Key Managers related operations
            apim:api_category: Manage API categories
            apim:admin_settings: Retrieve admin settings
            apim:admin_alert_manage: Manage admin alerts
            apim:api_workflow_view: Retrive workflow requests
            apim:scope_manage: Manage system scopes
            apim:role_manage: Manage system roles
            apim:admin_application_view: View Applications
            apim:keymanagers_manage: Manage Key Managers
            apim:api_provider_change: Retrieve and manage applications
            apim:llm_provider_manage: Manage LLM Providers
            apim:gov_policy_read: Retrieve governance policies
            apim:gov_policy_manage: Manage governance policies
            apim:gov_result_read: Retrieve governance results
            apim:gov_rule_read: Retrieve governance rules
            apim:gov_rule_manage: Manage governance rules
            apim:organization_manage: Manage Organizations
            apim:organization_read: Read Organizations
x-provenance:
  method: harvested
  publisher: WSO2
  source: https://apim.docs.wso2.com/en/latest/reference/product-apis/admin-apis/admin-v4/admin-v4.yaml
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)

WSO2 Environments API

Operations 6

Documentation

Specifications

Schemas & Data

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification