GET swagger documents

You can use the HTTP method GET to obtain a list of swagger documents.

zosConnect-2.0 Applies to zosConnect-2.0.

HTTP method
GET
URI
/zosConnect/api-docs
Description
Gets a list of swagger documents for the IBM® z/OS® Connect APIs installed in the runtime.
Security
Users with Admin, Operations or Reader authority can get a list of swagger documents, users with Invoke authority cannot. For more information about user authorization, see Overview of IBM z/OS Connect security.
Return body
{
    "swagger": "2.0",
    "info": {
        "title": "z/OS Connect administration API",
        "description": "Interface providing meta-data and life-cycle operations for z/OS Connect services, APIs and API requesters.",
        "version": "1.1.0"
    },
    "schemes": [
        "http",
        "https"
    ],
    "consumes": [],
    "produces": [
        "application/json"
    ],
    "basePath": "/zosConnect",
    "paths": {
        "/apis": {
            "get": {
                "tags": [
                    "APIs"
                ],
                "summary": "Returns a list of all the deployed z/OS Connect APIs",
                "operationId": "getApis",
                "responses": {
                    "200": {
                        "$ref": "#/responses/apis"
                    },
                    "default": {
                        "$ref": "#/responses/defaultError"
                    }
                }
            },
            "post": {
                "tags": [
                    "APIs"
                ],
                "summary": "Deploys a new API into z/OS Connect",
                "operationId": "createApi",
                "consumes": [
                    "application/zip"
                ],
                "parameters": [
                    {
                        "name": "apiPackage",
                        "in": "body",
                        "description": "API package.",
                        "required": true,
                        "schema": {
                            "type": "string",
                            "format": "binary"
                        }
                    },
                    {
                        "name": "status",
                        "in": "query",
                        "description": "The initial status of the API.",
                        "type": "string",
                        "enum": [
                            "started",
                            "stopped"
                        ]
                    }
                ],
                "responses": {
                    "201": {
                        "$ref": "#/responses/createApiDetail"
                    },
                    "400": {
                        "$ref": "#/responses/400BadRequestCreate"
                    },
                    "409": {
                        "$ref": "#/responses/409ConflictCreate"
                    },
                    "default": {
                        "$ref": "#/responses/defaultError"
                    }
                }
            }
        },
    ...
    ... 
    ...
    "tags": [
        {
            "name": "APIs",
            "description": "Operations for working with APIs"
        },
        {
            "name": "Services",
            "description": "Operations for working with services"
        },
        {
            "name": "API Requesters",
            "description": "Operations that work with API Requesters."
        }
    ]
}