API docs by Redocly

IONOS Cloud - API Gateway (0.0.1)

Download OpenAPI specification:Download

API Gateway is an application that acts as a "front door" for backend services and APIs, handling client requests and routing them to the appropriate backend.

APIGateways

An API gateway consists of the generic rules and configurations of an API Gateway.

This tag groups all operations for apigateways.

Retrieve all APIGateways

This endpoint enables retrieving all APIGateways using pagination and optional filters.

Authorizations:
tokenAuth
query Parameters
offset
integer <int32> >= 0
Default: 0

The first element (of the total list of elements) to include in the response. Use together with limit for pagination.

limit
integer <int32> [ 1 .. 1000 ]
Default: 100
Example: limit=100

The maximum number of elements to return. Use together with offset for pagination.

orderBy
string
Default: "-createdDate"
Enum: "-createdDate" "-lastModifiedDate" "-name" "name" "createdDate" "lastModifiedDate"

The field to order the results by. If not provided, the results will be ordered by the default field.

Responses

Response samples

Content type
application/json
{
  • "id": "274004e3-6f41-5468-862f-64a7b3445c18",
  • "type": "collection",
  • "href": "/gateways",
  • "items": [
    ],
  • "offset": 0,
  • "limit": 42,
  • "_links": {}
}

Create Gateway

Creates a new Gateway.

The full Gateway needs to be provided to create the object. Optional data will be filled with defaults or left empty.

Authorizations:
tokenAuth
Request Body schema: application/json

Gateway to create.

object

Metadata

required
object (Gateway)

An API gateway consists of the generic rules and configurations of an API Gateway.

Responses

Request samples

Content type
application/json
{
  • "metadata": { },
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "id": "0620c174-dd3c-5eb4-87c8-e2b516553a00",
  • "type": "gateway",
  • "href": "/gateways/0620c174-dd3c-5eb4-87c8-e2b516553a00",
  • "metadata": {
    },
  • "properties": {
    }
}

Retrieve Gateway

Returns the Gateway by ID.

Authorizations:
tokenAuth
path Parameters
apigatewayId
required
string <uuid>
Example: 0620c174-dd3c-5eb4-87c8-e2b516553a00

The ID (UUID) of the Gateway.

Responses

Response samples

Content type
application/json
{
  • "id": "0620c174-dd3c-5eb4-87c8-e2b516553a00",
  • "type": "gateway",
  • "href": "/gateways/0620c174-dd3c-5eb4-87c8-e2b516553a00",
  • "metadata": {
    },
  • "properties": {
    }
}

Ensure Gateway

Ensures that the Gateway with the provided ID is created or modified. The full Gateway needs to be provided to ensure (either update or create) the Gateway. Non present data will only be filled with defaults or left empty, but not take previous values into consideration.

Authorizations:
tokenAuth
path Parameters
apigatewayId
required
string <uuid>
Example: 0620c174-dd3c-5eb4-87c8-e2b516553a00

The ID (UUID) of the Gateway.

Request Body schema: application/json

update Gateway

id
required
string <uuid>

The ID (UUID) of the Gateway.

object

Metadata

required
object (Gateway)

An API gateway consists of the generic rules and configurations of an API Gateway.

Responses

Request samples

Content type
application/json
{
  • "id": "0620c174-dd3c-5eb4-87c8-e2b516553a00",
  • "metadata": { },
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "id": "0620c174-dd3c-5eb4-87c8-e2b516553a00",
  • "type": "gateway",
  • "href": "/gateways/0620c174-dd3c-5eb4-87c8-e2b516553a00",
  • "metadata": {
    },
  • "properties": {
    }
}

Delete Gateway

Deletes the specified Gateway.

Authorizations:
tokenAuth
path Parameters
apigatewayId
required
string <uuid>
Example: 0620c174-dd3c-5eb4-87c8-e2b516553a00

The ID (UUID) of the Gateway.

Responses

Response samples

Content type
application/json
{
  • "httpStatus": 400,
  • "messages": [
    ]
}

Routes

A route is a rule that maps an incoming request to a specific backend service.

This tag groups all operations for routes.

Retrieve all Routes

This endpoint enables retrieving all Routes using pagination and optional filters.

Authorizations:
tokenAuth
path Parameters
apigatewayId
required
string <uuid>
Example: 0620c174-dd3c-5eb4-87c8-e2b516553a00

The ID (UUID) of the Gateway.

query Parameters
offset
integer <int32> >= 0
Default: 0

The first element (of the total list of elements) to include in the response. Use together with limit for pagination.

limit
integer <int32> [ 1 .. 1000 ]
Default: 100
Example: limit=100

The maximum number of elements to return. Use together with offset for pagination.

orderBy
string
Default: "-createdDate"
Enum: "-createdDate" "-lastModifiedDate" "-name" "name" "createdDate" "lastModifiedDate"

The field to order the results by. If not provided, the results will be ordered by the default field.

Responses

Response samples

Content type
application/json
{
  • "id": "38ec142f-7b7b-5707-83ba-4db7f8286cfb",
  • "type": "collection",
  • "href": "/gateways/{apigatewayId}/routes",
  • "items": [
    ],
  • "offset": 0,
  • "limit": 42,
  • "_links": {}
}

Create Route

Creates a new Route.

The full Route needs to be provided to create the object. Optional data will be filled with defaults or left empty.

Authorizations:
tokenAuth
path Parameters
apigatewayId
required
string <uuid>
Example: 0620c174-dd3c-5eb4-87c8-e2b516553a00

The ID (UUID) of the Gateway.

Request Body schema: application/json

Route to create.

object

Metadata

required
object (Route)

A route is a rule that maps an incoming request to a specific backend service.

Responses

Request samples

Content type
application/json
{
  • "metadata": { },
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "id": "50982018-bb17-5cb9-bcd4-97f8bbc7dc23",
  • "type": "route",
  • "href": "/gateways/{apigatewayId}/routes/50982018-bb17-5cb9-bcd4-97f8bbc7dc23",
  • "metadata": {
    },
  • "properties": {
    }
}

Retrieve Route

Returns the Route by ID.

Authorizations:
tokenAuth
path Parameters
apigatewayId
required
string <uuid>
Example: 0620c174-dd3c-5eb4-87c8-e2b516553a00

The ID (UUID) of the Gateway.

routeId
required
string <uuid>
Example: 50982018-bb17-5cb9-bcd4-97f8bbc7dc23

The ID (UUID) of the Route.

Responses

Response samples

Content type
application/json
{
  • "id": "50982018-bb17-5cb9-bcd4-97f8bbc7dc23",
  • "type": "route",
  • "href": "/gateways/{apigatewayId}/routes/50982018-bb17-5cb9-bcd4-97f8bbc7dc23",
  • "metadata": {
    },
  • "properties": {
    }
}

Ensure Route

Ensures that the Route with the provided ID is created or modified. The full Route needs to be provided to ensure (either update or create) the Route. Non present data will only be filled with defaults or left empty, but not take previous values into consideration.

Authorizations:
tokenAuth
path Parameters
apigatewayId
required
string <uuid>
Example: 0620c174-dd3c-5eb4-87c8-e2b516553a00

The ID (UUID) of the Gateway.

routeId
required
string <uuid>
Example: 50982018-bb17-5cb9-bcd4-97f8bbc7dc23

The ID (UUID) of the Route.

Request Body schema: application/json

update Route

id
required
string <uuid>

The ID (UUID) of the Route.

object

Metadata

required
object (Route)

A route is a rule that maps an incoming request to a specific backend service.

Responses

Request samples

Content type
application/json
{
  • "id": "50982018-bb17-5cb9-bcd4-97f8bbc7dc23",
  • "metadata": { },
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "id": "50982018-bb17-5cb9-bcd4-97f8bbc7dc23",
  • "type": "route",
  • "href": "/gateways/{apigatewayId}/routes/50982018-bb17-5cb9-bcd4-97f8bbc7dc23",
  • "metadata": {
    },
  • "properties": {
    }
}

Delete Route

Deletes the specified Route.

Authorizations:
tokenAuth
path Parameters
apigatewayId
required
string <uuid>
Example: 0620c174-dd3c-5eb4-87c8-e2b516553a00

The ID (UUID) of the Gateway.

routeId
required
string <uuid>
Example: 50982018-bb17-5cb9-bcd4-97f8bbc7dc23

The ID (UUID) of the Route.

Responses

Response samples

Content type
application/json
{
  • "httpStatus": 400,
  • "messages": [
    ]
}