Legacy API Gateway API | IBM Cloud API Docs

Introduction

Last updated: 2020-04-13

Within IBM Cloud, you can easily create API proxies and custom APIs backed by IBM Cloud™ Functions, Cloud Foundry apps, and IBM® App Connect flows. The Legacy API Gateway you to securely share your APIs with other developers.

The Legacy API Gateway can handle APIs located in Cloud Foundry spaces, where access is controlled by roles. A space provides users with access to a shared location for app development, deployment, and maintenance. Cloud Foundry roles grant access to spaces, but offer no control over user actions.

For more information on using Legacy API Gateway, see Getting Started.

API endpoint

https://api.<region>.apigw.cloud.ibm.com

Replace <region> with the prefix that represents the geographic area where your APIs reside. For more information on determining the region, see Managing APIs.

Authentication

Most API methods require an Authorization header that includes a token with your IBM Cloud Identity and Access Management (IAM) credentials.

The header should look like this: Authorization: Bearer <token>

For more information, see Passing an IBM Cloud IAM token to authenticate with a service's API

Error handling

The APIs managed by Legacy API Gateway use standard HTTP response codes to indicate whether a method completed successfully.

HTTP Error Code	Description	Recovery
`200`	Success	The request was successful.
`400`	Bad Request	The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request.
`401`	Unauthorized	You are not authorized to make this request. Log in to IBM Cloud and try again. If this error persists, contact your account owner to check your permissions.
`403`	Forbidden	The supplied authentication is not authorized.
`404`	Not Found	The requested resource could not be found.
`408`	Request Timeout	The connection to the server timed out. Wait a few minutes, then try again.
`409`	Conflict	The entity is already in the requested state.
`429`	Too Many Requests	You have made too many requests to this endpoint and are being rate limited / throttled.
`500`	Internal Server Error	App ID is currently unavailable. Your request could not be processed. Wait a few minutes and try again.

GET /v1/endpoints

Request

Custom Headers

authorization
Required*
string
User bearer token

Query Parameters

space_guid
Required*
string
Space Guid
provider_id
string
Provider Id
shared
boolean
Only return shared endpoints
managed
boolean
Only return managed endpoints
swagger
string
Return OpenAPI doc with list results. Possible values are ['provider', 'consumer']. Defaults to 'provider'

Example request

curl -X GET   -H 'Authorization: Bearer <IAM token>'   'https://api.us-south.apigw.cloud.ibm.com/controller/v1/endpoints?space_guid={space_guid}'

Response

Response Body

v1_Endpoint[]

Status Code

200
Request was successful

Example responses

Status 200

[
  {
    "artifact_id": "851c6ffe-7da6-41ab-a8fa-501bd0557001",
    "org_guid": "25370c08-fab8-11e9-8f0b-362b9e155667",
    "space_guid": "1beed7fc-fab8-11e9-8f0b-362b9e155667",
    "metadata": {},
    "provider_id": "user-defined",
    "name": "test",
    "routes": [],
    "managed_url": "https://gw.us-south.apigw.test.appdomain.cloud/api/abd7714cf04e470d102926d22f7a13fc3c3ff49c00e992f0e20119e61e914a67/",
    "alias_url": "https://497c007a.us-south.stage1.apiconnect.appdomain.cloud/",
    "shared": false,
    "managed": true,
    "open_api_doc": {},
    "base_path": "/"
  }
]

POST /v1/endpoints

Request

Custom Headers

authorization
Required*
string
User bearer token

Request Body

Required*

v1_EndpointRequest

Information about the new endpoint

Example request

curl -X POST   -H 'Content-Type: application/json'   -H 'Accept: application/json'   -H 'Authorization: Bearer <IAM token>'   -d '{       "org_guid": "33521683-fd54-4cde-8e37-cdeaa7b0a80f",       "space_guid": "crn:v1:staging:public:api-gateway:global:a/e139a1ed8c1a770c128cc80cb07f426f:86164525-fd54-4cde-8e37-cdeaa7b0a80f::",       "name": "example",       "routes": [         "https://httpbin.org"       ],       "managed": false,       "metadata": {},       "open_api_doc": {}     }' 'https://api.us-south.apigw.cloud.ibm.com/controller/v1/endpoints'

