API Gateway Controller API | IBM Cloud API Docs

Introduction

Last updated: 2020-09-29

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. An API Gateway service enables you to securely share your APIs with other developers.

The API Gateway service can handle APIs located in IBM Cloud resource groups. APIs located in Cloud Foundry spaces are handled by an automatically-provisioned Legacy API Gateway. Both gateway types are tightly integrated with IBM Cloud common services like Activity Tracker, App ID, Certificate Manager, and more.

For more information on using the API Gateway service, 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

To call each method, you'll need to be assigned a role that includes the required IAM actions. Each method lists the associated action. For more information about IAM actions and how they map to roles, see Managing access for API Gateway.

Event tracking

You can monitor API activity within your account by using the Activity Tracker service. Whenever an API method is called, an event is generated that you can then track and audit from within Activity Tracker. The specific event type is listed for each individual method.

For more information about how to track API Gateway activity, see Auditing events for API Gateway.

Error handling

The APIs managed by 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 /v2/endpoints

Request

Custom Headers

authorization
Required*
string
Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run ibmcloud iam oauth-tokens

Query Parameters

service_instance_crn
Required*
string
The API Gateway service instance CRN
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/v2/endpoints?service_instance_crn={crn}'

Response

Response Body

v2_Endpoint[]

Status Code

200
Request was successful

Example responses

Status 200

[
  {
    "artifact_id": "851c6ffe-7da6-41ab-a8fa-501bd0557001",
    "crn": "crn:v1:staging:public:api-gateway:global:a/e139a1ed8c1a770c128cc80cb07f426f:612b125f-480e-44a2-96a9-daeee4bf1891:endpoint:851c6ffe-7da6-41ab-a8fa-501bd0557001",
    "parent_crn": "crn:v1:staging:public:api-gateway:global:a/e139a1ed8c1a770c128cc80cb07f426f:612b125f-480e-44a2-96a9-daeee4bf1891::",
    "service_instance_crn": "crn:v1:staging:public:api-gateway:global:a/e139a1ed8c1a770c128cc80cb07f426f:612b125f-480e-44a2-96a9-daeee4bf1891::",
    "account_id": "e139a1ed8c1a770c128cc80cb07f426f",
    "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,
    "base_path": "/"
  }
]

POST /v2/endpoints

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

api-gateway.api.create

Auditing

Calling this method generates the following auditing event.

api-gateway.api.create

Request

Custom Headers

authorization
Required*
string
User IAM token

Request Body

Required*

v2_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 '{ "artifact_id": "33521683-fd54-4cde-8e37-cdeaa7b0a80f", "service_instance_crn": "crn:v1:staging:public:api-gateway:global:a/e139a1ed8c1a770c128cc80cb07f426f:86164525-fd54-4cde-8e37-cdeaa7b0a80f::", "parent_crn": "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/v2/endpoints'

Response

Response Body

v2_Endpoint

Status Code

200
Request was successful

Example responses

Status 200

{
  "artifact_id": "851c6ffe-7da6-41ab-a8fa-501bd0557001",
  "crn": "crn:v1:staging:public:api-gateway:global:a/e139a1ed8c1a770c128cc80cb07f426f:612b125f-480e-44a2-96a9-daeee4bf1891:endpoint:851c6ffe-7da6-41ab-a8fa-501bd0557001",
  "parent_crn": "crn:v1:staging:public:api-gateway:global:a/e139a1ed8c1a770c128cc80cb07f426f:612b125f-480e-44a2-96a9-daeee4bf1891::",
  "service_instance_crn": "crn:v1:staging:public:api-gateway:global:a/e139a1ed8c1a770c128cc80cb07f426f:612b125f-480e-44a2-96a9-daeee4bf1891::",
  "account_id": "e139a1ed8c1a770c128cc80cb07f426f",
  "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,
  "base_path": "/"
}

GET /v2/endpoints/{id}

Request

Custom Headers

authorization
Required*
string
User IAM token

Path Parameters

id
Required*
string
Endpoint Id

Query Parameters

service_instance_crn
Required*
string
Service Instance CRN

Example request

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

Response

Response Body

v2_Endpoint

Status Code

200
Request was successful

Example responses

Status 200

{
  "artifact_id": "851c6ffe-7da6-41ab-a8fa-501bd0557001",
  "crn": "crn:v1:staging:public:api-gateway:global:a/e139a1ed8c1a770c128cc80cb07f426f:612b125f-480e-44a2-96a9-daeee4bf1891:endpoint:851c6ffe-7da6-41ab-a8fa-501bd0557001",
  "parent_crn": "crn:v1:staging:public:api-gateway:global:a/e139a1ed8c1a770c128cc80cb07f426f:612b125f-480e-44a2-96a9-daeee4bf1891::",
  "service_instance_crn": "crn:v1:staging:public:api-gateway:global:a/e139a1ed8c1a770c128cc80cb07f426f:612b125f-480e-44a2-96a9-daeee4bf1891::",
  "account_id": "e139a1ed8c1a770c128cc80cb07f426f",
  "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,
  "base_path": "/"
}

