REST API for the Management Service in Oracle API Platform Cloud Service

Get gateways

get

/apiplatform/management/v1/gateways

Returns a collection of gateways the requesting user is authorized to view. The response also contains HATEOAS links to related operations.

Users requesting this resource must be assigned Plan Manager, API Manager or Gateway Manager role. Only gateways the user is issued the Manage Gateway or View all Details grants for are returned.

Request

Supported Media Types

application/json

Query Parameters

expand(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 expand values.

[0]: string

{
    "name":"expand",
    "in":"query",
    "description":"Pass optional fields, separated by commas, in this parameter to return them in the response. See the operation's description for a list of expand values.",
    "required":false,
    "type":"array",
    "items":{
        "type":"string"
    },
    "collectionFormat":"csv"
}

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.

[0]: string

{
    "name":"fields",
    "in":"query",
    "description":"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.",
    "required":false,
    "type":"array",
    "items":{
        "type":"string"
    },
    "collectionFormat":"csv"
}

limit(optional): integer(int32)

Number of items to retrieve. 1 is the minumum; 128 is the maximum.

Default Value: 128

links(optional): array

Collection Format: csv

Filter the specified link rel's.

[0]: string

{
    "name":"links",
    "in":"query",
    "description":"Filter the specified link rel's.",
    "required":false,
    "type":"array",
    "items":{
        "type":"string"
    },
    "collectionFormat":"csv"
}

offset(optional): integer(int32)

Offset the list returned results by this amount. Default is zero.

Default Value: 0

orderBy(optional): array

Collection Format: csv

Pass sorting criteria, comma separated.

[0]: string

{
    "name":"orderBy",
    "in":"query",
    "description":"Pass sorting criteria, comma separated.",
    "required":false,
    "type":"array",
    "items":{
        "type":"string"
    },
    "collectionFormat":"csv"
}

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

Supported Media Types

application/json

200 Response

The collection of gateways.

Root Schema : GetGatewaysResponse

Match All

Show Source

object CollectionResponseFeature
object LinksResponseFeature
object CollectionResponsePagingFeature
object GetGatewaysResponse-allOf[3]

{
    "allOf":[
        {
            "$ref":"#/definitions/CollectionResponseFeature"
        },
        {
            "$ref":"#/definitions/LinksResponseFeature"
        },
        {
            "$ref":"#/definitions/CollectionResponsePagingFeature"
        },
        {
            "type":"object",
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/GetGatewaysItem"
                    }
                }
            }
        }
    ]
}

Nested Schema : CollectionResponseFeature

Type: object

Show Source

count(optional): integer(int32)

The number of items in this collection.

{
    "properties":{
        "count":{
            "type":"integer",
            "format":"int32",
            "description":"The number of items in this collection."
        }
    }
}

Nested Schema : LinksResponseFeature

Type: object

Show Source

links(optional): array links

Includes 'canonical'.

{
    "properties":{
        "links":{
            "type":"array",
            "description":"Includes 'canonical'.",
            "items":{
                "$ref":"#/definitions/HATEOASLink"
            }
        }
    }
}

Nested Schema : CollectionResponsePagingFeature

Type: object

Show Source

totalResults(optional): integer(int32)

The total number of results available. Only provided if the showTotalResults query parameter is set to true

{
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"The total number of results available. Only provided if the showTotalResults query parameter is set to true"
        }
    }
}

Nested Schema : GetGatewaysResponse-allOf[3]

Type: object

Show Source

items(optional): array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/GetGatewaysItem"
            }
        }
    }
}

Nested Schema : links

Type: array

Includes 'canonical'.

Show Source

Array of: object HATEOASLink

{
    "type":"array",
    "description":"Includes 'canonical'.",
    "items":{
        "$ref":"#/definitions/HATEOASLink"
    }
}

Nested Schema : HATEOASLink

Type: object

Show Source

href(optional): string

Link href.
method(optional): string

HTTP Operation GET, POST, PUT
rel(optional): string

Link relation.

{
    "type":"object",
    "properties":{
        "method":{
            "type":"string",
            "description":"HTTP Operation GET, POST, PUT"
        },
        "rel":{
            "type":"string",
            "description":"Link relation."
        },
        "href":{
            "type":"string",
            "description":"Link href."
        }
    }
}

Nested Schema : items

Type: array

Show Source

Array of: GetGatewaysItem

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/GetGatewaysItem"
    }
}

Nested Schema : GetGatewaysItem

Match All

Show Source

Gateway
object ResourceLinksProperties

