Skip to content

Files

Latest commit

 

History

History
276 lines (192 loc) · 9.01 KB

SyslogRoutesAPI.md

File metadata and controls

276 lines (192 loc) · 9.01 KB

\SyslogRoutesAPI

All URIs are relative to http://localhost

Method HTTP request Description
CreateSyslogRoute Post /api/{org_id}/syslog-routes CreateSyslogRoute
DeleteSyslogRoute Delete /api/{org_id}/syslog-routes/{id} DeleteSyslogRoute
ListSyslogRoutes Get /api/{org_id}/syslog-routes ListSyslogRoutes
UpdateSyslogRoute Put /api/{org_id}/syslog-routes/{id} UpdateSyslogRoute

CreateSyslogRoute

SyslogRoute CreateSyslogRoute(ctx, orgId).SyslogRoute(syslogRoute).Execute()

CreateSyslogRoute

Example

package main

import (
	"context"
	"fmt"
	"os"
	openobserve "github.com/rachzy/sdk-go-openobserve"
)

func main() {
	orgId := "orgId_example" // string | Organization name
	syslogRoute := *openobserve.NewSyslogRoute() // SyslogRoute | SyslogRoute details

	configuration := openobserve.NewConfiguration()
	apiClient := openobserve.NewAPIClient(configuration)
	resp, r, err := apiClient.SyslogRoutesAPI.CreateSyslogRoute(context.Background(), orgId).SyslogRoute(syslogRoute).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SyslogRoutesAPI.CreateSyslogRoute``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `CreateSyslogRoute`: SyslogRoute
	fmt.Fprintf(os.Stdout, "Response from `SyslogRoutesAPI.CreateSyslogRoute`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
orgId string Organization name

Other Parameters

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

Name Type Description Notes

syslogRoute | SyslogRoute | SyslogRoute details |

Return type

SyslogRoute

Authorization

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteSyslogRoute

HttpResponse DeleteSyslogRoute(ctx, orgId, id).Execute()

DeleteSyslogRoute

Example

package main

import (
	"context"
	"fmt"
	"os"
	openobserve "github.com/rachzy/sdk-go-openobserve"
)

func main() {
	orgId := "orgId_example" // string | Organization name
	id := "id_example" // string | SyslogRoute Id

	configuration := openobserve.NewConfiguration()
	apiClient := openobserve.NewAPIClient(configuration)
	resp, r, err := apiClient.SyslogRoutesAPI.DeleteSyslogRoute(context.Background(), orgId, id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SyslogRoutesAPI.DeleteSyslogRoute``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `DeleteSyslogRoute`: HttpResponse
	fmt.Fprintf(os.Stdout, "Response from `SyslogRoutesAPI.DeleteSyslogRoute`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
orgId string Organization name
id string SyslogRoute Id

Other Parameters

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

Name Type Description Notes

Return type

HttpResponse

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListSyslogRoutes

SyslogRoutes ListSyslogRoutes(ctx, orgId).Execute()

ListSyslogRoutes

Example

package main

import (
	"context"
	"fmt"
	"os"
	openobserve "github.com/rachzy/sdk-go-openobserve"
)

func main() {
	orgId := "orgId_example" // string | Organization name

	configuration := openobserve.NewConfiguration()
	apiClient := openobserve.NewAPIClient(configuration)
	resp, r, err := apiClient.SyslogRoutesAPI.ListSyslogRoutes(context.Background(), orgId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SyslogRoutesAPI.ListSyslogRoutes``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListSyslogRoutes`: SyslogRoutes
	fmt.Fprintf(os.Stdout, "Response from `SyslogRoutesAPI.ListSyslogRoutes`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
orgId string Organization name

Other Parameters

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

Name Type Description Notes

Return type

SyslogRoutes

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateSyslogRoute

SyslogRoute UpdateSyslogRoute(ctx, orgId, id).SyslogRoute(syslogRoute).Execute()

UpdateSyslogRoute

Example

package main

import (
	"context"
	"fmt"
	"os"
	openobserve "github.com/rachzy/sdk-go-openobserve"
)

func main() {
	orgId := "orgId_example" // string | Organization name
	id := "id_example" // string | Route ID
	syslogRoute := *openobserve.NewSyslogRoute() // SyslogRoute | SyslogRoute details

	configuration := openobserve.NewConfiguration()
	apiClient := openobserve.NewAPIClient(configuration)
	resp, r, err := apiClient.SyslogRoutesAPI.UpdateSyslogRoute(context.Background(), orgId, id).SyslogRoute(syslogRoute).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SyslogRoutesAPI.UpdateSyslogRoute``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `UpdateSyslogRoute`: SyslogRoute
	fmt.Fprintf(os.Stdout, "Response from `SyslogRoutesAPI.UpdateSyslogRoute`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
orgId string Organization name
id string Route ID

Other Parameters

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

Name Type Description Notes

syslogRoute | SyslogRoute | SyslogRoute details |

Return type

SyslogRoute

Authorization

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]