RoutesApi

All URIs are relative to https://apigateway.de-txl.ionos.com

Method	HTTP request	Description
ApigatewaysRoutesDelete	Delete /gateways/{apigatewayId}/routes/{routeId}	Delete Route
ApigatewaysRoutesFindById	Get /gateways/{apigatewayId}/routes/{routeId}	Retrieve Route
ApigatewaysRoutesGet	Get /gateways/{apigatewayId}/routes	Retrieve all Routes
ApigatewaysRoutesPost	Post /gateways/{apigatewayId}/routes	Create Route
ApigatewaysRoutesPut	Put /gateways/{apigatewayId}/routes/{routeId}	Ensure Route

Method

HTTP request

Description

ApigatewaysRoutesDelete

Delete /gateways/{apigatewayId}/routes/{routeId}

Delete Route

ApigatewaysRoutesFindById

Get /gateways/{apigatewayId}/routes/{routeId}

Retrieve Route

ApigatewaysRoutesGet

Get /gateways/{apigatewayId}/routes

Retrieve all Routes

ApigatewaysRoutesPost

Post /gateways/{apigatewayId}/routes

Create Route

ApigatewaysRoutesPut

Put /gateways/{apigatewayId}/routes/{routeId}

Ensure Route

ApigatewaysRoutesDelete

var result  = ApigatewaysRoutesDelete(ctx, apigatewayId, routeId)
                      .Execute()

Delete Route

Example

package main

import (
    "context"
    "fmt"
    "os"

    ionoscloud "github.com/ionos-cloud/sdk-go-api-gateway"
)

func main() {
    apigatewayId := "0620c174-dd3c-5eb4-87c8-e2b516553a00" // string | The ID (UUID) of the Gateway.
    routeId := "50982018-bb17-5cb9-bcd4-97f8bbc7dc23" // string | The ID (UUID) of the Route.

    configuration := ionoscloud.NewConfiguration("USERNAME", "PASSWORD", "TOKEN", "HOST_URL")
    apiClient := ionoscloud.NewAPIClient(configuration)
    resp, err := apiClient.RoutesApi.ApigatewaysRoutesDelete(context.Background(), apigatewayId, routeId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `RoutesApi.ApigatewaysRoutesDelete``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", resp)
    }
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
apigatewayId	string	The ID (UUID) of the Gateway.
routeId	string	The ID (UUID) of the Route.

Name

Type

Description

Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

apigatewayId

string

The ID (UUID) of the Gateway.

routeId

string

The ID (UUID) of the Route.

Other Parameters

Other parameters are passed through a pointer to an apiApigatewaysRoutesDeleteRequest struct via the builder pattern

Return type

(empty response body)

HTTP request headers

Content-Type: Not defined
Accept: application/json

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "RoutesApiService.ApigatewaysRoutesDelete" string. Similar rules for overriding default operation server index and variables apply by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), {packageName}.ContextOperationServerIndices, map[string]int{
    "RoutesApiService.ApigatewaysRoutesDelete": 2,
})
ctx = context.WithValue(context.Background(), {packageName}.ContextOperationServerVariables, map[string]map[string]string{
    "RoutesApiService.ApigatewaysRoutesDelete": {
    "port": "8443",
},
})

ApigatewaysRoutesFindById

var result RouteRead = ApigatewaysRoutesFindById(ctx, apigatewayId, routeId)
                      .Execute()

Retrieve Route

Example

package main

import (
    "context"
    "fmt"
    "os"

    ionoscloud "github.com/ionos-cloud/sdk-go-api-gateway"
)

func main() {
    apigatewayId := "0620c174-dd3c-5eb4-87c8-e2b516553a00" // string | The ID (UUID) of the Gateway.
    routeId := "50982018-bb17-5cb9-bcd4-97f8bbc7dc23" // string | The ID (UUID) of the Route.

    configuration := ionoscloud.NewConfiguration("USERNAME", "PASSWORD", "TOKEN", "HOST_URL")
    apiClient := ionoscloud.NewAPIClient(configuration)
    resource, resp, err := apiClient.RoutesApi.ApigatewaysRoutesFindById(context.Background(), apigatewayId, routeId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `RoutesApi.ApigatewaysRoutesFindById``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", resp)
    }
    // response from `ApigatewaysRoutesFindById`: RouteRead
    fmt.Fprintf(os.Stdout, "Response from `RoutesApi.ApigatewaysRoutesFindById`: %v\n", resource)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
apigatewayId	string	The ID (UUID) of the Gateway.
routeId	string	The ID (UUID) of the Route.

Name

Type

Description

Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

apigatewayId

string

The ID (UUID) of the Gateway.

routeId

string

The ID (UUID) of the Route.

Other Parameters

Other parameters are passed through a pointer to an apiApigatewaysRoutesFindByIdRequest struct via the builder pattern

Return type

RouteRead

HTTP request headers

Content-Type: Not defined
Accept: application/json

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "RoutesApiService.ApigatewaysRoutesFindById" string. Similar rules for overriding default operation server index and variables apply by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), {packageName}.ContextOperationServerIndices, map[string]int{
    "RoutesApiService.ApigatewaysRoutesFindById": 2,
})
ctx = context.WithValue(context.Background(), {packageName}.ContextOperationServerVariables, map[string]map[string]string{
    "RoutesApiService.ApigatewaysRoutesFindById": {
    "port": "8443",
},
})

