Manager
Device Manager UI.
CheckDomain
Endpoint
1 |
|
Authorized User Role
1 |
|
Request Body
Field | Type | Required |
---|---|---|
domain | string | yes |
Response
A boolean.
Create
Create a device manager
This call created a device manager object. This must be paired with a cloud object using the same ID.
Endpoint
1 |
|
Authorized User Role
1 |
|
Request Body
Field | Type |
---|---|
app | string |
cloudId | string |
domain | string |
logo | string |
name | string |
region | string |
title | string |
version | string |
Response
A manager object.
Field | Type |
---|---|
accountId | string |
app | string |
logo | string |
certArn | string |
cloudFront | string |
cloudId | string |
distributionId | string |
domain | string |
error | string |
id | string |
name | string |
priorDomain | string |
provisioned | date |
region | string |
title | string |
type | string |
version | string |
Find
Get a list of device managers
Endpoint
1 |
|
Authorized User Role
1 |
|
Request Body
Field | Type |
---|---|
id | string |
Query String Options
Field | Type |
---|---|
hidden | boolean |
filter | string |
limit | number |
next | object |
prev | object |
index | string |
where | string |
log | boolean |
Response
Paged response.
Field | Type | Notes |
---|---|---|
data | array | A list of cloud 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. |
Manager
An array of Manager items.
Field | Type |
---|---|
accountId | string |
app | string |
logo | string |
certArn | string |
cloudFront | string |
cloudId | string |
distributionId | string |
domain | string |
error | string |
id | string |
name | string |
priorDomain | string |
provisioned | date |
region | string |
title | string |
type | string |
version | string |
Get
Get a manager object
Endpoint
1 |
|
Authorized User Role
1 |
|
Request Body
Field | Type | Required |
---|---|---|
id | string | yes |
Response
A manager object.
Field | Type |
---|---|
accountId | string |
app | string |
logo | string |
certArn | string |
cloudFront | string |
cloudId | string |
distributionId | string |
domain | string |
error | string |
id | string |
name | string |
priorDomain | string |
provisioned | date |
region | string |
title | string |
type | string |
version | string |
Init
Endpoint
1 |
|
Authorized User Role
1 |
|
Request Body
A object.
Response
A manager object.
Field | Type |
---|---|
accountId | string |
app | string |
logo | string |
certArn | string |
cloudFront | string |
cloudId | string |
distributionId | string |
domain | string |
error | string |
id | string |
name | string |
priorDomain | string |
provisioned | date |
region | string |
title | string |
type | string |
version | string |
Provision
Endpoint
1 |
|
Authorized User Role
1 |
|
Request Body
Field | Type | Required |
---|---|---|
id | string | yes |
assets | object |
Query String Options
Field | Type |
---|---|
invoke | string |
ProvisionAsync
Endpoint
1 |
|
Authorized User Role
1 |
|
Request Body
Field | Type | Required |
---|---|---|
id | string | yes |
accountId | string | yes |
assets | object |
Remove
Endpoint
1 |
|
Authorized User Role
1 |
|
Request Body
Field | Type | Required |
---|---|---|
id | string | yes |
Query String Options
Field | Type |
---|---|
invoke | string |
RemoveAsync
Endpoint
1 |
|
Authorized User Role
1 |
|
Request Body
Field | Type | Required |
---|---|---|
accountId | string | yes |
id | string | yes |
Update
Endpoint
1 |
|
Authorized User Role
1 |
|
Request Body
Field | Type |
---|---|
app | string |
cloudId | string |
domain | string |
id | string |
logo | string |
name | string |
priorDomain | string |
region | string |
title | string |
version | string |
Response
A manager object.
Field | Type |
---|---|
accountId | string |
app | string |
logo | string |
certArn | string |
cloudFront | string |
cloudId | string |
distributionId | string |
domain | string |
error | string |
id | string |
name | string |
priorDomain | string |
provisioned | date |
region | string |
title | string |
type | string |
version | string |
GetSignedUrl
Endpoint
1 |
|
Authorized User Role
1 |
|
Request Body
Field | Type |
---|---|
id | string |
clean | boolean |
filename | string |
mimeType | string |
Response
A signed URL string.