REST Resource: deployments

  • A Deployment represents the configuration for over-the-air updates.

  • UserAccessLevel defines a user's permission to interact with a deployment.

  • Different AccessLevels dictate whether a user can view, modify test groups, or have full control over a deployment.

  • DeploymentDetails provides read-only information about a deployment, including updates and groups.

  • UpdateHistory records individual changes made to a deployment, showing who made the change and when.

Resource: Deployment

A deployment.

JSON representation 
{
  "name": string,
  "description": string,
  "categories": [
    string
  ],
  "buildPrefixes": [
    string
  ],
  "fingerprintSubstrings": [
    string
  ],
  "apfeProductId": string,
  "userAccessLevel": {
    object (UserAccessLevel)
  },
  "updateTime": string,
  "endOfLifeUrl": string,
  "details": {
    object (DeploymentDetails)
  }
}
Fields
name

string

Output only. The name of the deployment.
description

string

The description of the deployment.
categories[]

string

Output only. The deployment categories.
buildPrefixes[]

string

Output only. The build prefix.
fingerprintSubstrings[]

string

Output only. The deployment fingerprint substring. Typically used to enforce test-keys or release-keys.
apfeProductId

string

Output only. The Product ID code for the deployment device.
userAccessLevel

object (UserAccessLevel)

Output only. User's access level to this deployment.
updateTime

string (Timestamp format)

Output only. The timestamp when the deployment was updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
endOfLifeUrl

string

The end of life url of the deployment. Setting this field to a non-empty url marks the deployment as end of life. This field must not be unset or set to empty for a deployment already marked as end of life.
details

object (DeploymentDetails)

Output only. More details of a deployment. This field should only be returned by the server when returning the deployment.

UserAccessLevel

Level of access to deployments.

JSON representation 
{
  "userEmail": string,
  "accessLevel": enum (AccessLevel)
}
Fields
userEmail

string

User's email address.
accessLevel

enum (AccessLevel)

User's access level to the deployment.

AccessLevel

The user can have different access levels to a deployment.

Enums
ACCESS_LEVEL_UNSPECIFIED Not specified.
READ_ONLY_ACCESS The user can view but not modify the deployment.
GROUPS_ONLY_ACCESS The user can modify test groups but not the production group in this deployment.
FULL_ACCESS The user can modify both test groups and the production group in this deployment.
NO_ACCESS The user has no access to this deployment.

DeploymentDetails

Details about the deployment that includes updates and groups. All of this information is read only.

JSON representation 
{
  "updates": [
    {
      object (UpdateHistory)
    }
  ],
  "groups": [
    {
      object (Group)
    }
  ],
  "configs": [
    {
      object (Config)
    }
  ],
  "versionTag": {
    object (VersionTag)
  }
}
Fields
updates[]

object (UpdateHistory)

The update history of the deployment.
groups[]

object (Group)

The groups in detailed view. Note that GroupDetails will not contain members due to size issues. If you require members, we recommend that you load them on-demand, per Group.
configs[]

object (Config)

Deployment configs.
versionTag

object (VersionTag)

The deployment version.

UpdateHistory

An update history entry. This information is read-only.

JSON representation 
{
  "updateTime": string,
  "user": string,
  "content": [
    {
      object (HistoryData)
    }
  ]
}
Fields
updateTime

string (Timestamp format)

The timestamp when the update occurred.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
user

string

The user's email address when the change was made.
content[]

object (HistoryData)

The updates that were made by this user at this time.

HistoryData

Represents a transaction. As an example, if a group was updated, it might look like this:

HistoryData {
    value = group "security updates"
    subData = HistoryData {
        value = applied ota configurations
        subData = HistoryData {
            value = config 1
        }, HistoryData {
            value = config 2
        }
    }
}
JSON representation 
{
  "value": string,
  "subData": [
    {
      object (HistoryData)
    }
  ]
}
Fields
value

string

The content of a particular change or a header if subData exists.
subData[]

object (HistoryData)

If there were multiple changes, this contains each of them.

Methods

get

 Gets a Deployment.

list

 Lists deployments.

update

 Updates a deployment.