Skip to content

StackpackApi.md

Latest commit

 

History

History
433 lines (275 loc) · 11.5 KB

StackpackApi.md

File metadata and controls

433 lines (275 loc) · 11.5 KB

\StackpackApi

All URIs are relative to http://localhost

Method HTTP request Description
ConfirmManualSteps Post /stackpack/{stackPackName}/confirm-manual-steps/{stackPackInstanceId} Confirm manual steps
ProvisionDetails Post /stackpack/{stackPackName}/provision Provision API
ProvisionUninstall Post /stackpack/{stackPackName}/deprovision/{stackPackInstanceId} Provision API
StackPackList Get /stackpack StackPack API
StackPackUpload Post /stackpack StackPack API
UpgradeStackPack Post /stackpack/{stackPackName}/upgrade Upgrade API

ConfirmManualSteps

string ConfirmManualSteps(ctx, stackPackName, stackPackInstanceId).Execute()

Confirm manual steps

Example

package main

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

func main() {
    stackPackName := "stackPackName_example" // string | 
    stackPackInstanceId := int64(789) // int64 | 

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
stackPackName string
stackPackInstanceId int64

Other Parameters

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

Name Type Description Notes

Return type

string

Authorization

ApiToken, ServiceBearer, ServiceToken

HTTP request headers

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

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

ProvisionDetails

ProvisionResponse ProvisionDetails(ctx, stackPackName).Unlocked(unlocked).RequestBody(requestBody).Execute()

Provision API

Example

package main

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

func main() {
    stackPackName := "stackPackName_example" // string | 
    unlocked := "unlocked_example" // string | 
    requestBody := map[string]string{"key": "Inner_example"} // map[string]string |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.StackpackApi.ProvisionDetails(context.Background(), stackPackName).Unlocked(unlocked).RequestBody(requestBody).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `StackpackApi.ProvisionDetails``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProvisionDetails`: ProvisionResponse
    fmt.Fprintf(os.Stdout, "Response from `StackpackApi.ProvisionDetails`: %v\n", resp)
}

Path Parameters

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

Other Parameters

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

Name Type Description Notes

unlocked | string | | requestBody | map[string]string | |

Return type

ProvisionResponse

Authorization

ApiToken, ServiceBearer, ServiceToken

HTTP request headers

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

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

ProvisionUninstall

string ProvisionUninstall(ctx, stackPackName, stackPackInstanceId).Execute()

Provision API

Example

package main

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

func main() {
    stackPackName := "stackPackName_example" // string | 
    stackPackInstanceId := int64(789) // int64 | 

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
stackPackName string
stackPackInstanceId int64

Other Parameters

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

Name Type Description Notes

Return type

string

Authorization

ApiToken, ServiceBearer, ServiceToken

HTTP request headers

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

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

StackPackList

[]FullStackPack StackPackList(ctx).Execute()

StackPack API

Example

package main

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

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

[]FullStackPack

Authorization

ApiToken, ServiceBearer, ServiceToken

HTTP request headers

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

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

StackPackUpload

StackPack StackPackUpload(ctx).StackPack(stackPack).Execute()

StackPack API

Example

package main

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

func main() {
    stackPack := os.NewFile(1234, "some_file") // *os.File |  (optional)

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

Path Parameters

Other Parameters

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

Name Type Description Notes
stackPack *os.File

Return type

StackPack

Authorization

ApiToken, ServiceBearer, ServiceToken

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/json

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

UpgradeStackPack

string UpgradeStackPack(ctx, stackPackName).Unlocked(unlocked).Execute()

Upgrade API

Example

package main

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

func main() {
    stackPackName := "stackPackName_example" // string | 
    unlocked := "unlocked_example" // string | 

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

unlocked | string | |

Return type

string

Authorization

ApiToken, ServiceBearer, ServiceToken

HTTP request headers

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

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