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 Services API

The Services API from WSO2 — 6 operation(s) for services.

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

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

This API exposes 9 operations across 6 paths, and defines 10 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.

9 operations 6 paths 10 schemas 1 DELETE5 GET2 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 Services API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2Security) using the password flow, exposing 41 scopes.

Paths & Operations 9

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

Services 9
GET
/services
Retrieve/search services
searchServices 9 params → 200400401500
POST
/services
Add a new service to Service Catalog
addService body → 201400401415500
GET
/services/{serviceId}
Get details of a service
getServiceById 1 param → 200400401404500
PUT
/services/{serviceId}
Update a service
updateService 1 param body → 200400401404500
DELETE
/services/{serviceId}
Delete a service
deleteService 1 param → 204400401404409500
GET
/services/{serviceId}/definition
Retrieve a service definition
getServiceDefinition 1 param → 200400401404500
GET
/services/{serviceId}/usage
Retrieve the API Info that use the given service
getServiceUsage 1 param → 200400401404500
POST
/services/import
Import a service
importService 1 param body → 200400401500
GET
/services/export
Export a service
exportService 2 params → 200401404500

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are Service (14 properties), APIInfo (6 properties), Error (5 properties), ServiceInfo (5 properties). Each schema is shown below with its type and property counts.

ErrorListItem
object
3 properties 2 required
ServiceInfo
object
5 properties
Error
object
5 properties 2 required
Pagination
object
5 properties
APIList
object
2 properties
Service
object
14 properties 4 required
ServiceSchema
object
3 properties 1 required
ServiceList
object
2 properties
ServiceInfoList
object
2 properties
APIInfo
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wso2-services-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