ApigatewaysRoutesGet

var result RouteReadList = ApigatewaysRoutesGet(ctx, apigatewayId)
                      .Offset(offset)
                      .Limit(limit)
                      .OrderBy(orderBy)
                      .Execute()

Retrieve all Routes

Example

package main

import (
    "context"
    "fmt"
    "os"

    ionoscloud "github.com/ionos-cloud/sdk-go-api-gateway"
)

func main() {
    apigatewayId := "0620c174-dd3c-5eb4-87c8-e2b516553a00" // string | The ID (UUID) of the Gateway.
    offset := int32(0) // int32 | The first element (of the total list of elements) to include in the response. Use together with limit for pagination. (optional) (default to 0)
    limit := int32(100) // int32 | The maximum number of elements to return. Use together with offset for pagination. (optional) (default to 100)
    orderBy := "orderBy_example" // string | The field to order the results by. If not provided, the results will be ordered by the default field. (optional) (default to "-createdDate")

    configuration := ionoscloud.NewConfiguration("USERNAME", "PASSWORD", "TOKEN", "HOST_URL")
    apiClient := ionoscloud.NewAPIClient(configuration)
    resource, resp, err := apiClient.RoutesApi.ApigatewaysRoutesGet(context.Background(), apigatewayId).Offset(offset).Limit(limit).OrderBy(orderBy).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `RoutesApi.ApigatewaysRoutesGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", resp)
    }
    // response from `ApigatewaysRoutesGet`: RouteReadList
    fmt.Fprintf(os.Stdout, "Response from `RoutesApi.ApigatewaysRoutesGet`: %v\n", resource)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
apigatewayId	string	The ID (UUID) of the Gateway.

Name

Type

Description

Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

apigatewayId

string

The ID (UUID) of the Gateway.

Other Parameters

Other parameters are passed through a pointer to an apiApigatewaysRoutesGetRequest struct via the builder pattern

Name	Type	Description	Notes
offset	int32	The first element (of the total list of elements) to include in the response. Use together with limit for pagination.	[default to 0]
limit	int32	The maximum number of elements to return. Use together with offset for pagination.	[default to 100]
orderBy	string	The field to order the results by. If not provided, the results will be ordered by the default field.	[default to "-createdDate"]

Name

Type

Description

Notes

offset

int32

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

[default to 0]

limit

int32

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

[default to 100]

orderBy

string

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

[default to "-createdDate"]

Return type

RouteReadList

HTTP request headers

Content-Type: Not defined
Accept: application/json

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "RoutesApiService.ApigatewaysRoutesGet" string. Similar rules for overriding default operation server index and variables apply by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), {packageName}.ContextOperationServerIndices, map[string]int{
    "RoutesApiService.ApigatewaysRoutesGet": 2,
})
ctx = context.WithValue(context.Background(), {packageName}.ContextOperationServerVariables, map[string]map[string]string{
    "RoutesApiService.ApigatewaysRoutesGet": {
    "port": "8443",
},
})

ApigatewaysRoutesPost

var result RouteRead = ApigatewaysRoutesPost(ctx, apigatewayId)
                      .RouteCreate(routeCreate)
                      .Execute()

Create Route

Example

package main

import (
    "context"
    "fmt"
    "os"

    ionoscloud "github.com/ionos-cloud/sdk-go-api-gateway"
)

func main() {
    apigatewayId := "0620c174-dd3c-5eb4-87c8-e2b516553a00" // string | The ID (UUID) of the Gateway.
    routeCreate := *openapiclient.NewRouteCreate(*openapiclient.NewRoute("Name_example", "Type_example", []string{"Paths_example"}, []string{"Methods_example"}, []openapiclient.RouteUpstreams{*openapiclient.NewRouteUpstreams("Scheme_example", "Loadbalancer_example", "Host_example", int32(123))})) // RouteCreate | Route to create.

    configuration := ionoscloud.NewConfiguration("USERNAME", "PASSWORD", "TOKEN", "HOST_URL")
    apiClient := ionoscloud.NewAPIClient(configuration)
    resource, resp, err := apiClient.RoutesApi.ApigatewaysRoutesPost(context.Background(), apigatewayId).RouteCreate(routeCreate).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `RoutesApi.ApigatewaysRoutesPost``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", resp)
    }
    // response from `ApigatewaysRoutesPost`: RouteRead
    fmt.Fprintf(os.Stdout, "Response from `RoutesApi.ApigatewaysRoutesPost`: %v\n", resource)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
