Manager

App Management.

CheckDomain

Check if a domain is available for an app.

Endpoint

POST /manager/checkDomain

Authorized User Role

admin

Request Body

Field	Type	Required	Notes
domain	string	yes	Domain.

Response

Boolean Record.

Create

Create an app.

Endpoint

POST /manager/create

Authorized User Role

admin

Request Body

Field	Type	Notes
cloudId	string	Cloud ID.
custom	boolean	Custom flag.
domain	string	Domain.
name	string	Name.
owner	string	Owner.
region	string	Region.
title	string	Title.
users	array	User allow list.
version	string	Version.
versionCurrent	string	Version current.

Response

A app/manager object.

Field	Type	Notes
accountId	string	Owning account ID.
cloudFront	string	CloudFront distribution ID.
cloudId	string	Owning cloud ID.
custom	boolean	Custom app.zip.
distributionId	string	CloudFront distribution ID.
domain	string	Manager domain.
error	string	Manager error message.
id	string	Manager ID.
name	string	Manager name.
owner	string	Manager owner.
priorDomain	string	Prior domain.
provisioned	date	When provisioned.
region	string	Manager region.
title	string	Manager title.
type	string	Cloud type.
users	array	User allow list.
version	string	Manager version.
versionCurrent	string	Current app version.

Find

Get a list of apps.

Endpoint

POST /manager/find

Authorized User Role

user

Request Body

Field	Type	Notes
id	string	App ID.

Query String Options

Field	Type	Default	Notes
index	string		Index name: primary or gs1.
limit	number		Limit number of results.
next	object		Token for next page.
prev	object		Token for previous page.

Response

Paged response.

Field	Type	Notes
data	array	An array of App/Manager records.
next	string	Paged cursor to use for the next page of items.
prev	string	Pages cursor to use for the previous page of items.

App/Manager

Field	Type	Notes
accountId	string	Owning account ID.
cloudFront	string	CloudFront distribution ID.
cloudId	string	Owning cloud ID.
custom	boolean	Custom app.zip.
distributionId	string	CloudFront distribution ID.
domain	string	Manager domain.
error	string	Manager error message.
id	string	Manager ID.
name	string	Manager name.
owner	string	Manager owner.
priorDomain	string	Prior domain.
provisioned	date	When provisioned.
region	string	Manager region.
title	string	Manager title.
type	string	Cloud type.
users	array	User allow list.
version	string	Manager version.
versionCurrent	string	Current app version.

Get

Get an app/manager by ID.

Endpoint

POST /manager/get

Authorized User Role

user

Request Body

Field	Type	Required	Notes
id	string	yes	App/Manager ID.

Response

An app/manager object.

Field	Type	Notes
accountId	string	Owning account ID.
cloudFront	string	CloudFront distribution ID.
cloudId	string	Owning cloud ID.
custom	boolean	Custom app.zip.
distributionId	string	CloudFront distribution ID.
domain	string	Manager domain.
error	string	Manager error message.
id	string	Manager ID.
name	string	Manager name.
owner	string	Manager owner.
priorDomain	string	Prior domain.
provisioned	date	When provisioned.
region	string	Manager region.
title	string	Manager title.
type	string	Cloud type.
users	array	User allow list.
version	string	Manager version.
versionCurrent	string	Current app version.

GetSignedUrl

Get a signed URL to download or upload a file to the app site.

Endpoint

POST /manager/getSignedUrl

Authorized User Role

admin

Request Body

Field	Type	Notes
id	string	App/Manager ID.
command	string	Command.
filename	string	Filename.
mimeType	string	Mime type.
size	number	File size.

Response

A signed URL string.

Provision

Provision an app site and files.

Endpoint

POST /manager/provision

Authorized User Role

admin

Request Body

Field	Type	Required	Notes
id	string	yes	App/Manager ID.
preserve	boolean		Preserve existing theme assets.

Query String Options

Field	Type	Notes
invoke	string	Invoke command.

Response

An app/manager object.

Field	Type	Notes
accountId	string	Owning account ID.
cloudFront	string	CloudFront distribution ID.
cloudId	string	Owning cloud ID.
custom	boolean	Custom app.zip.
distributionId	string	CloudFront distribution ID.
domain	string	Manager domain.
error	string	Manager error message.
id	string	Manager ID.
name	string	Manager name.
owner	string	Manager owner.
priorDomain	string	Prior domain.
provisioned	date	When provisioned.
region	string	Manager region.
title	string	Manager title.
type	string	Cloud type.
users	array	User allow list.
version	string	Manager version.
versionCurrent	string	Current app version.

Remove

Remove an app.

Endpoint

POST /manager/remove

Authorized User Role

admin

Request Body

Field	Type	Required	Notes
id	string	yes	App/Manager ID.

Query String Options

Field	Type	Notes
invoke	string	Invoke command.

Update

Update an app.

Endpoint

POST /manager/update

Authorized User Role

admin

Request Body

Field	Type	Notes
cloudId	string	Cloud ID.
custom	boolean	Custom flag.
domain	string	Domain.
id	string	App/Manager ID.
name	string	Name.
owner	string	Owner.
priorDomain	string	Prior domain.
region	string	Region.
title	string	Title.
users	array	User allow list.
version	string	Version.
versionCurrent	string	Version current.

Response

An app/manager object.

Field	Type	Notes
accountId	string	Owning account ID.
cloudFront	string	CloudFront distribution ID.
cloudId	string	Owning cloud ID.
custom	boolean	Custom app.zip.
distributionId	string	CloudFront distribution ID.
domain	string	Manager domain.
error	string	Manager error message.
id	string	Manager ID.
name	string	Manager name.
owner	string	Manager owner.
priorDomain	string	Prior domain.
provisioned	date	When provisioned.
region	string	Manager region.
title	string	Manager title.
type	string	Cloud type.
users	array	User allow list.
version	string	Manager version.
versionCurrent	string	Current app version.

UpdateDisplay

Update an app display file.

Endpoint

POST /manager/updateDisplay

Authorized User Role

admin

Request Body

Field	Type	Notes
cloudId	string	Cloud ID.
display	string	Display file contents.
id	string	App/Manager ID.

Response

An app/manager object.

Field	Type	Notes
accountId	string	Owning account ID.
cloudFront	string	CloudFront distribution ID.
cloudId	string	Owning cloud ID.
custom	boolean	Custom app.zip.
distributionId	string	CloudFront distribution ID.
domain	string	Manager domain.
error	string	Manager error message.
id	string	Manager ID.
name	string	Manager name.
owner	string	Manager owner.
priorDomain	string	Prior domain.
provisioned	date	When provisioned.
region	string	Manager region.
title	string	Manager title.
type	string	Cloud type.
users	array	User allow list.
version	string	Manager version.
versionCurrent	string	Current app version.