{
    "allOf":[
        {
            "$ref":"#/definitions/Gateway"
        },
        {
            "$ref":"#/definitions/ResourceLinksProperties"
        }
    ]
}

Nested Schema : Gateway

Match All

Show Source

object GatewayId
object GatewayIdentity
object GatewayDef
object GatewayMetadata

{
    "allOf":[
        {
            "$ref":"#/definitions/GatewayId"
        },
        {
            "$ref":"#/definitions/GatewayIdentity"
        },
        {
            "$ref":"#/definitions/GatewayDef"
        },
        {
            "$ref":"#/definitions/GatewayMetadata"
        }
    ]
}

Nested Schema : ResourceLinksProperties

Type: object

Show Source

links(optional): array links

Includes 'canonical'.

{
    "properties":{
        "links":{
            "type":"array",
            "description":"Includes 'canonical'.",
            "items":{
                "$ref":"#/definitions/HATEOASLink"
            }
        }
    }
}

Nested Schema : GatewayId

Type: object

Show Source

id: string

The gateway's ID.

{
    "type":"object",
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The gateway's ID."
        }
    }
}

Nested Schema : GatewayIdentity

Type: object

Show Source

name: string

The gateway's name.

{
    "type":"object",
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"The gateway's name."
        }
    }
}

Nested Schema : GatewayDef

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "description":{
            "type":"string",
            "description":"The gateway's description."
        },
        "releaseVersion":{
            "type":"string",
            "description":"The gateway's release version. This property is used only at node registration time to seed the original release version of the node."
        },
        "location":{
            "type":"string",
            "description":"The gateway's location."
        },
        "urls":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "proxyUrls":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "configuration":{
            "type":"object",
            "properties":{
            }
        },
        "firewall":{
            "type":"object",
            "properties":{
            }
        }
    }
}

Nested Schema : GatewayMetadata

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "createdBy":{
            "type":"string",
            "description":"The user who created the gateway."
        },
        "createdAt":{
            "type":"string",
            "description":"The date and time the gateway was created."
        },
        "updatedBy":{
            "type":"string",
            "description":"The user who last updated the gateway."
        },
        "updatedAt":{
            "type":"string",
            "description":"The date time the gateway was last updated."
        }
    }
}

Nested Schema : configuration

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : firewall

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : proxyUrls

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : urls

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : links

Type: array

Includes 'canonical'.

Show Source

Array of: object HATEOASLink

{
    "type":"array",
    "description":"Includes 'canonical'.",
    "items":{
        "$ref":"#/definitions/HATEOASLink"
    }
}

403 Response

Forbidden.

Root Schema : Error

Type: object

Show Source

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

{
    "type":"object",
    "required":[
        "title",
        "type"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"Error type"
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error"
        },
        "errorCode":{
            "type":"string",
            "description":"Application specific error code"
        },
        "errorPath":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"HTTP status code"
        },
        "errorDetails":{
            "type":"array",
            "description":"additional errors",
            "items":{
                "$ref":"#/definitions/Error"
            }
        }
    }
}

Nested Schema : errorDetails

Type: array

additional errors

Show Source

Array of: object Error

{
    "type":"array",
    "description":"additional errors",
    "items":{
        "$ref":"#/definitions/Error"
    }
}

500 Response

Unexpected error.

Root Schema : Error

Type: object

Show Source

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

{
    "type":"object",
    "required":[
        "title",
        "type"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"Error type"
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error"
        },
        "errorCode":{
            "type":"string",
            "description":"Application specific error code"
        },
        "errorPath":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"HTTP status code"
        },
        "errorDetails":{
            "type":"array",
            "description":"additional errors",
            "items":{
                "$ref":"#/definitions/Error"
            }
        }
    }
}

Nested Schema : errorDetails

Type: array

additional errors

Show Source

Array of: object Error

{
    "type":"array",
    "description":"additional errors",
    "items":{
        "$ref":"#/definitions/Error"
    }
}

Examples

The following example shows how to retrieve full view of the logical gateways the requesting user is authorized to view 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/gateways

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: Wed, 14 Feb 2018 11:21:50 GMT
Content-length: 1102
Content-type: application/json
X-oracle-dms-ecid: a7070a18-e96d-4e69-a511-58eafd07a798-0000f161
X-oracle-dms-rid: 0:1
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, including details of each gateway and HATEOAS links to related operations.