Response

Response Body

v1_Endpoint

Status Code

200
Request was successful

Example responses

Status 200

{
  "artifact_id": "851c6ffe-7da6-41ab-a8fa-501bd0557001",
  "org_guid": "25370c08-fab8-11e9-8f0b-362b9e155667",
  "space_guid": "1beed7fc-fab8-11e9-8f0b-362b9e155667",
  "metadata": {},
  "provider_id": "user-defined",
  "name": "test",
  "routes": [],
  "managed_url": "https://gw.us-south.apigw.test.appdomain.cloud/api/abd7714cf04e470d102926d22f7a13fc3c3ff49c00e992f0e20119e61e914a67/",
  "alias_url": "https://497c007a.us-south.stage1.apiconnect.appdomain.cloud/",
  "shared": false,
  "managed": true,
  "open_api_doc": {},
  "base_path": "/"
}

GET /v1/endpoints/{id}

Request

Custom Headers

authorization
Required*
string
User bearer token

Path Parameters

id
Required*
string
Endpoint Id

Query Parameters

space_guid
Required*
string
Space Guid
provider_id
string
Provider Id

Example request

curl -X GET   -H 'Authorization: Bearer <IAM token>'   'https://api.us-south.apigw.cloud.ibm.com/controller/v1/endpoints/{id}?space_guid={space_guid}'

Response

Response Body

v1_Endpoint

Status Code

200
Request was successful

Example responses

Status 200

{
  "artifact_id": "851c6ffe-7da6-41ab-a8fa-501bd0557001",
  "org_guid": "25370c08-fab8-11e9-8f0b-362b9e155667",
  "space_guid": "1beed7fc-fab8-11e9-8f0b-362b9e155667",
  "metadata": {},
  "provider_id": "user-defined",
  "name": "test",
  "routes": [],
  "managed_url": "https://gw.us-south.apigw.test.appdomain.cloud/api/abd7714cf04e470d102926d22f7a13fc3c3ff49c00e992f0e20119e61e914a67/",
  "alias_url": "https://497c007a.us-south.stage1.apiconnect.appdomain.cloud/",
  "shared": false,
  "managed": true,
  "open_api_doc": {},
  "base_path": "/"
}

PUT /v1/endpoints/{id}

Request

Custom Headers

authorization
Required*
string
User bearer token

Path Parameters

id
Required*
string
Endpoint Id

Query Parameters

space_guid
Required*
string
Space Guid
provider_id
string
Provider Id

Request Body

Required*

v1_EndpointRequest

Information about the new endpoint

Example request

curl -X PUT   -H 'Content-Type: application/json'   -H 'Accept: application/json'   -H 'Authorization: Bearer <IAM token>'   -d '{       "org_guid": "33521683-fd54-4cde-8e37-cdeaa7b0a80f",       "space_guid": "crn:v1:staging:public:api-gateway:global:a/e139a1ed8c1a770c128cc80cb07f426f:86164525-fd54-4cde-8e37-cdeaa7b0a80f::",       "name": "example",       "routes": [         "https://httpbin.org"       ],       "managed": false,       "metadata": {},       "open_api_doc": {}     }' 'https://api.us-south.apigw.cloud.ibm.com/controller/v1/endpoints/{id}?space_guid={space_guid}'

Response

Response Body

v1_Endpoint

Status Code

200
Request was successful

Example responses

Status 200

