Jump to

• Request
• Response
• Examples

Get gateway details

get

/apiplatform/management/v1/gateways/{gwId}

Returns details of the {gwId} gateway. The response also contains HATEOAS links to related operations.

Users requesting this resource must be assigned Plan Manager, API Manager or Gateway Manager role and must be issued the Manage Gateway or View all Details grants for the specific gateway.

Request

Supported Media Types

• application/json

Path Parameters

• gwId: string
  A unique ID referencing a specific gateway.

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"
  }

• 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"
  }

Back to Top

Response

Supported Media Types

• application/json

200 Response

The gateway's definition.

Body ()

Root Schema : GetGatewayResponse

Match All

Show Source

• object ResourceLinksProperties
• object Gateway

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

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 : Gateway

Type: object

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."
        }
    }
}

403 Response

Forbidden.

Body ()

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.

Body ()

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"
    }
}

Back to Top

Examples

The following example shows how to retrieve details for a gateway by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL

curl -i -X GET 
-u apicsadmin:password
https://example.com/apiplatform/management/v1/gateways/{gwId}

{gwId} is the unique of a gateway. To retrieve available gateway Ids, see Get 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, 29 Jun 2016 16:47:09 GMT
Content-Length: 1436
Content-Type: application/json
X-oracle-dms-ecid: 7d56ba46-299a-4fc9-8083-6e09cf042601-000044ad
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 for the gateway and HATEOAS links for related resources.

{
    "createdAt": "2017-03-07T07:08:19-0800",
    "urls": [
        "http://example.com:8001",
        "https://example.com:7002"
    ],
    "proxyUrls": [],
    "updatedBy": "apicsadmin",
    "firewall": {
        "maxUnboundedItems": "1024",
        "maxChildElementDepth": "1024",
        "maxItemValueLength": "102400",
        "maxMessageSize": "1024000"
    },
    "createdBy": "api-gateway-user",
    "name": "Production Gateway",
    "description": "Production Gateway Description",
    "links": [
        {
            "templated": "true",
            "method": "GET",
            "rel": "canonical",
            "href": "https://example.com:443/apiplatform/management/v1/gateways/100"
        },
        {
            "templated": "true",
            "method": "GET",
            "rel": "preview",
            "href": "https://example.com:443/apiplatform/management/v1/gateways/100/preview"
        },
        {
            "templated": "true",
            "method": "PUT",
            "rel": "edit",
            "href": "http://example.com.com:443/apiplatform/management/v1/gateways/100"
        },
        {
            "templated": "true",
            "method": "PUT",
            "rel": "rename",
            "href": "https://example.com:443/apiplatform/management/v1/gateways/100/identity"
        },
        {
            "templated": "true",
            "method": "GET",
            "rel": "nodes",
            "href": "https://example.com:443/apiplatform/management/v1/gateways/100/nodes"
        },
        {
            "templated": "true",
            "method": "GET",
            "rel": "deployments",
            "href": "https://example.com:443/apiplatform/management/v1/gateways/100/deployments"
        },
        {
            "templated": "true",
            "method": "GET",
            "rel": "grants",
            "href": "https://example.com:443/apiplatform/management/v1/gateways/100/grants"
        }
    ],
    "id": "100",
    "updatedAt": "2017-03-15T08:25:46-0700"
}}

Back to Top