{
    "offset": 0,
    "count": 5,
    "limit": 128,
    "hasMore": false,
    "links": [
        {
            "method": "GET",
            "rel": "self",
            "href": "http://example.com:443/apiplatform/management/v1/gateways?offset=0=128"
        },
        {
            "method": "GET",
            "rel": "canonical",
            "href": "http://example.com:443/apiplatform/management/v1/gateways"
        },
        {
            "method": "POST",
            "rel": "create",
            "href": "http://example.com:443/apiplatform/management/v1/gateways"
        }
    ],
    "items": [
        {
            "updatedBy": "admin",
            "releaseVersion": "18.1.5",
            "description": "description",
            "createdAt": "2018-02-05T09:03:12-0800",
            "urls": [
                "http://example.com:8001",
                "https://example.com:7002"
            ],
            "proxyUrls": [],
            "firewall": {
                "maxUnboundedItems": "1024",
                "maxChildElementDepth": "1024",
                "maxItemValueLength": "102400",
                "maxMessageSize": "1024000"
            },
            "createdBy": "api-gateway-user",
            "name": "Production Gateway",
            "location": "",
            "links": [
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "self",
                    "href": "http://example.com:443/apiplatform/management/v1/gateways/100"
                },
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "canonical",
                    "href": "http://example.com:443/apiplatform/management/v1/gateways/100"
                },
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "history",
                    "href": "http://example.com:443/apiplatform/management/v1/gateways/100/history"
                },
                {
                    "templated": "true",
                    "method": "PUT",
                    "rel": "edit",
                    "href": "http://example.com:443/apiplatform/management/v1/gateways/100"
                },
                {
                    "templated": "true",
                    "method": "PUT",
                    "rel": "rename",
                    "href": "http://example.com:443/apiplatform/management/v1/gateways/100/identity"
                },
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "nodes",
                    "href": "http://example.com:443/apiplatform/management/v1/gateways/100/nodes"
                },
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "deployments",
                    "href": "http://example.com:443/apiplatform/management/v1/gateways/100/deployments"
                },
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "grants",
                    "href": "http://example.com:443/apiplatform/management/v1/gateways/100/grants"
                }
            ],
            "id": "100",
            "updatedAt": "2018-02-13T14:53:01-0800"
        },
        {
            "createdAt": "2018-02-05T20:51:22-0800",
            "urls": [],
            "proxyUrls": [],
            "updatedBy": "admin",
            "firewall": {
                "maxUnboundedItems": "1024",
                "maxChildElementDepth": "1024",
                "maxItemValueLength": "102400",
                "maxMessageSize": "1024000"
            },
            "createdBy": "admin",
            "releaseVersion": "18.1.5",
            "name": "GoldGw",
            "links": [
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "self",
                    "href": "http://example.com:443/apiplatform/management/v1/gateways/101"
                },
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "canonical",
                    "href": "http://example.com:443/apiplatform/management/v1/gateways/101"
                },
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "history",
                    "href": "http://example.com:443/apiplatform/management/v1/gateways/101/history"
                },
                {
                    "templated": "true",
                    "method": "PUT",
                    "rel": "edit",
                    "href": "http://example.com:443/apiplatform/management/v1/gateways/101"
                },
                {
                    "templated": "true",
                    "method": "PUT",
                    "rel": "rename",
                    "href": "http://example.com:443/apiplatform/management/v1/gateways/101/identity"
                },
                {
                    "templated": "true",
                    "method": "DELETE",
                    "rel": "delete",
                    "href": "http://example.com:443/apiplatform/management/v1/gateways/101"
                },
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "nodes",
                    "href": "http://example.com:443/apiplatform/management/v1/gateways/101/nodes"
                },
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "deployments",
                    "href": "http://example.com:443/apiplatform/management/v1/gateways/101/deployments"
                },
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "grants",
                    "href": "http://example.com:443/apiplatform/management/v1/gateways/101/grants"
                }
            ],
            "id": "101",
            "updatedAt": "2018-02-05T20:51:22-0800"
        },
        {
            "createdAt": "2018-02-08T00:19:34-0800",
            "urls": [
                "http://example.com"
            ],
            "proxyUrls": [],
            "updatedBy": "admin",
            "firewall": {
                "maxUnboundedItems": "1024",
                "maxChildElementDepth": "1024",
                "maxItemValueLength": "102400",
                "maxMessageSize": "1024000"
            },
            "createdBy": "admin",
            "releaseVersion": "18.1.5",
            "name": "Test",
            "location": "http://gogle.com",
            "links": [
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "self",
                    "href": "http://example.com:443/apiplatform/management/v1/gateways/102"
                },
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "canonical",
                    "href": "http://example.com:443/apiplatform/management/v1/gateways/102"
                },
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "history",
                    "href": "http://example.com:443/apiplatform/management/v1/gateways/102/history"
                },
                {
                    "templated": "true",
                    "method": "PUT",
                    "rel": "edit",
                    "href": "http://example.com:443/apiplatform/management/v1/gateways/102"
                },
                {
                    "templated": "true",
                    "method": "PUT",
                    "rel": "rename",
                    "href": "http://example.com:443/apiplatform/management/v1/gateways/102/identity"
                },
                {
                    "templated": "true",
                    "method": "DELETE",
                    "rel": "delete",
                    "href": "http://example.com:443/apiplatform/management/v1/gateways/102"
                },
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "nodes",
                    "href": "http://example.com:443/apiplatform/management/v1/gateways/102/nodes"
                },
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "deployments",
                    "href": "http://example.com:443/apiplatform/management/v1/gateways/102/deployments"
                },
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "grants",
                    "href": "http://example.com:443/apiplatform/management/v1/gateways/102/grants"
                }
            ],
            "id": "102",
            "updatedAt": "2018-02-08T00:20:40-0800"
        },
        {
            "createdAt": "2018-02-12T21:34:56-0800",
            "urls": [
                "http://example.com"
            ],
            "proxyUrls": [],
            "updatedBy": "admin",
            "firewall": {
                "maxUnboundedItems": "1024",
                "maxChildElementDepth": "1024",
                "maxItemValueLength": "102400",
                "maxMessageSize": "1024000"
            },
            "createdBy": "admin",
            "releaseVersion": "18.1.5",
            "name": "MyGateway",
            "location": "example.com",
            "links": [
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "self",
                    "href": "http://example.com:443/apiplatform/management/v1/gateways/103"
                },
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "canonical",
                    "href": "http://example.com:443/apiplatform/management/v1/gateways/103"
                },
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "history",
                    "href": "http://example.com:443/apiplatform/management/v1/gateways/103/history"
                },
                {
                    "templated": "true",
                    "method": "PUT",
                    "rel": "edit",
                    "href": "http://example.com:443/apiplatform/management/v1/gateways/103"
                },
                {
                    "templated": "true",
                    "method": "PUT",
                    "rel": "rename",
                    "href": "http://example.com:443/apiplatform/management/v1/gateways/103/identity"
                },
                {
                    "templated": "true",
                    "method": "DELETE",
                    "rel": "delete",
                    "href": "http://example.com:443/apiplatform/management/v1/gateways/103"
                },
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "nodes",
                    "href": "http://example.com:443/apiplatform/management/v1/gateways/103/nodes"
                },
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "deployments",
                    "href": "http://example.com:443/apiplatform/management/v1/gateways/103/deployments"
                },
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "grants",
                    "href": "http://example.com:443/apiplatform/management/v1/gateways/103/grants"
                }
            ],
            "id": "103",
            "updatedAt": "2018-02-12T21:35:46-0800"
        },
        {
            "createdAt": "2018-02-13T23:00:25-0800",
            "urls": [],
            "proxyUrls": [],
            "updatedBy": "admin",
            "firewall": {
                "maxUnboundedItems": "1024",
                "maxChildElementDepth": "1024",
                "maxItemValueLength": "102400",
                "maxMessageSize": "1024000"
            },
            "createdBy": "admin",
            "releaseVersion": "18.1.5",
            "name": "New",
            "links": [
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "self",
                    "href": "http://example.com:443/apiplatform/management/v1/gateways/104"
                },
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "canonical",
                    "href": "http://example.com:443/apiplatform/management/v1/gateways/104"
                },
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "history",
                    "href": "http://example.com:443/apiplatform/management/v1/gateways/104/history"
                },
                {
                    "templated": "true",
                    "method": "PUT",
                    "rel": "edit",
                    "href": "http://example.com:443/apiplatform/management/v1/gateways/104"
                },
                {
                    "templated": "true",
                    "method": "PUT",
                    "rel": "rename",
                    "href": "http://example.com:443/apiplatform/management/v1/gateways/104/identity"
                },
                {
                    "templated": "true",
                    "method": "DELETE",
                    "rel": "delete",
                    "href": "http://example.com:443/apiplatform/management/v1/gateways/104"
                },
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "nodes",
                    "href": "http://example.com:443/apiplatform/management/v1/gateways/104/nodes"
                },
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "deployments",
                    "href": "http://example.com:443/apiplatform/management/v1/gateways/104/deployments"
                },
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "grants",
                    "href": "http://example.com:443/apiplatform/management/v1/gateways/104/grants"
                }
            ],
            "id": "104",
            "updatedAt": "2018-02-13T23:00:25-0800"
        }
    ]
}