{
  "artifact_id": "851c6ffe-7da6-41ab-a8fa-501bd0557001",
  "org_guid": "25370c08-fab8-11e9-8f0b-362b9e155667",
  "space_guid": "1beed7fc-fab8-11e9-8f0b-362b9e155667",
  "metadata": {},
  "provider_id": "user-defined",
  "name": "test",
  "routes": [],
  "managed_url": "https://gw.us-south.apigw.test.appdomain.cloud/api/abd7714cf04e470d102926d22f7a13fc3c3ff49c00e992f0e20119e61e914a67/",
  "alias_url": "https://497c007a.us-south.stage1.apiconnect.appdomain.cloud/",
  "shared": false,
  "managed": true,
  "open_api_doc": {},
  "base_path": "/"
}

DELETE /v1/endpoints/{id}

Request

Custom Headers

authorization
Required*
string
User bearer token

Path Parameters

id
Required*
string
Endpoint Id

Query Parameters

space_guid
Required*
string
Space Guid

Example request

curl -X DELETE   -H 'Authorization: Bearer <IAM token>'   'https://api.us-south.apigw.cloud.ibm.com/controller/v1/endpoints/{id}?space_guid={space_guid}'

Response

Status Code

204
Request was successful

No Sample Response

This method does not specify any sample responses.

GET /v1/endpoints/{id}/swagger

Request

Custom Headers

authorization
Required*
string
User bearer token

Path Parameters

id
Required*
string
Endpoint Id

Query Parameters

space_guid
Required*
string
Space Guid
type
string
Type of swagger to retrieve

Allowable values: [json,yaml]

Example request

curl -X GET   -H 'Authorization: Bearer <IAM token>'   'https://api.us-south.apigw.cloud.ibm.com/controller/v1/endpoints/{id}/swagger?space_guid={space_guid}'

Response

Response Body

object

Status Code

200
Request was successful

Example responses

Status 200

{
  "info": {
    "version": "1.0",
    "title": "example"
  },
  "x-ibm-configuration": {
    "assembly": {
      "execute": [
        {
          "invoke": {
            "target-url": "https://httpbin.org",
            "verb": "keep"
          }
        }
      ]
    }
  },
  "basePath": "/c636f62e-7d47-48bf-8e1d-b90c58762816",
  "paths": {
    "/": {
      "get": {
        "description": "Default get resource for endpoint",
        "responses": {
          "200": {
            "description": "A successful invocation response"
          }
        }
      }
    }
  }
}

POST /v1/endpoints/{id}/actions

Request

Custom Headers

authorization
Required*
string
User bearer token

Path Parameters

id
Required*
string
Endpoint Id

Query Parameters

space_guid
Required*
string
Space Guid
provider_id
Required*
string
Provider Id

Request Body

Required*

v1_EndpointActionRequest

Information about the requested action

Example request

curl -X POST   -H 'Content-Type: application/json'   -H 'Accept: application/json'   -H 'Authorization: Bearer <IAM token>'   -d '{       "type": "manage",     }'   'https://api.us-south.apigw.cloud.ibm.com/controller/v1/endpoints/{id}/actions?space_guid={space_guid}?provider_id=user-defined'

Response

Response Body

v1_Endpoint

Status Code

200
Request was successful

Example responses

Status 200

{
  "artifact_id": "851c6ffe-7da6-41ab-a8fa-501bd0557001",
  "org_guid": "25370c08-fab8-11e9-8f0b-362b9e155667",
  "space_guid": "1beed7fc-fab8-11e9-8f0b-362b9e155667",
  "metadata": {},
  "provider_id": "user-defined",
  "name": "test",
  "routes": [],
  "managed_url": "https://gw.us-south.apigw.test.appdomain.cloud/api/abd7714cf04e470d102926d22f7a13fc3c3ff49c00e992f0e20119e61e914a67/",
  "alias_url": "https://497c007a.us-south.stage1.apiconnect.appdomain.cloud/",
  "shared": false,
  "managed": true,
  "open_api_doc": {},
  "base_path": "/"
}

GET /v1/endpoints/summary

Request

Custom Headers

authorization
Required*
string
User bearer token

