--- title: "PATCH /v1alpha1/{+name}" method: PATCH path: "/v1alpha1/{+name}" tags: ["deployments"] --- # PATCH /v1alpha1/{+name} `PATCH /v1alpha1/{+name}` Updates a device. ## Path parameters - `name` string, required ## Query parameters - `updateMask` string ## Request body - SasPortalDevice - `state` 'DEVICE_STATE_UNSPECIFIED' | 'RESERVED' | 'REGISTERED' | 'DEREGISTERED' — Output only. Device state. - `currentChannels` SasPortalChannelWithScore[] — Output only. Current channels with scores. - `frequencyRange` SasPortalFrequencyRange — Frequency range from `low_frequency` to `high_frequency`. - `lowFrequencyMhz` number, double — The lowest frequency of the frequency range in MHz. - `highFrequencyMhz` number, double — The highest frequency of the frequency range in MHz. - `score` number, double — The channel score, normalized to be in the range [0,100]. - `displayName` string — Device display name. - `serialNumber` string — A serial number assigned to the device by the device manufacturer. - `grantRangeAllowlists` SasPortalFrequencyRange[] — Only ranges that are within the allowlists are available for new grants. - `lowFrequencyMhz` number, double — The lowest frequency of the frequency range in MHz. - `highFrequencyMhz` number, double — The highest frequency of the frequency range in MHz. - `fccId` string — The FCC identifier of the device. Refer to https://www.fcc.gov/oet/ea/fccid for FccID format. Accept underscores and periods because some test-SAS customers use them. - `preloadedConfig` SasPortalDeviceConfig — Information about the device configuration. - `callSign` string — The call sign of the device operator. - `userId` string — The identifier of a device user. - `category` 'DEVICE_CATEGORY_UNSPECIFIED' | 'DEVICE_CATEGORY_A' | 'DEVICE_CATEGORY_B' — FCC category of the device. - `updateTime` string, google-datetime — Output only. The last time the device configuration was edited. - `model` SasPortalDeviceModel — Information about the model of the device. - `name` string — The name of the device model. - `softwareVersion` string — The software version of the device. - `vendor` string — The name of the device vendor. - `hardwareVersion` string — The hardware version of the device. - `firmwareVersion` string — The firmware version of the device. - `installationParams` SasPortalInstallationParams — Information about the device installation parameters. - `heightType` 'HEIGHT_TYPE_UNSPECIFIED' | 'HEIGHT_TYPE_AGL' | 'HEIGHT_TYPE_AMSL' — Specifies how the height is measured. - `eirpCapability` integer — This parameter is the maximum device EIRP in units of dBm/10MHz and is an integer with a value between -127 and +47 (dBm/10 MHz) inclusive. If not included, SAS interprets it as maximum allowable EIRP in units of dBm/10MHz for device category. - `antennaGain` number, double — Peak antenna gain in dBi. This parameter is a double with a value between -127 and +128 (dBi) inclusive. Part of Release 2 to support floating-point value - `cpeCbsdIndication` boolean — If present, this parameter specifies whether the CBSD is a CPE-CBSD or not. - `antennaBeamwidth` integer — 3-dB antenna beamwidth of the antenna in the horizontal-plane in degrees. This parameter is an unsigned integer having a value between 0 and 360 (degrees) inclusive; it is optional for Category A devices and conditional for Category B devices. - `horizontalAccuracy` number, double — A positive number in meters to indicate accuracy of the device antenna horizontal location. This optional parameter should only be present if its value is less than the FCC requirement of 50 meters. - `antennaDowntilt` integer — Antenna downtilt in degrees and is an integer with a value between -90 and +90 inclusive; a negative value means the antenna is tilted up (above horizontal). This parameter is optional for Category A devices and conditional for Category B devices. - `latitude` number, double — Latitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -90.000000 to +90.000000. Positive values represent latitudes north of the equator; negative values south of the equator. - `antennaAzimuth` integer — Boresight direction of the horizontal plane of the antenna in degrees with respect to true north. The value of this parameter is an integer with a value between 0 and 359 inclusive. A value of 0 degrees means true north; a value of 90 degrees means east. This parameter is optional for Category A devices and conditional for Category B devices. - `longitude` number, double — Longitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -180.000000 to +180.000000. Positive values represent longitudes east of the prime meridian; negative values west of the prime meridian. - `indoorDeployment` boolean — Whether the device antenna is indoor or not. `true`: indoor. `false`: outdoor. - `height` number, double — Device antenna height in meters. When the `heightType` parameter value is "AGL", the antenna height should be given relative to ground level. When the `heightType` parameter value is "AMSL", it is given with respect to WGS84 datum. - `antennaModel` string — If an external antenna is used, the antenna model is optionally provided in this field. The string has a maximum length of 128 octets. - `verticalAccuracy` number, double — A positive number in meters to indicate accuracy of the device antenna vertical location. This optional parameter should only be present if its value is less than the FCC requirement of 3 meters. - `airInterface` SasPortalDeviceAirInterface — Information about the device's air interface. - `supportedSpec` string — Optional. This field is related to the `radioTechnology` and provides the air interface specification that the CBSD is compliant with at the time of registration. - `radioTechnology` 'RADIO_TECHNOLOGY_UNSPECIFIED' | 'E_UTRA' | 'CAMBIUM_NETWORKS' | 'FOUR_G_BBW_SAA_1' | 'NR' | 'DOODLE_CBRS' | 'CW' | 'REDLINE' | 'TARANA_WIRELESS' | 'FAROS' — Conditional. This field specifies the radio access technology that is used for the CBSD. - `measurementCapabilities` string[] — Measurement reporting capabilities of the device. - `state` 'DEVICE_CONFIG_STATE_UNSPECIFIED' | 'DRAFT' | 'FINAL' — State of the configuration. - `isSigned` boolean — Output only. Whether the configuration has been signed by a CPI. - `deviceMetadata` SasPortalDeviceMetadata — Device data overridable by both SAS Portal and registration requests. - `antennaModel` string — If populated, the Antenna Model Pattern to use. Format is: `RecordCreatorId:PatternId` - `interferenceCoordinationGroup` string — Interference Coordination Group (ICG). A group of CBSDs that manage their own interference with the group. For more details, see [CBRSA-TS-2001 V3.0.0](https://ongoalliance.org/wp-content/uploads/2020/02/CBRSA-TS-2001-V3.0.0_Approved-for-publication.pdf). - `commonChannelGroup` string — Common Channel Group (CCG). A group of CBSDs in the same ICG requesting a common primary channel assignment. For more details, see [CBRSA-TS-2001 V3.0.0](https://ongoalliance.org/wp-content/uploads/2020/02/CBRSA-TS-2001-V3.0.0_Approved-for-publication.pdf). - `nrqzValidated` boolean — Output only. Set to `true` if a CPI has validated that they have coordinated with the National Quiet Zone office. - `nrqzValidation` SasPortalNrqzValidation — Information about National Radio Quiet Zone validation. - `longitude` number, double — Device longitude that's associated with the validation. - `caseId` string — Validation case ID. - `latitude` number, double — Device latitude that's associated with the validation. - `cpiId` string — CPI who signed the validation. - `state` 'STATE_UNSPECIFIED' | 'DRAFT' | 'FINAL' — State of the NRQZ validation info. - `name` string — Output only. The resource path name. - `activeConfig` SasPortalDeviceConfig — Information about the device configuration. - `callSign` string — The call sign of the device operator. - `userId` string — The identifier of a device user. - `category` 'DEVICE_CATEGORY_UNSPECIFIED' | 'DEVICE_CATEGORY_A' | 'DEVICE_CATEGORY_B' — FCC category of the device. - `updateTime` string, google-datetime — Output only. The last time the device configuration was edited. - `model` SasPortalDeviceModel — Information about the model of the device. - `name` string — The name of the device model. - `softwareVersion` string — The software version of the device. - `vendor` string — The name of the device vendor. - `hardwareVersion` string — The hardware version of the device. - `firmwareVersion` string — The firmware version of the device. - `installationParams` SasPortalInstallationParams — Information about the device installation parameters. - `heightType` 'HEIGHT_TYPE_UNSPECIFIED' | 'HEIGHT_TYPE_AGL' | 'HEIGHT_TYPE_AMSL' — Specifies how the height is measured. - `eirpCapability` integer — This parameter is the maximum device EIRP in units of dBm/10MHz and is an integer with a value between -127 and +47 (dBm/10 MHz) inclusive. If not included, SAS interprets it as maximum allowable EIRP in units of dBm/10MHz for device category. - `antennaGain` number, double — Peak antenna gain in dBi. This parameter is a double with a value between -127 and +128 (dBi) inclusive. Part of Release 2 to support floating-point value - `cpeCbsdIndication` boolean — If present, this parameter specifies whether the CBSD is a CPE-CBSD or not. - `antennaBeamwidth` integer — 3-dB antenna beamwidth of the antenna in the horizontal-plane in degrees. This parameter is an unsigned integer having a value between 0 and 360 (degrees) inclusive; it is optional for Category A devices and conditional for Category B devices. - `horizontalAccuracy` number, double — A positive number in meters to indicate accuracy of the device antenna horizontal location. This optional parameter should only be present if its value is less than the FCC requirement of 50 meters. - `antennaDowntilt` integer — Antenna downtilt in degrees and is an integer with a value between -90 and +90 inclusive; a negative value means the antenna is tilted up (above horizontal). This parameter is optional for Category A devices and conditional for Category B devices. - `latitude` number, double — Latitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -90.000000 to +90.000000. Positive values represent latitudes north of the equator; negative values south of the equator. - `antennaAzimuth` integer — Boresight direction of the horizontal plane of the antenna in degrees with respect to true north. The value of this parameter is an integer with a value between 0 and 359 inclusive. A value of 0 degrees means true north; a value of 90 degrees means east. This parameter is optional for Category A devices and conditional for Category B devices. - `longitude` number, double — Longitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -180.000000 to +180.000000. Positive values represent longitudes east of the prime meridian; negative values west of the prime meridian. - `indoorDeployment` boolean — Whether the device antenna is indoor or not. `true`: indoor. `false`: outdoor. - `height` number, double — Device antenna height in meters. When the `heightType` parameter value is "AGL", the antenna height should be given relative to ground level. When the `heightType` parameter value is "AMSL", it is given with respect to WGS84 datum. - `antennaModel` string — If an external antenna is used, the antenna model is optionally provided in this field. The string has a maximum length of 128 octets. - `verticalAccuracy` number, double — A positive number in meters to indicate accuracy of the device antenna vertical location. This optional parameter should only be present if its value is less than the FCC requirement of 3 meters. - `airInterface` SasPortalDeviceAirInterface — Information about the device's air interface. - `supportedSpec` string — Optional. This field is related to the `radioTechnology` and provides the air interface specification that the CBSD is compliant with at the time of registration. - `radioTechnology` 'RADIO_TECHNOLOGY_UNSPECIFIED' | 'E_UTRA' | 'CAMBIUM_NETWORKS' | 'FOUR_G_BBW_SAA_1' | 'NR' | 'DOODLE_CBRS' | 'CW' | 'REDLINE' | 'TARANA_WIRELESS' | 'FAROS' — Conditional. This field specifies the radio access technology that is used for the CBSD. - `measurementCapabilities` string[] — Measurement reporting capabilities of the device. - `state` 'DEVICE_CONFIG_STATE_UNSPECIFIED' | 'DRAFT' | 'FINAL' — State of the configuration. - `isSigned` boolean — Output only. Whether the configuration has been signed by a CPI. - `grants` SasPortalDeviceGrant[] — Output only. Grants held by the device. - `state` 'GRANT_STATE_UNSPECIFIED' | 'GRANT_STATE_GRANTED' | 'GRANT_STATE_TERMINATED' | 'GRANT_STATE_SUSPENDED' | 'GRANT_STATE_AUTHORIZED' | 'GRANT_STATE_EXPIRED' — State of the grant. - `maxEirp` number, double — Maximum Equivalent Isotropically Radiated Power (EIRP) permitted by the grant. The maximum EIRP is in units of dBm/MHz. The value of `maxEirp` represents the average (RMS) EIRP that would be measured by the procedure defined in FCC part 96.41(e)(3). - `frequencyRange` SasPortalFrequencyRange — Frequency range from `low_frequency` to `high_frequency`. - `lowFrequencyMhz` number, double — The lowest frequency of the frequency range in MHz. - `highFrequencyMhz` number, double — The highest frequency of the frequency range in MHz. - `expireTime` string, google-datetime — The expiration time of the grant. - `suspensionReason` string[] — If the grant is suspended, the reason(s) for suspension. - `channelType` 'CHANNEL_TYPE_UNSPECIFIED' | 'CHANNEL_TYPE_GAA' | 'CHANNEL_TYPE_PAL' — Type of channel used. - `lastHeartbeatTransmitExpireTime` string, google-datetime — The transmit expiration time of the last heartbeat. - `moveList` SasPortalDpaMoveList[] — The DPA move lists on which this grant appears. - `frequencyRange` SasPortalFrequencyRange — Frequency range from `low_frequency` to `high_frequency`. - `lowFrequencyMhz` number, double — The lowest frequency of the frequency range in MHz. - `highFrequencyMhz` number, double — The highest frequency of the frequency range in MHz. - `dpaId` string — The ID of the DPA. - `grantId` string — Grant Id. ## Response `200` Successful response --- [API](https://skmtc.net/google/apis/prod-tt-sasportal.md) · [All operations](https://skmtc.net/google/apis/prod-tt-sasportal/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/google/prod-tt-sasportal/revisions/1a009d78db94/schema)