EnginesApi.md

\EnginesApi

All URIs are relative to /v1

Method	HTTP request	Description
GetEngineById	Get /engines/{engineId}	Returns an engine by ID.
GetEngines	Get /engines	List all engines.

GetEngineById

Engine GetEngineById(ctx, engineId).Execute()

Returns an engine by ID.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    engineId := "engineId_example" // string | The ID of the engine.

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
engineId	string	The ID of the engine.

Other Parameters

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

Name	Type	Description	Notes

Return type

Engine

Authorization

ApiKeyAuth

HTTP request headers

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

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

GetEngines

ListEnginesResponse GetEngines(ctx).Execute()

List all engines.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

ListEnginesResponse

Authorization

ApiKeyAuth

HTTP request headers

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

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