Query Parameters

space_guid
Required*
string
Space Guid
swagger
string
Return OpenAPI doc with list results. Possible values are ['provider', 'consumer']. Defaults to 'provider'

Example request

curl -X GET   -H 'Authorization: Bearer <IAM token>'   -H 'Accept: application/json'   'https://api.us-south.apigw.cloud.ibm.com/controller/v1/endpoints/summary?space_guid={space_guid}'

Response

Response Body

v1_EndpointSummary[]

Status Code

200
Request was successful

Example responses

Status 200

[
  {
    "id": "cf-apps",
    "display_name": "Cloud Foundry",
    "metadata": {},
    "discoverable": true,
    "discovery_config": {
      "headers": [],
      "bridge_url": "https://foo.bar/bridges/example"
    },
    "endpoints": [
      {
        "artifact_id": "851c6ffe-7da6-41ab-a8fa-501bd0557001",
        "org_guid": "25370c08-fab8-11e9-8f0b-362b9e155667",
        "space_guid": "1beed7fc-fab8-11e9-8f0b-362b9e155667",
        "metadata": {},
        "provider_id": "user-defined",
        "name": "test",
        "routes": [],
        "managed_url": "https://gw.us-south.apigw.test.appdomain.cloud/api/abd7714cf04e470d102926d22f7a13fc3c3ff49c00e992f0e20119e61e914a67/",
        "alias_url": "https://497c007a.us-south.stage1.apiconnect.appdomain.cloud/",
        "shared": false,
        "managed": true,
        "open_api_doc": {},
        "base_path": "/"
      }
    ]
  }
]

GET /v1/subscriptions

Request

Custom Headers

authorization
Required*
string
User bearer token

Query Parameters

artifact_id
Required*
string
Artifact Id
type
string
Subscription type

Example request

curl -X GET   -H 'Authorization: Bearer <IAM token>'   -H 'Accept: application/json'   'https://api.us-south.apigw.cloud.ibm.com/controller/v1/subscriptions?artifact_id={artifact_id}

Response

Response Body

v1_Subscription[]

List of all subscriptions tied to a given artifact

Status Code

200
Request was successful

Example responses

Status 200

[
  {
    "client_id": "62bc8a5f-480e-1e52-9229-daee77da1890",
    "secret_provided": true,
    "space_guid": "392ffa5f-433e-1e52-2139-fe131f183c90",
    "space_name": "space",
    "name": "example",
    "type": null,
    "metadata": {}
  }
]

POST /v1/subscriptions

Request

Custom Headers

authorization
Required*
string
User bearer token

Request Body

Required*

v1_SubscriptionRequest

Subscription

Example request

curl -X POST   -H 'Content-Type: application/json'   -H 'Accept: application/json'   -H 'Authorization: Bearer <IAM token>'   -d '{       "client_id": "47712f48-fa6c-11e9-aad5-362b9e155667",       "client_secret": "be9f8a5c-fa6b-11e9-8f0b-362b9e155667",       "artifact_id": "62bc8a5f-480e-1e52-9229-daee77da1890"    }'   'https://api.us-south.apigw.cloud.ibm.com/controller/v1/subscriptions'

Response

Response Body

v1_Subscription

Status Code

200
Request was successful

Example responses

Status 200

[
  {
    "client_id": "62bc8a5f-480e-1e52-9229-daee77da1890",
    "secret_provided": true,
    "space_guid": "392ffa5f-433e-1e52-2139-fe131f183c90",
    "space_name": "space",
    "name": "example",
    "type": null,
    "metadata": {}
  }
]

GET /v1/subscriptions/{id}

Request

Custom Headers

authorization
Required*
string
User bearer token

Path Parameters

id
Required*
string
Client Id

Query Parameters

artifact_id
Required*
string
Artifact Id

Example request

curl -X GET   -H 'Authorization: Bearer <IAM token>'   -H 'Accept: application/json'   'https://api.us-south.apigw.cloud.ibm.com/controller/v1/subscriptions/{id}?artifact_id={artifact_id}

Response

Response Body

v1_Subscription

Status Code

200
Request was successful

Example responses

Status 200

[
  {
    "client_id": "62bc8a5f-480e-1e52-9229-daee77da1890",
    "secret_provided": true,
    "space_guid": "392ffa5f-433e-1e52-2139-fe131f183c90",
    "space_name": "space",
    "name": "example",
    "type": null,
    "metadata": {}
  }
]

PUT /v1/subscriptions/{id}

Request

Custom Headers

authorization
Required*
string
User bearer token

Path Parameters

id
Required*
string
Client Id

Query Parameters

artifact_id
Required*
string
Artifact Id

Request Body

v1_SubscriptionRequest

Subscription

Example request

curl -X PUT   -H 'Content-Type: application/json'   -H 'Accept: application/json'   -H 'Authorization: Bearer <IAM token>'   -d '{       "client_id": "47712f48-fa6c-11e9-aad5-362b9e155667",       "client_secret": "be9f8a5c-fa6b-11e9-8f0b-362b9e155667",       "artifact_id": "62bc8a5f-480e-1e52-9229-daee77da1890"    }'   'https://api.us-south.apigw.cloud.ibm.com/controller/v1/subscriptions/{id}?artifact_id={artifact_id}'

Response

Response Body

v1_Subscription

Status Code

200
Request was successful

Example responses

Status 200

[
  {
    "client_id": "62bc8a5f-480e-1e52-9229-daee77da1890",
    "secret_provided": true,
    "space_guid": "392ffa5f-433e-1e52-2139-fe131f183c90",
    "space_name": "space",
    "name": "example",
    "type": null,
    "metadata": {}
  }
]

DELETE /v1/subscriptions/{id}

Request

Custom Headers

authorization
Required*
string
User bearer token

Path Parameters

id
Required*
string
Client Id

Query Parameters

artifact_id
Required*
string
Artifact Id

Example request

curl -X DELETE   -H 'Authorization: Bearer <IAM token>'   -H 'Accept: application/json'   'https://api.us-south.apigw.cloud.ibm.com/controller/v1/subscriptions/{id}?artifact_id={artifact_id}

Response

Status Code

204
Request was successful

No Sample Response

This method does not specify any sample responses.

GET /v1/subscriptions/artifact

Request

Query Parameters

artifact_id
Required*
string
Artifact Id
client_id
string
Client Id

Example request

curl -X GET   -H 'Authorization: Bearer <IAM token>'   -H 'Accept: application/json'   'https://api.us-south.apigw.cloud.ibm.com/controller/v1/subscriptions/{id}/artifact?artifact_id={artifact_id}

Response

Response Body

object

Subscription artifact requested

Status Code

200
Request was successful

Example responses

Status 200

{
  "open_api_doc": {
    "info": {
      "version": "1.0",
      "title": "example"
    },
    "x-ibm-configuration": {
      "assembly": {
        "execute": [
          {
            "invoke": {
              "target-url": "https://httpbin.org",
              "verb": "keep"
            }
          }
        ]
      }
    },
    "basePath": "/c636f62e-7d47-48bf-8e1d-b90c58762816",
    "paths": {
      "/": {
        "get": {
          "description": "Default get resource for endpoint",
          "responses": {
            "200": {
              "description": "A successful invocation response"
            }
          }
        }
      }
    }
  },
  "managed_url": "https://gw.us-south.apigw.test.appdomain.cloud/api/abd7714cf04e470d102926d22f7a13fc3c3ff49c00e992f0e20119e61e914a67/"
}

PUT /v1/subscriptions/{id}/secret

Request

Custom Headers

authorization
Required*
string
Client id

Path Parameters

id
Required*
string
Client Id

Query Parameters

artifact_id
Required*
string
Artifact Id

Request Body

v1_SubscriptionSecretRequest

Subscription Secret Request

Example request

curl -X PUT   -H 'Content-Type: application/json'   -H 'Accept: application/json'   -H 'Authorization: Bearer <IAM token>'   -d '{       "client_secret": "be9f8a5c-fa6b-11e9-8f0b-362b9e155667",     }'   'https://api.us-south.apigw.cloud.ibm.com/controller/v1/subscriptions/{id}/secret?artifact_id={artifact_id}'

Response

Response Body

v1_Subscription

Status Code

200
Request was successful

Example responses

Status 200

[
  {
    "client_id": "62bc8a5f-480e-1e52-9229-daee77da1890",
    "secret_provided": true,
    "space_guid": "392ffa5f-433e-1e52-2139-fe131f183c90",
    "space_name": "space",
    "name": "example",
    "type": null,
    "metadata": {}
  }
]

GET /v1/consumer/endpoints

Request

Custom Headers

authorization
Required*
string
User bearer token

Query Parameters

org_guid
Required*
string
Org Guid
provider_id
string
Provider Id

Example request

curl -X GET   -H 'Authorization: Bearer <IAM token>'   -H 'Accept: application/json'   'https://api.us-south.apigw.cloud.ibm.com/controller/v1/consumer/endpoints?org_guid={org_guid}

Response

Response Body

v1_ConsumerEndpoint[]

Status Code

200
Request was successful

Example responses

Status 200

[
  {
    "artifact_id": "851c6ffe-7da6-41ab-a8fa-501bd0557001",
    "org_guid": "25370c08-fab8-11e9-8f0b-362b9e155667",
    "space_guid": "1beed7fc-fab8-11e9-8f0b-362b9e155667",
    "metadata": {},
    "provider_id": "user-defined",
    "name": "test",
    "routes": [],
    "managed_url": "https://gw.us-south.apigw.test.appdomain.cloud/api/abd7714cf04e470d102926d22f7a13fc3c3ff49c00e992f0e20119e61e914a67/",
    "alias_url": "https://497c007a.us-south.stage1.apiconnect.appdomain.cloud/",
    "shared": false,
    "managed": true,
    "open_api_doc": {},
    "base_path": "/"
  }
]

GET /v1/consumer/endpoints/{id}

Request

Custom Headers

authorization
Required*
string
User bearer token

Path Parameters

id
Required*
string
Endpoint Id

Query Parameters

org_guid
Required*
string
Org Guid

Example request

curl -X GET   -H 'Authorization: Bearer <IAM token>'   -H 'Accept: application/json'   'https://api.us-south.apigw.cloud.ibm.com/controller/v1/consumer/endpoints/{id}?org_guid={org_guid}

Response

Response Body

v1_ConsumerEndpoint

Status Code

200
Request was successful

Example responses

Status 200

{
  "artifact_id": "851c6ffe-7da6-41ab-a8fa-501bd0557001",
  "org_guid": "25370c08-fab8-11e9-8f0b-362b9e155667",
  "space_guid": "1beed7fc-fab8-11e9-8f0b-362b9e155667",
  "metadata": {},
  "provider_id": "user-defined",
  "name": "test",
  "routes": [],
  "managed_url": "https://gw.us-south.apigw.test.appdomain.cloud/api/abd7714cf04e470d102926d22f7a13fc3c3ff49c00e992f0e20119e61e914a67/",
  "alias_url": "https://497c007a.us-south.stage1.apiconnect.appdomain.cloud/",
  "shared": false,
  "managed": true,
  "open_api_doc": {},
  "base_path": "/"
}

GET /v1/consumer/endpoints/{id}/swagger

Request

Custom Headers

authorization
Required*
string
User bearer token

Path Parameters

id
Required*
string
Endpoint Id

Query Parameters

org_guid
Required*
string
Org Guid

Example request

curl -X GET   -H 'Authorization: Bearer <IAM token>'   -H 'Accept: application/json'   'https://api.us-south.apigw.cloud.ibm.com/controller/v1/consumer/endpoints/{id}/swagger?org_guid={org_guid}

Response

Response Body

object

Status Code

200
Request was successful

Example responses

Status 200

{
  "info": {
    "version": "1.0",
    "title": "example"
  },
  "x-ibm-configuration": {
    "assembly": {
      "execute": [
        {
          "invoke": {
            "target-url": "https://httpbin.org",
            "verb": "keep"
          }
        }
      ]
    }
  },
  "basePath": "/c636f62e-7d47-48bf-8e1d-b90c58762816",
  "paths": {
    "/": {
      "get": {
        "description": "Default get resource for endpoint",
        "responses": {
          "200": {
            "description": "A successful invocation response"
          }
        }
      }
    }
  }
}

GET /v1/consumer/endpoints/summary

Request

Custom Headers

authorization
Required*
string
User bearer token

Query Parameters

org_guid
Required*
string
Org Guid

Example request

curl -X GET   -H 'Authorization: Bearer <IAM token>'   -H 'Accept: application/json'   'https://api.us-south.apigw.cloud.ibm.com/controller/v1/consumer/endpoints/summary?org_guid={org_guid}

Response

Response Body

v1_EndpointSummary[]

Status Code

200
Request was successful

Example responses

Status 200

[
  {
    "id": "cf-apps",
    "display_name": "Cloud Foundry",
    "metadata": {},
    "discoverable": true,
    "discovery_config": {
      "headers": [],
      "bridge_url": "https://foo.bar/bridges/example"
    },
    "endpoints": [
      {
        "artifact_id": "851c6ffe-7da6-41ab-a8fa-501bd0557001",
        "org_guid": "25370c08-fab8-11e9-8f0b-362b9e155667",
        "space_guid": "1beed7fc-fab8-11e9-8f0b-362b9e155667",
        "metadata": {},
        "provider_id": "user-defined",
        "name": "test",
        "routes": [],
        "managed_url": "https://gw.us-south.apigw.test.appdomain.cloud/api/abd7714cf04e470d102926d22f7a13fc3c3ff49c00e992f0e20119e61e914a67/",
        "alias_url": "https://497c007a.us-south.stage1.apiconnect.appdomain.cloud/",
        "shared": false,
        "managed": true,
        "open_api_doc": {},
        "base_path": "/"
      }
    ]
  }
]

POST /v1/oai/validation

Request

Custom Headers

authorization
Required*
string
User bearer token

Request Body

Required*

object

Open API doc to be validated

Example request

curl -X POST   -H 'Content-Type: application/json'   -H 'Accept: application/json'   -H 'Authorization: Bearer <IAM token>'   -d '{       "open_api_doc": {},     }'   'https://api.us-south.apigw.cloud.ibm.com/controller/v1/oai/validation'

Response

Response Body

object

Status Code

200
Request was successful

No Sample Response

This method does not specify any sample responses.

Introduction

Authentication

Error handling

Methods

Get details for all Endpoints

Request

Custom Headers

authorization

Query Parameters

space_guid

provider_id

shared

managed

swagger

Response

Response Body

artifact_id

metadata

space_guid

org_guid

provider_id

name

routes

managed_url

alias_url

shared

managed

policies

open_api_doc

base_path

Status Code

200

Created a new user-defined endpoint

Request

Custom Headers

authorization

Request Body

artifact_id

space_guid

name

org_guid

routes

managed

metadata

custom_domain

open_api_doc

Response

Response Body

artifact_id

metadata

space_guid

org_guid

provider_id

name

routes

managed_url

alias_url

shared

managed

policies

open_api_doc

base_path

Status Code

200

Get details for a given Endpoint

Request

Custom Headers

authorization

Path Parameters

id

Query Parameters

space_guid

provider_id

Response

Response Body

artifact_id

metadata

space_guid

org_guid

provider_id