Endpoints
Access Token
Manage personal access tokens to authenticate with Drogue Cloud.
GET /api/tokens/v1alpha1
List access tokens for this user.
Registry
Manage application and devices in the registry.
GET /api/registry/v1alpha1/apps
Return all the applications the user has access to
Parameters
Name | Location | Type | Description |
---|---|---|---|
labels |
query |
List of
|
Labels selectors. Labels are arbitrary <key>:<value> pairs that can be associated with a resource.
A selector matches labels values using equality, inequality and filtering.
It can check the existence of a label key, ignoring the value.
For example : Multiple selectors can be submited, separated with a coma. A coma implies a AND operation between selectors. |
limit |
query |
|
The maximum number of elements to return. |
offset |
query |
|
The number of elements to skip when returning. The elements will by ordered "by name". |
GET /api/registry/v1alpha1/apps/{application}
Return application details.
DELETE /api/registry/v1alpha1/apps/{application}
Delete existing application
PATCH /api/registry/v1alpha1/apps/{application}
FUTURE USE: Patch existing app
GET /api/registry/v1alpha1/apps/{application}/devices
Return all the devices of the application.
Parameters
Name | Location | Type | Description |
---|---|---|---|
application* |
path |
|
The name of the application. |
labels |
query |
List of
|
Labels selectors. Labels are arbitrary <key>:<value> pairs that can be associated with a resource.
A selector matches labels values using equality, inequality and filtering.
It can check the existence of a label key, ignoring the value.
For example : Multiple selectors can be submited, separated with a coma. A coma implies a AND operation between selectors. |
limit |
query |
|
The maximum number of elements to return. |
offset |
query |
|
The number of elements to skip when returning. The elements will by ordered "by name". |
GET /api/registry/v1alpha1/apps/{application}/devices/{device}
Return device details.
Parameters
Name | Location | Type | Description |
---|---|---|---|
application* |
path |
|
The name of the application. |
device* |
path |
|
The name of the device. |
PUT /api/registry/v1alpha1/apps/{application}/devices/{device}
update existing device
DELETE /api/registry/v1alpha1/apps/{application}/devices/{device}
Delete existing device
Parameters
Name | Location | Type | Description |
---|---|---|---|
application* |
path |
|
The name of the application. |
device* |
path |
|
The name of the device. |
uid |
query |
|
The expected UID of the entry, for optimistic locking. |
resourceVersion |
query |
|
The resource version of the existing data, for optimistic locking. |
PATCH /api/registry/v1alpha1/apps/{application}/devices/{device}
FUTURE USE: Patch existing device
Parameters
Name | Location | Type | Description |
---|---|---|---|
application* |
path |
|
The name of the application. |
device* |
path |
|
The name of the device. |
uid |
query |
|
The expected UID of the entry, for optimistic locking. |
resourceVersion |
query |
|
The resource version of the existing data, for optimistic locking. |
Application administration
Manage applications members and authorizations.
GET /api/admin/v1alpha1/apps/{application}/transfer-ownership
Retrieve state of the application transfer
PUT /api/admin/v1alpha1/apps/{application}/transfer-ownership
Initiate the process to transfer the ownership.
Request
Content Type | Description |
---|---|
|
RequestBodyApiAdminV1alpha1AppsApplicationTransferOwnershipPutApplicationJson |
GET /api/admin/v1alpha1/apps/{application}/members
Get the application members.
PUT /api/admin/v1alpha1/apps/{application}/members
Update existing application member list.
Responses
Code | Description |
---|---|
204 |
The application's member list was updated. |
400 |
The payload format was invalid. |
404 |
If requested application does not exist or if the user has no access to it. |
409 |
In case a resource version was provided in the update, but it did not match the current version of the resource. |
User administration
Command & Control
Send commands to devices and check the results.
POST /api/command/v1alpha1/apps/{application}/devices/{device}
Send one way commands to devices.
Parameters
Name | Location | Type | Description |
---|---|---|---|
application* |
path |
|
The name of the application. |
device* |
path |
|
The name of the device. |
command* |
query |
Command to execute |
Responses
Code | Description |
---|---|
202 |
The command was accepted for processing, but there is no further information if or when the command will be sent to the device. As commands are considered short-lived, command which cannot be sent in the near future will get discarded. |
401 |
Invalid authentication. |
404 |
Device or application not found. |
406 |
Device is not found or disabled. |
GET /api/command/v1alpha1/inbox/apps/{application}/devices/{device}
Explicitly wait for commands
Parameters
Name | Location | Type | Description |
---|---|---|---|
application* |
path |
|
The name of the application. |
device* |
path |
|
The name of the device. |
timeout |
query |
Wait for commands for specified amount of time in seconds. |
POST /api/command/v1alpha1/outbox/apps/{application}/devices/{device}
Send a command result.
Parameters
Name | Location | Type | Description |
---|---|---|---|
application* |
path |
|
The name of the application. |
device* |
path |
|
The name of the device. |
request |
query |
|
Request identifier used to correlate response with. |
status* |
query |
|
Status code of commands execution. |