Jump to

• Request
• Response
• Examples

Create a gateway

post

/apiplatform/management/v1/gateways

Creates a gateway.

Users requesting this resource must be assigned the Gateway Manager role.

Request

Supported Media Types

• application/json

Body ()

Root Schema : CreateGatewayRequest

Match All

Show Source

• object GatewayIdentity
• object GatewayDef

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

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

Back to Top

Response

Supported Media Types

• application/json

201 Response

The gateway was created.

Body ()

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

400 Response

Bad request, indicates a problem with the input parameters.

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

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 create a gateway by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL

curl -i -X POST 
-H "Authorization: Bearer access_token"
-H "Content-Type:application/json"
-d @new-gw.json
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 Request Body

The following shows an example of the request body in JSON format, included with the request above in a file named new-gw.json.

{
	"name": "Development Gateway",
	"description": "new dev gateway",
	"location": "http://example.com",
	"urls": ["http://example.com:8001"]
}

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, 27 Feb 2017 08:50:07 GMT
Content-Length:  12
Content-Type:  application/json
X-oracle-dms-ecid:  cdcb3d2d-01cf-49ec-8c03-fe9580ba69f3-00001e13
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 the ID of the created gateway.

{
	"id": "103"
}

Back to Top