WSO2

WSO2 Services API

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

Documentation GitHub OpenAPI

Operations 9

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 /services Search the service catalog · Retrieve/search services #

Ask an LLM

“Which services are registered in our service catalog?”

“Can I find a service in the catalog by name and version?”

Tell an agent

Search the service catalog for services named {name}.

Find catalog services with definition type {definitionType}.

POST /services Add a service to the service catalog · Add a new service to Service Catalog #

Ask an LLM

“How do I register a new service with its definition in the service catalog?”

“Can I add a catalog service by pasting the definition inline instead of uploading a file?”

Tell an agent

Add a new service to the catalog with metadata {serviceMetadata}.

Register a catalog service using {serviceMetadata} and definition file {definitionFile}.

GET /services/{serviceId} Get a catalog service's details · Get details of a service #

Ask an LLM

“What details does the catalog hold for a specific service?”

“Can I look up one catalog service by its id?”

Tell an agent

Show details of catalog service {serviceId}.

Get service {serviceId} from the service catalog.

PUT /services/{serviceId} Update a catalog service · Update a service #

Ask an LLM

“How do I update a catalog service's metadata and definition?”

“Can I replace the definition of a service already in the catalog?”

Tell an agent

Update catalog service {serviceId} with metadata {serviceMetadata}.

Replace the definition of service {serviceId} with {definitionFile}.

DELETE /services/{serviceId} Delete a catalog service · Delete a service #

Ask an LLM

“How do I remove a service from the service catalog?”

“Can a service be deleted from the catalog by its id?”

Tell an agent destructive · confirm first

Delete service {serviceId} from the service catalog.

Remove catalog service {serviceId}.

GET /services/{serviceId}/definition Get a catalog service's definition · Retrieve a service definition #

Ask an LLM

“Where can I download the API definition stored for a catalog service?”

“Can I read the raw definition file behind a service in the catalog?”

Tell an agent

Get the definition of catalog service {serviceId}.

Show the stored definition for service {serviceId}.

GET /services/{serviceId}/usage List APIs that use a catalog service · Retrieve the API Info that use the given service #

Ask an LLM

“Which APIs are built on a particular catalog service?”

“Can I see the name, context and version of every API using a service?”

Tell an agent

List the APIs that use catalog service {serviceId}.

Show which APIs depend on service {serviceId}.

POST /services/import Import a service from an archive · Import a service #

Ask an LLM

“How do I import a service into the catalog from a zip archive?”

“Can an imported service overwrite one with the same name and version?”

Tell an agent

Import the service archive {file} into the catalog.

Import service archive {file} and overwrite any existing match ({overwrite}).

GET /services/export Export a service as a zip archive · Export a service #

Ask an LLM

“How do I export a catalog service as a zip file?”

“Can I download a specific version of a service as an archive?”

Tell an agent

Export service {name} version {version} as a zip.

Download the archive for catalog service {name} {version}.

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-services-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: Service Catalog Services API
  description: This specifies a **RESTful API** for Service Catalog.
  version: '1.2'
