View Source ExRender.Services (ex_render v0.2.0)

When you retrieve a service's details with the Render API, many of the returned object's fields are the sameregardless of the service's type (static site, web service, etc.). However, certain fields are returned only for certain service types.

See Service Render API reference for more details.

Summary

Functions

Returns a list of Render services owned by you or a team you belong to. Optionally filter by name, service type, region, and more.

Restart a service by id

Resume a service by id

Returns the details of a single Render service (specified by serviceId) that's owned by you or a team you belong to.

Suspend a service by id

Functions

Link to this function

list(params \\ [limit: 20])

View Source
@spec list(keyword(integer())) :: list()

Returns a list of Render services owned by you or a team you belong to. Optionally filter by name, service type, region, and more.

@spec restart(String.t()) :: boolean()

Restart a service by id

@spec resume(String.t()) :: boolean()

Resume a service by id

@spec retrieve(String.t()) :: nil | ExRender.Service.t()

Returns the details of a single Render service (specified by serviceId) that's owned by you or a team you belong to.

@spec suspend(String.t()) :: boolean()

Suspend a service by id