PUT /v2/endpoints/{id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

api-gateway.api.update

Auditing

Calling this method generates the following auditing event.

api-gateway.api.update

Request

Custom Headers

authorization
Required*
string
User IAM token

Path Parameters

id
Required*
string
Endpoint Id

Query Parameters

service_instance_crn
Required*
string
Service Instance CRN

Request Body

Required*

v2_EndpointRequest

Information about the endpoint

Example request

curl -X PUT   -H 'Content-Type: application/json'   -H 'Accept: application/json'   -H 'Authorization: Bearer <IAM token>'   -d '{ "artifact_id": "33521683-fd54-4cde-8e37-cdeaa7b0a80f", "service_instance_crn": "crn:v1:staging:public:api-gateway:global:a/e139a1ed8c1a770c128cc80cb07f426f:86164525-fd54-4cde-8e37-cdeaa7b0a80f::", "parent_crn": "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/v2/endpoints'

Response

Response Body

v2_Endpoint

Status Code

200
Request was successful

Example responses

Status 200

{
  "artifact_id": "851c6ffe-7da6-41ab-a8fa-501bd0557001",
  "crn": "crn:v1:staging:public:api-gateway:global:a/e139a1ed8c1a770c128cc80cb07f426f:612b125f-480e-44a2-96a9-daeee4bf1891:endpoint:851c6ffe-7da6-41ab-a8fa-501bd0557001",
  "parent_crn": "crn:v1:staging:public:api-gateway:global:a/e139a1ed8c1a770c128cc80cb07f426f:612b125f-480e-44a2-96a9-daeee4bf1891::",
  "service_instance_crn": "crn:v1:staging:public:api-gateway:global:a/e139a1ed8c1a770c128cc80cb07f426f:612b125f-480e-44a2-96a9-daeee4bf1891::",
  "account_id": "e139a1ed8c1a770c128cc80cb07f426f",
  "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,
  "base_path": "/"
}

DELETE /v2/endpoints/{id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

api-gateway.api.delete

Auditing

Calling this method generates the following auditing event.

api-gateway.api.delete

Request

Custom Headers

authorization
Required*
string
User IAM token

Path Parameters

id
Required*
string
Endpoint id

Query Parameters

service_instance_crn
Required*
string
Service Instance CRN

Example request

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

Response

Status Code

204
No Content - The request was successful

No Sample Response

This method does not specify any sample responses.

GET /v2/endpoints/{id}/swagger

Request

Custom Headers

authorization
Required*
string
User IAM token

Path Parameters

id
Required*
string
Endpoint Id

Query Parameters

service_instance_crn
Required*
string
Service Instance CRN
type
string
Type of swagger to retrieve

Allowable values: [json,yaml]
Default: json

Example request

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

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 /v2/endpoints/{id}/actions

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions. You can check your access by going to Users > User > Access.

api-gateway.api.enable
api-gateway.api.disable

Auditing

Calling this method generates the following auditing events.

api-gateway.api.enable
api-gateway.api.disable

Request

Custom Headers

authorization
Required*
string
User IAM token

Path Parameters

id
Required*
string
Endpoint Id

Query Parameters

service_instance_crn
Required*
string
Service Instance CRN
provider_id
Required*
string
Provider Id

Request Body

Required*

v2_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/v2/endpoints/{id}/actions?service_instance_crn={crn}?provider_id=user-defined'

Response

Response Body

v2_Endpoint

Status Code

200
Request was successful

Example responses

Status 200

{
  "artifact_id": "851c6ffe-7da6-41ab-a8fa-501bd0557001",
  "crn": "crn:v1:staging:public:api-gateway:global:a/e139a1ed8c1a770c128cc80cb07f426f:612b125f-480e-44a2-96a9-daeee4bf1891:endpoint:851c6ffe-7da6-41ab-a8fa-501bd0557001",
  "parent_crn": "crn:v1:staging:public:api-gateway:global:a/e139a1ed8c1a770c128cc80cb07f426f:612b125f-480e-44a2-96a9-daeee4bf1891::",
  "service_instance_crn": "crn:v1:staging:public:api-gateway:global:a/e139a1ed8c1a770c128cc80cb07f426f:612b125f-480e-44a2-96a9-daeee4bf1891::",
  "account_id": "e139a1ed8c1a770c128cc80cb07f426f",
  "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,
  "base_path": "/"
}

GET /v2/endpoints/summary

Request

Custom Headers

authorization
Required*
string
User IAM token

Query Parameters

account_id
Required*
string
User account ID
service_instance_crn
string
Service Instance CRN
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/v2/endpoints/summary?account_id={account_id}'

Response

Response Body

v2_EndpointSummary[]

Status Code

200
Request was successful

Example responses

Status 200

[
  {
    "service_instance_crn": "crn:v1:staging:public:api-gateway:global:a/e139a1ed8c1a770c128cc80cb07f426f:612b125f-480e-44a2-96a9-daeee4bf1891::",
    "endpoints": [
      {
        "artifact_id": "851c6ffe-7da6-41ab-a8fa-501bd0557001",
        "crn": "crn:v1:staging:public:api-gateway:global:a/e139a1ed8c1a770c128cc80cb07f426f:612b125f-480e-44a2-96a9-daeee4bf1891:endpoint:851c6ffe-7da6-41ab-a8fa-501bd0557001",
        "parent_crn": "crn:v1:staging:public:api-gateway:global:a/e139a1ed8c1a770c128cc80cb07f426f:612b125f-480e-44a2-96a9-daeee4bf1891::",
        "service_instance_crn": "crn:v1:staging:public:api-gateway:global:a/e139a1ed8c1a770c128cc80cb07f426f:612b125f-480e-44a2-96a9-daeee4bf1891::",
        "account_id": "e139a1ed8c1a770c128cc80cb07f426f",
        "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,
        "base_path": "/"
      }
    ]
  }
]

GET /v2/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/v2/subscriptions?artifact_id={artifact_id}

Response

Response Body

v2_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,
    "artifact_id": "392ffa5f-433e-1e52-2139-fe131f183c90",
    "account_id": "e139a1ed8c1a770c128cc80cb07f426f",
    "name": "example",
    "type": null,
    "metadata": {}
  }
]

POST /v2/subscriptions

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

api-gateway.subscription.create

Auditing

Calling this method generates the following auditing event.

api-gateway.subscription.create

Request

Custom Headers

authorization
Required*
string
User bearer token

Request Body

Required*

v2_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/v2/subscriptions'

Response

Response Body

v2_Subscription

Status Code

200
Request was successful

Example responses

Status 200

{
  "client_id": "62bc8a5f-480e-1e52-9229-daee77da1890",
  "secret_provided": true,
  "artifact_id": "392ffa5f-433e-1e52-2139-fe131f183c90",
  "account_id": "e139a1ed8c1a770c128cc80cb07f426f",
  "name": "example",
  "type": null,
  "metadata": {}
}

GET /v2/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/v2/subscriptions/{subscription_id}?artifact_id={artifact_id}

Response

Response Body

v2_Subscription

Status Code

200
Request was successful

Example responses

Status 200

{
  "client_id": "62bc8a5f-480e-1e52-9229-daee77da1890",
  "secret_provided": true,
  "artifact_id": "392ffa5f-433e-1e52-2139-fe131f183c90",
  "account_id": "e139a1ed8c1a770c128cc80cb07f426f",
  "name": "example",
  "type": null,
  "metadata": {}
}

PUT /v2/subscriptions/{id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

api-gateway.subscription.update

Auditing

Calling this method generates the following auditing event.

api-gateway.subscription.update

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

v2_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/v2/subscriptions/{subscription_id}?artifact_id={artifact_id}'

Response

Response Body

v2_Subscription

Status Code

200
Request was successful

Example responses

Status 200

{
  "client_id": "62bc8a5f-480e-1e52-9229-daee77da1890",
  "secret_provided": true,
  "artifact_id": "392ffa5f-433e-1e52-2139-fe131f183c90",
  "account_id": "e139a1ed8c1a770c128cc80cb07f426f",
  "name": "example",
  "type": null,
  "metadata": {}
}

DELETE /v2/subscriptions/{id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

api-gateway.subscription.delete

Auditing

Calling this method generates the following auditing event.

api-gateway.subscription.delete

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/v2/subscriptions/{subscription_id}?artifact_id={artifact_id}

Response

Status Code

204
Request was successful

No Sample Response

This method does not specify any sample responses.

GET /v2/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/v2/subscriptions/artifact?artifact_id={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 /v2/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

v2_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/v2/subscriptions/{subscription_id}/secret?artifact_id={artifact_id}'

Response

Response Body

v2_Subscription

Status Code

200
Request was successful

Example responses

Status 200

{
  "client_id": "62bc8a5f-480e-1e52-9229-daee77da1890",
  "secret_provided": true,
  "artifact_id": "392ffa5f-433e-1e52-2139-fe131f183c90",
  "account_id": "e139a1ed8c1a770c128cc80cb07f426f",
  "name": "example",
  "type": null,
  "metadata": {}
}

Introduction

Authentication

Event tracking

Error handling

Methods

Get details for all Endpoints

Request

Custom Headers

authorization

Query Parameters

service_instance_crn

provider_id

shared

managed

swagger

Response

Response Body

artifact_id

crn

parent_crn

service_instance_crn

account_id

metadata

provider_id

name

routes

managed_url

alias_url

shared

managed

policies

open_api_doc

base_path

Status Code

200

Create an Endpoint

Authorization

Auditing

Request

Custom Headers

authorization

Request Body

artifact_id

parent_crn

service_instance_crn

name

routes

managed

metadata

open_api_doc

Response

Response Body

artifact_id

crn

parent_crn

service_instance_crn

account_id

metadata

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

service_instance_crn

Response

Response Body