servers:
- url: https://apis.wso2.com/api/service-catalog/v1
- url: http://apis.wso2.com/api/service-catalog/v1
tags:
- name: Services
paths:
  /services:
    get:
      summary: Retrieve/search services
      description: 'Retrieve or search services in the service catalog of the user''s organization or tenant. Search is supported

        using the name, version, definitionType and key of the service.

        Search based on the definition type and key of the service will always be an exact search. If you want to

        execute an exact search for either name or version the parameter should be given inside double quotation.'
      operationId: searchServices
      security:
      - OAuth2Security:
        - service_catalog:service_view
        - apim:api_view
      tags:
      - Services
      parameters:
      - name: name
        in: query
        description: 'Filter services by the name of the service

          '
        schema:
          type: string
      - name: version
        in: query
        description: 'Filter services by version of the service

          '
        schema:
          type: string
      - name: definitionType
        in: query
        description: 'Filter services by definitionType

          '
        schema:
          type: string
          enum:
          - OAS
          - WSDL1
          - WSDL2
          - GRAPHQL_SDL
          - ASYNC_API
      - name: key
        in: query
        description: 'Comma seperated keys of the services to check

          '
        schema:
          type: string
      - name: shrink
        in: query
        description: 'If this set to true, a minimal set of fields will be provided for each service including the md5

          '
        schema:
          type: boolean
          default: false
      - $ref: '#/components/parameters/sortBy'
      - $ref: '#/components/parameters/sortOrder'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      responses:
        200:
          description: 'Paginated matched list of services returned.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceList'
        400:
          $ref: '#/components/responses/BadRequest'
        401:
          $ref: '#/components/responses/Unauthorized'
        500:
          $ref: '#/components/responses/InternalServerError'
      x-code-samples:
      - lang: Curl
        label: Exact search by name
        source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" "https://127.0.0.1:9443/api/am/service-catalog/v1/services?name=%22Pet%20Service%22"'
      - lang: Curl
        label: Matching search by name
        source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" "https://127.0.0.1:9443/api/am/service-catalog/v1/services?name=Pet%20Service"'
      - lang: Curl
        label: Exact search by version
        source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" "https://127.0.0.1:9443/api/am/service-catalog/v1/services?version=%221.0.0%22"'
      - lang: Curl
        label: Matching search by version
        source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" "https://127.0.0.1:9443/api/am/service-catalog/v1/services?version=1.0.0"'
      - lang: Curl
        label: Get all versions of a service
        source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" "https://127.0.0.1:9443/api/am/service-catalog/v1/services?name=%22Pet%20Service%22"'
    post:
      summary: Add a new service to Service Catalog
      description: 'Add a new service to the service catalog of the user''s organization (or tenant)

        by specifying the details of the service along with its definition.'
      security:
      - OAuth2Security:
        - service_catalog:service_write
      tags:
      - Services
      operationId: addService
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ServiceSchema'
      responses:
        201:
          description: 'Created.

            Successful response with the newly created service as the response payload

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Service'
        400:
          $ref: '#/components/responses/BadRequest'
        401:
          $ref: '#/components/responses/Unauthorized'
        415:
          $ref: '#/components/responses/UnsupportedMediaType'
        500:
          $ref: '#/components/responses/InternalServerError'
      x-code-samples:
      - lang: Curl
        source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" -F "definitionFile=@definition.yaml" -F "serviceMetadata=@metadata.json;type=application/json" "https://127.0.0.1:9443/api/am/service-catalog/v1/services"'
  /services/{serviceId}:
    get:
      summary: Get details of a service
      description: Get details of a service using the id of the service.
      security:
      - OAuth2Security:
        - service_catalog:service_view
        - apim:api_view
      operationId: getServiceById
      tags:
      - Services
      parameters:
      - $ref: '#/components/parameters/serviceId'
      responses:
        200:
          description: 'Requested service in the service catalog is returned.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Service'
        400:
          $ref: '#/components/responses/BadRequest'
        401:
          $ref: '#/components/responses/Unauthorized'
        404:
          $ref: '#/components/responses/NotFound'
        500:
          $ref: '#/components/responses/InternalServerError'
      x-code-samples:
      - lang: Curl
        source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" "https://127.0.0.1:9443/api/am/service-catalog/v1/services"'
    put:
      summary: Update a service
      description: Update a service's details and definition
      security:
      - OAuth2Security:
        - service_catalog:service_write
      operationId: updateService
      tags:
      - Services
      parameters:
      - $ref: '#/components/parameters/serviceId'
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ServiceSchema'
      responses:
        200:
          description: 'Updated.

            Successful response with the newly updated service as entity in the body.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Service'
        400:
          $ref: '#/components/responses/BadRequest'
        401:
          $ref: '#/components/responses/Unauthorized'
        404:
          $ref: '#/components/responses/NotFound'
        500:
          $ref: '#/components/responses/InternalServerError'
      x-code-samples:
      - lang: Curl
        source: 'curl -k -X PUT -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" -F "definitionFile=@definition.yaml" -F "serviceMetadata=@metadata.json;type=application/json" "https://127.0.0.1:9443/api/am/service-catalog/v1/services/7b3d976a-620a-4435-9649-e806f30dc7cf"'
    delete:
      summary: Delete a service
      description: Delete a service by providing the service id
      security:
      - OAuth2Security:
        - service_catalog:service_write
      operationId: deleteService
      tags:
      - Services
      parameters:
      - $ref: '#/components/parameters/serviceId'
      responses:
        204:
          description: 'Successfully deleted the catalog entry.

            '
        400:
          $ref: '#/components/responses/BadRequest'
        401:
          $ref: '#/components/responses/Unauthorized'
        404:
          $ref: '#/components/responses/NotFound'
        409:
          $ref: '#/components/responses/Conflict'
        500:
          $ref: '#/components/responses/InternalServerError'
      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/service-catalog/v1/services/32b4541f-ce7e-47a6-9c0c-c3db18128c50"'
  /services/{serviceId}/definition:
    get:
      summary: Retrieve a service definition
      description: Retrieve the definition of a service identified by the service id.
      security:
      - OAuth2Security:
        - service_catalog:service_view
        - apim:api_view
      operationId: getServiceDefinition
      tags:
      - Services
      parameters:
      - $ref: '#/components/parameters/serviceId'
      responses:
        200:
          description: 'Successful response with the definition file as entity in the body.

            '
          content:
            application/json:
              schema:
                type: string
            application/yaml:
              schema:
                type: string
                format: binary
        400:
          $ref: '#/components/responses/BadRequest'
        401:
          $ref: '#/components/responses/Unauthorized'
        404:
          $ref: '#/components/responses/NotFound'
        500:
          $ref: '#/components/responses/InternalServerError'
      x-code-samples:
      - lang: Curl
        source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" "https://127.0.0.1:9443/api/am/service-catalog/v1/services/3784c2da-2f2a-4af9-8a43-ef207fb4d739/definition"'
  /services/{serviceId}/usage:
    get:
      summary: Retrieve the API Info that use the given service
      description: Retrieve the id, name, context and version of the APIs that used by the service
      security:
      - OAuth2Security:
        - service_catalog:service_view
        - apim:api_view
      operationId: getServiceUsage
      tags:
      - Services
      parameters:
      - $ref: '#/components/parameters/serviceId'
      responses:
        200:
          description: 'List of APIs that uses the service in the service catalog is returned.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIList'
        400:
          $ref: '#/components/responses/BadRequest'
        401:
          $ref: '#/components/responses/Unauthorized'
        404:
          $ref: '#/components/responses/NotFound'
        500:
          $ref: '#/components/responses/InternalServerError'
      x-code-samples:
      - lang: Curl
        source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" "https://127.0.0.1:9443/api/am/service-catalog/v1/services/3784c2da-2f2a-4af9-8a43-ef207fb4d739/usage"'
  /services/import:
    post:
      summary: Import a service
      description: Import a service by providing an archived service
      security:
      - OAuth2Security:
        - service_catalog:service_write
      operationId: importService
      tags:
      - Services
      parameters:
      - name: overwrite
        in: query
        description: 'Whether to overwrite if there is any existing service with the same name and version.

          '
        required: false
        schema:
          type: boolean
          default: false
      requestBody:
        required: false
        content:
          multipart/form-data:
            schema:
              required:
              - file
              properties:
                file:
                  type: string
                  description: 'Zip archive consisting of exported Application Configuration.

                    '
                  format: binary
                verifier:
                  type: string
      responses:
        200:
          description: 'Successful response with the imported service metadata.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceInfoList'
          headers:
            ETag:
              $ref: '#/components/headers/ETag'
        400:
          $ref: '#/components/responses/BadRequest'
        401:
          $ref: '#/components/responses/Unauthorized'
        500:
          $ref: '#/components/responses/InternalServerError'
      x-code-samples:
      - lang: Curl
        source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" -F "file=@services.zip" "https://127.0.0.1:9443/api/am/service-catalog/v1/services/import?overwrite=true"'
  /services/export:
    get:
      summary: Export a service
      description: Export a service as an archived zip file.
      security:
      - OAuth2Security:
        - service_catalog:service_view
      operationId: exportService
      tags:
      - Services
      parameters:
      - name: name
        in: query
        description: 'Name of the service to export

          '
        required: true
        schema:
          type: string
      - name: version
        in: query
        description: 'Version of the service to export

          '
        required: true
        schema:
          type: string
      responses:
        200:
          description: 'Successful response as the exported service as a zipped archive.

            '
          content:
            application/zip:
              schema:
                type: string
                format: binary
          headers:
            ETag:
              $ref: '#/components/headers/ETag'
        401:
          $ref: '#/components/responses/Unauthorized'
        404:
          $ref: '#/components/responses/NotFound'
        500:
          $ref: '#/components/responses/InternalServerError'
      x-code-samples:
      - lang: Curl
        source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" "https://127.0.0.1:9443/api/am/service-catalog/v1/services/export?name=Single1Curl&version=1.0.0" > services.zip'
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: []
    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: []
    Conflict:
      description: Conflict. Specified resource already exists.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: 409
            message: Conflict
            description: Specified resource already exists
            moreInfo: ''
            error: []
    Unauthorized:
      description: Unauthorized. The user is not authorized.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: 401
            message: Unauthorized
            description: The user is not authorized
            moreInfo: ''
            error: []
    InternalServerError:
      description: Internal Server Error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: 500
            message: Internal Server Error
            description: The server encountered an internal error. Please contact administrator.
            moreInfo: ''
            error: []
    UnsupportedMediaType:
      description: Unsupported Media Type. The entity of the request was not in a supported format.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: 415
            message: Unsupported media type
            description: The entity of the request was not in a supported format
            moreInfo: ''
            error: []
  schemas:
    ServiceInfoList:
      title: Services List
      type: object
      properties:
        count:
          type: integer
          description: 'MD5 hashes of services returned.

            '
          example: 1
        list:
          type: array
          items:
            $ref: '#/components/schemas/ServiceInfo'
    Pagination:
      title: Pagination
      properties:
        offset:
          type: integer
          example: 0
        limit:
          type: integer
          example: 1
        total:
          type: integer
          example: 10
        next:
          type: string
          description: 'Link to the next subset of resources qualified.

            Empty if no more resources are to be returned.

            '
        previous:
          type: string
          description: 'Link to the previous subset of resources qualified.

            Empty if current subset is the first subset returned.

            '
    Service:
      type: object
      title: The Service Object
      required:
      - name
      - version
      - definitionType
      - serviceUrl
      properties:
        id:
          type: string
          example: 01234567-0123-0123-0123-012345678901
          readOnly: true
        name:
          type: string
          pattern: ^[^\*]+$
          example: Pizzashack-Endpoint
          maxLength: 255
          minLength: 1
        description:
          type: string
          example: A Catalog Entry that exposes a REST endpoint
          maxLength: 1024
        version:
          type: string
          example: v1
          maxLength: 30
          minLength: 1
        serviceKey:
          type: string
          example: Pizzashack-Endpoint-1.0.0
          maxLength: 512
        serviceUrl:
          type: string
          example: http://localhost/pizzashack
        definitionType:
          type: string
          description: The type of the provided API definition
          example: OAS3
          enum:
          - OAS2
          - OAS3
          - WSDL1
          - WSDL2
          - GRAPHQL_SDL
          - ASYNC_API
        securityType:
          type: string
          description: The security type of the endpoint
          example: BASIC
          enum:
          - BASIC
          - DIGEST
          - OAUTH2
          - X509
          - API_KEY
          - NONE
          default: NONE
        mutualSSLEnabled:
          type: boolean
          description: Whether Mutual SSL is enabled for the endpoint
          default: false
          example: false
        usage:
          type: integer
          description: Number of usages of the service in APIs
          readOnly: true
          example: 1
        createdTime:
          type: string
          readOnly: true
          example: '2020-02-20T13:57:16.229'
        lastUpdatedTime:
          type: string
          readOnly: true
          example: '2020-02-20T13:57:16.229'
        md5:
          type: string
          example: 36583a6a249b410e7fc4f892029709cac09763ddb230e1a829d5f9134d1abd07
        definitionUrl:
          type: string
          example: https://petstore.swagger.io/v2/swagger.json
    APIInfo:
      title: API Info object with basic API details.
      type: object
      properties:
        id:
          type: string
          example: 01234567-0123-0123-0123-012345678901
        name:
          type: string
          example: CalculatorAPI
        displayName:
          type: string
          example: Calculator API
          description: 'Display name of the API.

            This is the name that will be displayed in the Publisher and DevPortal.

            If not provided, the name will be used as the display name.

            '
        context:
          type: string
          example: CalculatorAPI
        version:
          type: string
          example: 1.0.0
        provider:
          type: string
          example: admin
    ServiceInfo:
      type: object
      title: The Service Info object
      properties:
        id:
          type: string
          example: 01234567-0123-0123-0123-012345678901
          readOnly: true
        name:
          type: string
          pattern: ^[^\*]+$
          example: PizzashackEndpoint
        key:
          type: string
          example: PizzashackEndpoint-1.0.0
        version:
          type: string
          example: v1
        md5:
          type: string
          example: 36583a6a249b410e7fc4f892029709cac09763ddb230e1a829d5f9134d1abd07
    Error:
      type: object
      title: Error object returned with 4XX HTTP Status
      required:
      - code
      - message
      properties:
        code:
          type: integer
          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'
    ServiceList:
      type: object
      title: Paginated List of Services in Service Catalog
      properties:
        list:
          type: array
          title: List of Services in Service Catalog
          items:
            $ref: '#/components/schemas/Service'
        pagination:
          $ref: '#/components/schemas/Pagination'
    ErrorListItem:
      type: object
      title: Description of individual errors that may have occurred during a request.
      required:
      - code
      - message
      properties:
        code:
          type: string
        message:
          type: string
          description: 'Description about individual errors occurred

            '
        description:
          type: string
          description: 'A detail description about the error message.

            '
    APIList:
      title: API List
      type: object
      properties:
        count:
          type: integer
          description: 'Number of APIs returned.

            '
          example: 1
        list:
          type: array
          items:
            $ref: '#/components/schemas/APIInfo'
    ServiceSchema:
      type: object
      title: The Service Schema object
      required:
      - serviceMetadata
      properties:
        serviceMetadata:
          $ref: '#/components/schemas/Service'
        definitionFile:
          type: string
          format: binary
        inlineContent:
          type: string
          description: Inline content of the document
  headers:
    ETag:
      schema:
        type: string
      description: A hash-like string value which represents the current state of a resource
  parameters:
    sortBy:
      name: sortBy
      in: query
      schema:
        type: string
        enum:
        - name
        - definitionType
    limit:
      name: limit
      in: query
      description: 'Maximum limit of items to return.

        '
      schema:
        type: integer
        default: 25
    offset:
      name: offset
      in: query
      description: 'Starting point within the complete list of items qualified.

        '
      schema:
        type: integer
        default: 0
    sortOrder:
      name: sortOrder
      in: query
      schema:
        type: string
        enum:
        - asc
        - desc
    serviceId:
      name: serviceId
      in: path
      description: uuid of the service
      required: true
      schema:
        type: string
  securitySchemes:
    OAuth2Security:
      type: oauth2
      flows:
        password:
          tokenUrl: https://localhost:9443/oauth2/token
          scopes:
            service_catalog:service_view: view access to services in service catalog
            service_catalog:service_write: write access to services in service catalog
            apim:api_view: view access to services for read only users

WSO2 Services API

Operations 9

Documentation

Specifications

Schemas & Data

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification