EndPointBlank.
Copy Markdown
View Source
/api/v1/applications/:application_id/environments: where an application
is deployed, one base URL per environment. Through
EndPointBlank.Management.for_managed_client/2, a managed client's.
An application environment is %{"id", "application_id", "environment_id", "base_url", "synced_at", "inserted_at", "updated_at"}. Its "id" is what
EndPointBlank.Management.Credentials.create/3 takes as
application_environment_id.
Summary
Functions
Deploys an application to one more environment. attrs: environment_id
and base_url (required). Refused with "validation_failed" for an
environment the application is already in (including those it was created
with). Options: idempotency_key:.
Removes an application environment: %{"id", "deleted" => true}. Refused
with "has_dependents" while grants or credentials depend on it.
One page of an application's environments. Options: limit:, after:.
Every environment of an application. Raises EndPointBlank.Management.Error.
Functions
@spec create(EndPointBlank.Management.t(), String.t(), map() | keyword(), keyword()) :: EndPointBlank.Management.result(map())
Deploys an application to one more environment. attrs: environment_id
and base_url (required). Refused with "validation_failed" for an
environment the application is already in (including those it was created
with). Options: idempotency_key:.
@spec delete(EndPointBlank.Management.t(), String.t(), String.t()) :: EndPointBlank.Management.result(map())
Removes an application environment: %{"id", "deleted" => true}. Refused
with "has_dependents" while grants or credentials depend on it.
@spec list(EndPointBlank.Management.t(), String.t(), keyword()) :: EndPointBlank.Management.result(EndPointBlank.Management.Page.t())
One page of an application's environments. Options: limit:, after:.
@spec stream(EndPointBlank.Management.t(), String.t(), keyword()) :: Enumerable.t()
Every environment of an application. Raises EndPointBlank.Management.Error.