apigatewayId	string	The ID (UUID) of the Gateway.

Name

Type

Description

Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

apigatewayId

string

The ID (UUID) of the Gateway.

Other Parameters

Other parameters are passed through a pointer to an apiApigatewaysRoutesPostRequest struct via the builder pattern

Name	Type	Description	Notes
routeCreate	RouteCreate	Route to create.

Name

Type

Description

Notes

routeCreate

RouteCreate

Route to create.

Return type

RouteRead

HTTP request headers

Content-Type: application/json
Accept: application/json

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "RoutesApiService.ApigatewaysRoutesPost" string. Similar rules for overriding default operation server index and variables apply by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), {packageName}.ContextOperationServerIndices, map[string]int{
    "RoutesApiService.ApigatewaysRoutesPost": 2,
})
ctx = context.WithValue(context.Background(), {packageName}.ContextOperationServerVariables, map[string]map[string]string{
    "RoutesApiService.ApigatewaysRoutesPost": {
    "port": "8443",
},
})

ApigatewaysRoutesPut

var result RouteRead = ApigatewaysRoutesPut(ctx, apigatewayId, routeId)
                      .RouteEnsure(routeEnsure)
                      .Execute()

Ensure Route

Example

package main

import (
    "context"
    "fmt"
    "os"

    ionoscloud "github.com/ionos-cloud/sdk-go-api-gateway"
)

func main() {
    apigatewayId := "0620c174-dd3c-5eb4-87c8-e2b516553a00" // string | The ID (UUID) of the Gateway.
    routeId := "50982018-bb17-5cb9-bcd4-97f8bbc7dc23" // string | The ID (UUID) of the Route.
    routeEnsure := *openapiclient.NewRouteEnsure("50982018-bb17-5cb9-bcd4-97f8bbc7dc23", *openapiclient.NewRoute("Name_example", "Type_example", []string{"Paths_example"}, []string{"Methods_example"}, []openapiclient.RouteUpstreams{*openapiclient.NewRouteUpstreams("Scheme_example", "Loadbalancer_example", "Host_example", int32(123))})) // RouteEnsure | update Route

    configuration := ionoscloud.NewConfiguration("USERNAME", "PASSWORD", "TOKEN", "HOST_URL")
    apiClient := ionoscloud.NewAPIClient(configuration)
    resource, resp, err := apiClient.RoutesApi.ApigatewaysRoutesPut(context.Background(), apigatewayId, routeId).RouteEnsure(routeEnsure).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `RoutesApi.ApigatewaysRoutesPut``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", resp)
    }
    // response from `ApigatewaysRoutesPut`: RouteRead
    fmt.Fprintf(os.Stdout, "Response from `RoutesApi.ApigatewaysRoutesPut`: %v\n", resource)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
apigatewayId	string	The ID (UUID) of the Gateway.
routeId	string	The ID (UUID) of the Route.

Name

Type

Description

Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

apigatewayId

string

The ID (UUID) of the Gateway.

routeId

string

The ID (UUID) of the Route.

Other Parameters

Other parameters are passed through a pointer to an apiApigatewaysRoutesPutRequest struct via the builder pattern

Name	Type	Description	Notes
routeEnsure	RouteEnsure	update Route

Name

Type

Description

Notes

routeEnsure

RouteEnsure

update Route

Return type

RouteRead

HTTP request headers

Content-Type: application/json
Accept: application/json

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "RoutesApiService.ApigatewaysRoutesPut" string. Similar rules for overriding default operation server index and variables apply by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), {packageName}.ContextOperationServerIndices, map[string]int{
    "RoutesApiService.ApigatewaysRoutesPut": 2,
})
ctx = context.WithValue(context.Background(), {packageName}.ContextOperationServerVariables, map[string]map[string]string{
    "RoutesApiService.ApigatewaysRoutesPut": {
    "port": "8443",
},
})

PreviousAPIGatewaysApi NextError

Last updated 3 months ago