Installation by ID

Location /api/apps/{appID}/installations/{installationID}
An Installation belonging the current application. The installation is accessed by its installation ID.

Request Headers (Applies to all methods)

Authorization
header
Required: Yes

GET

/api/apps/{appID}/installations/{installationID}

Description

Retrieve the installation data.

Security

Can be performed by the administrator and the installation owner.

Headers
Name Required? type Description
Authorization Yes string Authorization header. OAuth2 Bearer token
URL Params
Name Required? type Description
installationID Yes string The ID of the installation
Responses
200

Content-Type application/vnd.kii.InstallationRetrievalResponse+json

The installation data has been retrieved successfully.
Contents
Name Type Description
installationID string The ID of the installation
installationRegistrationID string The ID of the registration that identifies the device externally.
deviceType string The type of the installation.
userID string The userID of the installation owner.
thingID string The thingID of the installation owner.
development boolean The flag that indicates if the installation is for development or production environment.
404

Content-Type application/vnd.kii.InstallationNotFoundException+json

The installation was not found.
Contents
Name Type Description
errorCode string Error code "INSTALLATION_NOT_FOUND".
message string The error message.
installationID string The ID of the installation
appID string The appID of the installation
installationRegistrationID string The registration ID for the installation
deviceType string The type of the installation
401

Content-Type application/vnd.kii.UnauthorizedAccessException+json

Not authorized to retrieve the installation.
Contents
Name Type Description
errorCode string Error code "UNAUTHORIZED".
message string The error message.
authenticatedAppID string The authenticated appID.
authenticatedPrincipalID string The authenticated principal ID (userID or thingID).

DELETE

/api/apps/{appID}/installations/{installationID}

Description

Delete the installation.

Security

Can be performed by the administrator and the installation owner.

Headers
Name Required? type Description
Authorization Yes string Authorization header. OAuth2 Bearer token
URL Params
Name Required? type Description
installationID Yes string The ID of the installation
Responses
204

Content-Type (None)

The installation has been deleted successfully.
Note This response has no contents.
404

Content-Type application/vnd.kii.InstallationNotFoundException+json

The installation was not found.
Contents
Name Type Description
errorCode string Error code "INSTALLATION_NOT_FOUND".
message string The error message.
installationID string The ID of the installation
appID string The appID of the installation
installationRegistrationID string The registration ID for the installation
deviceType string The type of the installation
401

Content-Type application/vnd.kii.UnauthorizedAccessException+json

Not authorized to delete the installation.
Contents
Name Type Description
errorCode string Error code "UNAUTHORIZED".
message string The error message.
authenticatedAppID string The authenticated appID.
authenticatedPrincipalID string The authenticated principal ID (userID or thingID).