Skip to content

Latest commit

 

History

History
423 lines (266 loc) · 14.6 KB

ApplicationsApi.md

File metadata and controls

423 lines (266 loc) · 14.6 KB
Raw

\ApplicationsApi

All URIs are relative to https://localhost

Method HTTP request Description
AppVersionDelete Delete /v1/app/{app_name}/version/{version_name} Delete an Application Version
AppVersionGet Get /v1/app/{app_name}/version/{version_name} Get an Application Version
AppVersionPost Post /v1/app/{app_name}/version Create a New Application Version
AppVersionWhitelistEntryDelete Delete /v1/app/{app_name}/version/{version_name}/whitelist/{entry_id} Delete an ACL Entry
AppVersionWhitelistEntryGet Get /v1/app/{app_name}/version/{version_name}/whitelist/{entry_id} Get an ACL Entry
AppVersionWhitelistGet Get /v1/app/{app_name}/version/{version_name}/whitelist List All ACL Entries for an Application Version
AppVersionWhitelistPost Post /v1/app/{app_name}/version/{version_name}/whitelist Create an ACL Entry
AppVersionsGet Get /v1/app/{app_name}/versions List All Versions for an Application
AppVersionsPatch Patch /v1/app/{app_name}/version/{version_name} Update an Application Version
ApplicationDelete Delete /v1/app/{app_name} Delete an Application
ApplicationGet Get /v1/app/{app_name} Get an Application
ApplicationPatch Patch /v1/app/{app_name} Update an Application
ApplicationPost Post /v1/app Create a New Application
ApplicationsGet Get /v1/apps List All Applications

AppVersionDelete

AppVersionDelete AppVersionDelete(ctx, appName, versionName) Delete an Application Version

Delete a specific version of an application.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
appName string The name of the application
versionName string The name of the application version

Return type

AppVersionDelete

Authorization

apiKey

HTTP request headers

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

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

AppVersionGet

AppVersionPayload AppVersionGet(ctx, appName, versionName) Get an Application Version

Retrieve the specifications of an application version.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
appName string The name of the application
versionName string The name of the application version

Return type

AppVersionPayload

Authorization

apiKey

HTTP request headers

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

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

AppVersionPost

AppVersionCreateResponse AppVersionPost(ctx, appName, payload) Create a New Application Version

Create an application version associated with an application. The version contains all the specifications to create a deployment.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
appName string The name of the application associated
payload AppVersionPayload

Return type

AppVersionCreateResponse

Authorization

apiKey

HTTP request headers

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

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

AppVersionWhitelistEntryDelete

AppVersionWhitelistEntrySuccess AppVersionWhitelistEntryDelete(ctx, appName, versionName, entryId) Delete an ACL Entry

Delete an access control list entry for a specific application version

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
appName string The name of the application
versionName string The name of the application version
entryId string The unique ID of the entry

Return type

AppVersionWhitelistEntrySuccess

Authorization

apiKey

HTTP request headers

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

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

AppVersionWhitelistEntryGet

AppVersionWhitelistEntry AppVersionWhitelistEntryGet(ctx, appName, versionName, entryId) Get an ACL Entry

Retrieve a specific access control list entry for an application version.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
appName string The name of the application
versionName string The name of the application version
entryId string The unique ID of the entry

Return type

AppVersionWhitelistEntry

Authorization

apiKey

HTTP request headers

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

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

AppVersionWhitelistGet

AppVersionWhitelistResponse AppVersionWhitelistGet(ctx, appName, versionName) List All ACL Entries for an Application Version

List all the access control list entries for a specific application version.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
appName string The name of the application
versionName string The name of the application version

Return type

AppVersionWhitelistResponse

Authorization

apiKey

HTTP request headers

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

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

AppVersionWhitelistPost

AppVersionWhitelistEntrySuccess AppVersionWhitelistPost(ctx, appName, versionName, payload) Create an ACL Entry

Create an access control list entry for an app version. This will allow the specified CIDR to connect to the deployment. The option whitelisting_active must be activated in the application version.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
appName string The name of the application
versionName string The name of the application version
payload AppVersionWhitelistEntryPayload

Return type

AppVersionWhitelistEntrySuccess

Authorization

apiKey

HTTP request headers

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

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

AppVersionsGet

AppVersionList AppVersionsGet(ctx, appName) List All Versions for an Application

List all versions of a specific application.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
appName string The name of the application

Return type

AppVersionList

Authorization

apiKey

HTTP request headers

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

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

AppVersionsPatch

AppVersionUpdateResponse AppVersionsPatch(ctx, appName, versionName, payload) Update an Application Version

Update an application version with new specifications.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
appName string The name of the application
versionName string The name of the application version
payload AppVersionUpdatePayload

Return type

AppVersionUpdateResponse

Authorization

apiKey

HTTP request headers

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

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

ApplicationDelete

ApplicationDelete(ctx, appName) Delete an Application

Delete an application and all its current versions.

Required Parameters

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

Return type

(empty response body)

Authorization

apiKey

HTTP request headers

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

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

ApplicationGet

Application ApplicationGet(ctx, appName) Get an Application

Retrieve an application and its information.

Required Parameters

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

Return type

Application

Authorization

apiKey

HTTP request headers

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

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

ApplicationPatch

Application ApplicationPatch(ctx, appName, payload) Update an Application

Update an application with new information.

Required Parameters

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

Return type

Application

Authorization

apiKey

HTTP request headers

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

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

ApplicationPost

Application ApplicationPost(ctx, payload) Create a New Application

Create an application that will regroup application versions.

Required Parameters

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

Return type

Application

Authorization

apiKey

HTTP request headers

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

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

ApplicationsGet

Applications ApplicationsGet(ctx, ) List All Applications

List all the applications that you own.

Required Parameters

This endpoint does not need any parameter.

Return type

Applications

Authorization

apiKey

HTTP request headers

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

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