class Build::DefaultApi

• Build::DefaultApi
• Reference
• Object

Defined in:

build-client/api/default_api.cr

Constructors

• .new(api_client : ::Build::ApiClient = ApiClient.default)

Instance Method Summary

• #api_client : ApiClient
• #api_client=(api_client : ApiClient)
• #api_v1_environments_id_get(id : String)

  get environment config-vars (e.g.

• #api_v1_environments_id_get_with_http_info(id : String)

  get environment config-vars (e.g.

• #api_v1_environments_id_key_delete(id : String, key : String)

  delete environment config-var @param id [String] Environment ID @param key [String] config var key @return [nil]

• #api_v1_environments_id_key_delete_with_http_info(id : String, key : String)

  delete environment config-var @param id [String] Environment ID @param key [String] config var key @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

• #api_v1_environments_id_patch(id : String, request_body : Hash(String, String) | Nil = nil)

  set or update environment config-vars (e.g.

• #api_v1_environments_id_patch_with_http_info(id : String, request_body : Hash(String, String) | Nil = nil)

  set or update environment config-vars (e.g.

• #app(app_id_or_name : String)

  show app @param app_id_or_name [String] app id or name @return [App]

• #app_with_http_info(app_id_or_name : String)

  show app @param app_id_or_name [String] app id or name @return [Array<(App, Integer, Hash)>] App data, response status code and response headers

• #apps(team_id : String | Nil = nil)

  list apps List all apps @return [Array(App)]

• #apps_with_http_info(team_id : String | Nil = nil)

  list apps List all apps @return [Array<(Array(App), Integer, Hash)>] Array(App) data, response status code and response headers

• #build(app_id : String, id : String)

  show build A single build.

• #build_with_http_info(app_id : String, id : String)

  show build A single build.

• #builds(app_id : String, limit : Int32 | Nil = nil, cursor : String | Nil = nil)

  list builds Builds for an app, newest first.

• #builds_with_http_info(app_id : String, limit : Int32 | Nil = nil, cursor : String | Nil = nil)

  list builds Builds for an app, newest first.

• #config_vars(app_id_or_name : String)

  list all config-vars @param app_id_or_name [String] app id or name @return [Hash(String, String)]

• #config_vars_with_http_info(app_id_or_name : String)

  list all config-vars @param app_id_or_name [String] app id or name @return [Array<(Hash(String, String), Integer, Hash)>] Hash(String, String) data, response status code and response headers

• #create_app(create_app_request : CreateAppRequest | Nil = nil)

  create app @return [App]

• #create_app_with_http_info(create_app_request : CreateAppRequest | Nil = nil)

  create app @return [Array<(App, Integer, Hash)>] App data, response status code and response headers

• #create_namespace(create_namespace_request : CreateNamespaceRequest | Nil = nil)

  create a namespace Create a namespace (deprecated - namespaces are now managed by Kubernetes) @return [nil]

• #create_namespace_with_http_info(create_namespace_request : CreateNamespaceRequest | Nil = nil)

  create a namespace Create a namespace (deprecated - namespaces are now managed by Kubernetes) @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

• #delete_config_var(app_id_or_name : String, key : String)

  delete config-var Delete a config-var @param app_id_or_name [String] app id or name @param key [String] config var key @return [nil]

• #delete_config_var_with_http_info(app_id_or_name : String, key : String)

  delete config-var Delete a config-var @param app_id_or_name [String] app id or name @param key [String] config var key @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

• #delete_namespace(namespace_id_or_name : String)

  delete a namespace Delete a namespace @param namespace_id_or_name [String] Namespace name or ID @return [nil]

• #delete_namespace_with_http_info(namespace_id_or_name : String)

  delete a namespace Delete a namespace @param namespace_id_or_name [String] Namespace name or ID @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

• #deployment(app_id : String, id : String)

  show deployment @param app_id [String] app id or name @param id [String] deployment id @return [Deployment]

• #deployment_with_http_info(app_id : String, id : String)

  show deployment @param app_id [String] app id or name @param id [String] deployment id @return [Array<(Deployment, Integer, Hash)>] Deployment data, response status code and response headers

• #deployments(app_id : String, limit : Int32 | Nil = nil, cursor : String | Nil = nil)

  list deployments Deployments for an app, newest first.

• #deployments_with_http_info(app_id : String, limit : Int32 | Nil = nil, cursor : String | Nil = nil)

  list deployments Deployments for an app, newest first.

• #exec_dyno(app_id_or_name : String, dyno : String, dyno_exec_request : DynoExecRequest)

  exec into dyno @param app_id_or_name [String] app id or name @param dyno [String] dyno name @param dyno_exec_request [DynoExecRequest] @return [DynoExecResponse]

• #exec_dyno_with_http_info(app_id_or_name : String, dyno : String, dyno_exec_request : DynoExecRequest)

  exec into dyno @param app_id_or_name [String] app id or name @param dyno [String] dyno name @param dyno_exec_request [DynoExecRequest] @return [Array<(DynoExecResponse, Integer, Hash)>] DynoExecResponse data, response status code and response headers

• #list_dynos(app_id_or_name : String)

  list dynos @param app_id_or_name [String] app id or name @return [Array(Dyno)]

• #list_dynos_with_http_info(app_id_or_name : String)

  list dynos @param app_id_or_name [String] app id or name @return [Array<(Array(Dyno), Integer, Hash)>] Array(Dyno) data, response status code and response headers

• #me

  identity Returns identity info for the bearer.

• #me_with_http_info

  identity Returns identity info for the bearer.

• #namespace(namespace_id_or_name : String)

  show namespace Show a namespace @param namespace_id_or_name [String] Namespace name or ID @return [Namespace]

• #namespace_with_http_info(namespace_id_or_name : String)

  show namespace Show a namespace @param namespace_id_or_name [String] Namespace name or ID @return [Array<(Namespace, Integer, Hash)>] Namespace data, response status code and response headers

• #namespaces

  list all namespaces List all namespaces @return [Array(Namespace)]

• #namespaces_with_http_info

  list all namespaces List all namespaces @return [Array<(Array(Namespace), Integer, Hash)>] Array(Namespace) data, response status code and response headers

• #oidc_login(region : String | Nil = nil)

  kubernetes oidc-login @return [OidcLoginResponse]

• #oidc_login_with_http_info(region : String | Nil = nil)

  kubernetes oidc-login @return [Array<(OidcLoginResponse, Integer, Hash)>] OidcLoginResponse data, response status code and response headers

• #restart_all_dynos(app_id_or_name : String)

  restart all dynos @param app_id_or_name [String] app id or name @return [nil]

• #restart_all_dynos_with_http_info(app_id_or_name : String)

  restart all dynos @param app_id_or_name [String] app id or name @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

• #restart_dynos(app_id_or_name : String, dyno : String)

  restart specific dyno @param app_id_or_name [String] app id or name @param dyno [String] dyno name @return [nil]

• #restart_dynos_with_http_info(app_id_or_name : String, dyno : String)

  restart specific dyno @param app_id_or_name [String] app id or name @param dyno [String] dyno name @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

• #run_dyno(app_id_or_name : String, dyno_run_request : DynoRunRequest)

  run one-off command @param app_id_or_name [String] app id or name @param dyno_run_request [DynoRunRequest] @return [DynoRunResponse]

• #run_dyno_with_http_info(app_id_or_name : String, dyno_run_request : DynoRunRequest)

  run one-off command @param app_id_or_name [String] app id or name @param dyno_run_request [DynoRunRequest] @return [Array<(DynoRunResponse, Integer, Hash)>] DynoRunResponse data, response status code and response headers

• #set_config_vars(app_id_or_name : String, request_body : Hash(String, String) | Nil = nil)

  set or update config-vars @param app_id_or_name [String] app id or name @return [nil]

• #set_config_vars_with_http_info(app_id_or_name : String, request_body : Hash(String, String) | Nil = nil)

  set or update config-vars @param app_id_or_name [String] app id or name @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

• #team(id : String)

  show team Show a team @param id [String] Team name or ID @return [Team]

• #team_with_http_info(id : String)

  show team Show a team @param id [String] Team name or ID @return [Array<(Team, Integer, Hash)>] Team data, response status code and response headers

• #teams

  list all teams List all teams @return [Array(Team)]

• #teams_with_http_info

  list all teams List all teams @return [Array<(Array(Team), Integer, Hash)>] Array(Team) data, response status code and response headers

• #update_app(app_id_or_name : String, update_app_request : UpdateAppRequest | Nil = nil)

  update app Update app attributes.

• #update_app_with_http_info(app_id_or_name : String, update_app_request : UpdateAppRequest | Nil = nil)

  update app Update app attributes.

Constructor Detail

Instance Method Detail