\AppsAPI

All URIs are relative to https://api.aptible.com

Method	HTTP request	Description
CreateApp	Post /accounts/{account_id}/apps	create app
DeleteApp	Delete /apps/{id}	delete app
GetApp	Get /apps/{id}	show app
ListApps	Get /apps	list apps
ListAppsForAccount	Get /accounts/{account_id}/apps	list apps
ListAppsForCertificate	Get /certificates/{certificate_id}/apps	list apps
PatchApp	Patch /apps/{id}	update app
UpdateApp	Put /apps/{id}	update app

CreateApp

App CreateApp(ctx, accountId).CreateAppRequest(createAppRequest).Execute()

create app

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/aptible/aptible-api-go/aptibleapi"
)

func main() {
	accountId := int32(56) // int32 | account_id
	createAppRequest := *openapiclient.NewCreateAppRequest("Handle_example") // CreateAppRequest |  (optional)

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	int32	account_id

Other Parameters

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

Name	Type	Description	Notes

createAppRequest | CreateAppRequest | |

Return type

App

Authorization

token

HTTP request headers

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

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

DeleteApp

DeleteApp(ctx, id).Execute()

delete app

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/aptible/aptible-api-go/aptibleapi"
)

func main() {
	id := int32(56) // int32 | id

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.AppsAPI.DeleteApp(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.DeleteApp``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

token

HTTP request headers

Content-Type: Not defined
Accept: application/hal+json

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

GetApp

App GetApp(ctx, id).Execute()

show app

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/aptible/aptible-api-go/aptibleapi"
)

func main() {
	id := int32(56) // int32 | id

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

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

Return type

App

Authorization

token

HTTP request headers

Content-Type: Not defined
Accept: application/hal+json

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

ListApps

ListAppsForAccount200Response ListApps(ctx).Page(page).Execute()

list apps

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/aptible/aptible-api-go/aptibleapi"
)

func main() {
	page := int32(56) // int32 | current page of results for pagination (optional)

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

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
page	int32	current page of results for pagination

Return type

ListAppsForAccount200Response

Authorization

token

HTTP request headers

Content-Type: Not defined
Accept: application/hal+json

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

ListAppsForAccount

ListAppsForAccount200Response ListAppsForAccount(ctx, accountId).Page(page).Execute()

list apps

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/aptible/aptible-api-go/aptibleapi"
)

func main() {
	accountId := int32(56) // int32 | account_id
	page := int32(56) // int32 | current page of results for pagination (optional)

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	int32	account_id

Other Parameters

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

Name	Type	Description	Notes

page | int32 | current page of results for pagination |

Return type

ListAppsForAccount200Response

Authorization

token

HTTP request headers

Content-Type: Not defined
Accept: application/hal+json

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

ListAppsForCertificate

ListAppsForAccount200Response ListAppsForCertificate(ctx, certificateId).Page(page).Execute()

list apps

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/aptible/aptible-api-go/aptibleapi"
)

func main() {
	certificateId := int32(56) // int32 | certificate_id
	page := int32(56) // int32 | current page of results for pagination (optional)

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
certificateId	int32	certificate_id

Other Parameters

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

Name	Type	Description	Notes

page | int32 | current page of results for pagination |

Return type

ListAppsForAccount200Response

Authorization

token

HTTP request headers

Content-Type: Not defined
Accept: application/hal+json

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

PatchApp

PatchApp(ctx, id).UpdateAppRequest(updateAppRequest).Execute()

update app

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/aptible/aptible-api-go/aptibleapi"
)

func main() {
	id := int32(56) // int32 | id
	updateAppRequest := *openapiclient.NewUpdateAppRequest() // UpdateAppRequest |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.AppsAPI.PatchApp(context.Background(), id).UpdateAppRequest(updateAppRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.PatchApp``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

updateAppRequest | UpdateAppRequest | |

Return type

(empty response body)

Authorization

token

HTTP request headers

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

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

UpdateApp

UpdateApp(ctx, id).UpdateAppRequest(updateAppRequest).Execute()

update app

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/aptible/aptible-api-go/aptibleapi"
)

func main() {
	id := int32(56) // int32 | id
	updateAppRequest := *openapiclient.NewUpdateAppRequest() // UpdateAppRequest |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.AppsAPI.UpdateApp(context.Background(), id).UpdateAppRequest(updateAppRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.UpdateApp``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

updateAppRequest | UpdateAppRequest | |

Return type

(empty response body)

Authorization

token

HTTP request headers

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

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

Files

AppsAPI.md

Latest commit

History

AppsAPI.md

File metadata and controls

\AppsAPI

CreateApp

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeleteApp

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetApp

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ListApps

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ListAppsForAccount

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ListAppsForCertificate

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

PatchApp

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

UpdateApp

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers