Get gateways a user can reference
/apiplatform/management/v1/apis/{apiId}/references/gateways
Returns all gateways that can be referenced in policies applied to the {apiId}
API.
Users requesting this resource must be assigned the API Manager role and must be issued the Manage API grant for the specified API.
Request
- application/json
-
apiId: string
A unique ID referencing a specific API.
-
fields(optional): array
Collection Format:
csv
Pass optional fields, separated by commas, in this parameter to return them in the response. See the operation's description for a list of field values. -
limit(optional): integer(int32)
Number of items to retrieve.
1
is the minumum;128
is the maximum.Default Value:128
-
offset(optional): integer(int32)
Offset the list returned results by this amount. Default is zero.Default Value:
0
- orderBy(optional): array
-
q(optional): string
Pass filtering criteria, using the SCIM filter expression syntax
-
totalResults(optional): boolean
Include the total result count in the response.Default Value:
false
Response
- application/json
200 Response
object
-
count(optional):
integer(int32)
The number of items in this collection.
object
-
totalResults(optional):
integer(int32)
The total number of results available. Only provided if the showTotalResults query parameter is set to true
object
-
configuration(optional):
object configuration
-
description(optional):
string
The gateway's description.
-
firewall(optional):
object firewall
-
location(optional):
string
The gateway's location.
-
proxyUrls(optional):
array proxyUrls
-
releaseVersion(optional):
string
The gateway's release version. This property is used only at node registration time to seed the original release version of the node.
-
urls(optional):
array urls
object
-
createdAt(optional):
string
The date and time the gateway was created.
-
createdBy(optional):
string
The user who created the gateway.
-
updatedAt(optional):
string
The date time the gateway was last updated.
-
updatedBy(optional):
string
The user who last updated the gateway.
403 Response
object
-
detail(optional):
string
Detailed error message
-
errorCode(optional):
string
Application specific error code
-
errorDetails(optional):
array errorDetails
additional errors
-
errorPath(optional):
string
-
instance(optional):
string
URI to the link that provides more detail about the error
-
status(optional):
string
HTTP status code
-
title:
string
Summary error message
-
type:
string
Error type
500 Response
object
-
detail(optional):
string
Detailed error message
-
errorCode(optional):
string
Application specific error code
-
errorDetails(optional):
array errorDetails
additional errors
-
errorPath(optional):
string
-
instance(optional):
string
URI to the link that provides more detail about the error
-
status(optional):
string
HTTP status code
-
title:
string
Summary error message
-
type:
string
Error type
Examples
The following example shows how to retrieve all gateways can be referenced in policies applied to the API by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL
curl -i -X GET
-H "Authorization: Bearer access_token"
https://example.com/apiplatform/management/v1/apis/{apiId}/references/gateways
{apiId}
is the unique Id for an API. To retrieve available API Ids, see Get APIs.
Example of Response Headers
The following shows an example of the response headers.
HTTP/1.1 200 OK Server: Oracle-Traffic-Director/12.2.1.0.0 Date: Mon, 13 Mar 2017 07:24:25 GMT Content-Length: 371 Content-Type: application/json X-oracle-dms-ecid: f102c33f-1c5b-4409-806d-03bf5706c492-00018fc1 X-oracle-dms-rid: 0 Via: 1.1 otd_opc Proxy-agent: Oracle-Traffic-Director/12.2.1.0.0
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "offset": 0, "count": 5, "limit": 128, "hasMore": false, "links": [ { "templated": "true", "method": "GET", "rel": "self", "href": "http://example.com:443/apiplatform/management/v1/apis/100/references/gateways?offset=0&=128" } ], "items": [ { "createdAt": "2018-02-05T09:03:12-0800", "updatedBy": "apcsadmin", "createdBy": "api-gateway-user", "name": "Production Gateway", "description": "description", "id": "100", "updatedAt": "2018-02-13T14:53:01-0800" }, { "createdAt": "2018-02-05T20:51:22-0800", "updatedBy": "apcsadmin", "createdBy": "apcsadmin", "name": "GoldGw", "id": "101", "updatedAt": "2018-02-05T20:51:22-0800" }, { "createdAt": "2018-02-08T00:19:34-0800", "updatedBy": "apcsadmin", "createdBy": "apcsadmin", "name": "Test", "id": "102", "updatedAt": "2018-02-08T00:20:40-0800" }, { "createdAt": "2018-02-12T21:34:56-0800", "updatedBy": "apcsadmin", "createdBy": "apcsadmin", "name": "MyGateway", "id": "103", "updatedAt": "2018-02-12T21:35:46-0800" }, { "createdAt": "2018-02-13T23:00:25-0800", "updatedBy": "apcsadmin", "createdBy": "apcsadmin", "name": "New", "id": "104", "updatedAt": "2018-02-13T23:00:25-0800" } ] }