All URIs are relative to https://127.0.0.1:8080/v1

Method	HTTP request	Description
apps_app_delete	DELETE /apps/{app}	Delete an app.
apps_app_get	GET /apps/{app}	Get information for a app.
apps_app_patch	PATCH /apps/{app}	Updates an app.
apps_get	GET /apps	Get all app names.
apps_post	POST /apps	Post new app

apps_app_delete

apps_app_delete(app)

Delete an app.

Delete an app.

Example

# load the gem
require 'iron_functions'

api_instance = IronFunctions::AppsApi.new

app = "app_example" # String | Name of the app.


begin
  #Delete an app.
  api_instance.apps_app_delete(app)
rescue IronFunctions::ApiError => e
  puts "Exception when calling AppsApi->apps_app_delete: #{e}"
end

Parameters

Name	Type	Description	Notes
app	String	Name of the app.

Return type

nil (empty response body)

Authorization

No authorization required

HTTP request headers

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

apps_app_get

AppWrapper apps_app_get(app)

Get information for a app.

This gives more details about a app, such as statistics.

Example

# load the gem
require 'iron_functions'

api_instance = IronFunctions::AppsApi.new

app = "app_example" # String | name of the app.


begin
  #Get information for a app.
  result = api_instance.apps_app_get(app)
  p result
rescue IronFunctions::ApiError => e
  puts "Exception when calling AppsApi->apps_app_get: #{e}"
end

Parameters

Name	Type	Description	Notes
app	String	name of the app.

Return type

AppWrapper

Authorization

No authorization required

HTTP request headers

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

apps_app_patch

AppWrapper apps_app_patch(app, body)

Updates an app.

You can set app level settings here.

Example

# load the gem
require 'iron_functions'

api_instance = IronFunctions::AppsApi.new

app = "app_example" # String | name of the app.

body = IronFunctions::AppWrapper.new # AppWrapper | App to post.


begin
  #Updates an app.
  result = api_instance.apps_app_patch(app, body)
  p result
rescue IronFunctions::ApiError => e
  puts "Exception when calling AppsApi->apps_app_patch: #{e}"
end

Parameters

Name	Type	Description	Notes
app	String	name of the app.
body	AppWrapper	App to post.

Return type

AppWrapper

Authorization

No authorization required

HTTP request headers

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

apps_get

AppsWrapper apps_get

Get all app names.

Get a list of all the apps in the system.

Example

# load the gem
require 'iron_functions'

api_instance = IronFunctions::AppsApi.new

begin
  #Get all app names.
  result = api_instance.apps_get
  p result
rescue IronFunctions::ApiError => e
  puts "Exception when calling AppsApi->apps_get: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

AppsWrapper

Authorization

No authorization required

HTTP request headers

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

apps_post

AppWrapper apps_post(body)

Post new app

Insert a new app

Example

# load the gem
require 'iron_functions'

api_instance = IronFunctions::AppsApi.new

body = IronFunctions::AppWrapper.new # AppWrapper | App to post.


begin
  #Post new app
  result = api_instance.apps_post(body)
  p result
rescue IronFunctions::ApiError => e
  puts "Exception when calling AppsApi->apps_post: #{e}"
end

Parameters

Name	Type	Description	Notes
body	AppWrapper	App to post.

Return type

AppWrapper

Authorization

No authorization required

HTTP request headers

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