Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.2.0
info:
title: Firebase App Distribution Media API
version: v1
description: Generated from Google's published Discovery document for Firebase App Distribution API (firebaseappdistribution v1, revision 20261110). 1 operation(s).
contact:
name: Google
url: https://developers.google.com/
termsOfService: https://developers.google.com/terms
servers:
- url: https://firebaseappdistribution.googleapis.com
tags:
- name: Media
paths:
/v1/projects/{projectsId}/apps/{appsId}/releases:upload:
post:
operationId: firebaseappdistribution.media.upload
summary: Upload media
description: Uploads a binary. Uploading a binary can result in a new release being created, an update to an existing release, or a no-op if a release with the same binary already exists.
parameters:
- name: projectsId
in: path
required: true
description: Resource name segment (projectsId).
schema:
type: string
- name: appsId
in: path
required: true
description: Resource name segment (appsId).
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GoogleFirebaseAppdistroV1UploadReleaseRequest'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/GoogleLongrunningOperation'
4XX:
content:
application/json:
schema:
$ref: '#/components/schemas/GoogleRpcError'
description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
default:
content:
application/json:
schema:
$ref: '#/components/schemas/GoogleRpcError'
description: Error response (google.rpc.Status)
security:
- oauth2:
- https://www.googleapis.com/auth/cloud-platform
- apiKey: []
x-google-media-upload:
protocols:
simple:
multipart: true
path: /upload/v1/{+app}/releases:upload
accept:
- '*/*'
tags:
- Media
components:
schemas:
GdataMedia:
properties:
blobstore2Info:
$ref: '#/components/schemas/GdataBlobstore2Info'
description: Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob.
hashVerified:
type: boolean
description: For Scotty uploads only. If a user sends a hash code and the backend has requested that Scotty verify the upload against the client hash, Scotty will perform the check on behalf of the backend and will reject it if the hashes don't match. This is set to true if Scotty performed this verification.
mediaId:
type: string
format: byte
description: Media id to forward to the operation GetMedia. Can be set if reference_type is GET_MEDIA.
hash:
description: 'Deprecated, use one of explicit hash type fields instead. These two hash related fields will only be populated on Scotty based media uploads and will contain the content of the hash group in the NotificationRequest: http://cs/#google3/blobstore2/api/scotty/service/proto/upload_listener.proto&q=class:Hash Hex encoded hash value of the uploaded media.'
type: string
deprecated: true
length:
description: Size of the data, in bytes
format: int64
type: string
sha1Hash:
format: byte
type: string
description: Scotty-provided SHA1 hash for an upload.
contentTypeInfo:
$ref: '#/components/schemas/GdataContentTypeInfo'
description: Extended content type information provided for Scotty uploads.
algorithm:
type: string
description: Deprecated, use one of explicit hash type fields instead. Algorithm used for calculating the hash. As of 2011/01/21, "MD5" is the only possible value for this field. New values may be added at any time.
deprecated: true
blobRef:
description: Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
type: string
format: byte
deprecated: true
diffUploadResponse:
$ref: '#/components/schemas/GdataDiffUploadResponse'
description: Set if reference_type is DIFF_UPLOAD_RESPONSE.
sha256Hash:
description: Scotty-provided SHA256 hash for an upload.
format: byte
type: string
diffDownloadResponse:
$ref: '#/components/schemas/GdataDiffDownloadResponse'
description: Set if reference_type is DIFF_DOWNLOAD_RESPONSE.
isPotentialRetry:
description: '|is_potential_retry| is set false only when Scotty is certain that it has not sent the request before. When a client resumes an upload, this field must be set true in agent calls, because Scotty cannot be certain that it has never sent the request before due to potential failure in the session state persistence.'
type: boolean
cosmoBinaryReference:
description: A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
type: string
format: byte
contentType:
type: string
description: MIME type of the data
path:
description: Path to the data, set if reference_type is PATH
type: string
bigstoreObjectRef:
type: string
format: byte
description: Use object_id instead.
deprecated: true
diffVersionResponse:
$ref: '#/components/schemas/GdataDiffVersionResponse'
description: Set if reference_type is DIFF_VERSION_RESPONSE.
objectId:
$ref: '#/components/schemas/GdataObjectId'
description: Reference to a TI Blob, set if reference_type is BIGSTORE_REF.
diffChecksumsResponse:
$ref: '#/components/schemas/GdataDiffChecksumsResponse'
description: Set if reference_type is DIFF_CHECKSUMS_RESPONSE.
md5Hash:
description: Scotty-provided MD5 hash for an upload.
format: byte
type: string
crc32cHash:
type: integer
description: 'For Scotty Uploads: Scotty-provided hashes for uploads For Scotty Downloads: (WARNING: DO NOT USE WITHOUT PERMISSION FROM THE SCOTTY TEAM.) A Hash provided by the agent to be used to verify the data being downloaded. Currently only supported for inline payloads. Further, only crc32c_hash is currently supported.'
format: uint32
downloadParameters:
$ref: '#/components/schemas/GdataDownloadParameters'
description: Parameters for a media download.
timestamp:
description: Time at which the media data was last updated, in milliseconds since UNIX epoch
type: string
format: uint64
token:
description: A unique fingerprint/version id for the media data
type: string
sha512Hash:
format: byte
description: Scotty-provided SHA512 hash for an upload.
type: string
referenceType:
description: Describes what the field reference contains.
enum:
- PATH
- BLOB_REF
- INLINE
- GET_MEDIA
- COMPOSITE_MEDIA
- BIGSTORE_REF
- DIFF_VERSION_RESPONSE
- DIFF_CHECKSUMS_RESPONSE
- DIFF_DOWNLOAD_RESPONSE
- DIFF_UPLOAD_REQUEST
- DIFF_UPLOAD_RESPONSE
- COSMO_BINARY_REFERENCE
- ARBITRARY_BYTES
type: string
inline:
description: Media data, set if reference_type is INLINE
format: byte
type: string
filename:
type: string
description: Original file name
diffUploadRequest:
$ref: '#/components/schemas/GdataDiffUploadRequest'
description: Set if reference_type is DIFF_UPLOAD_REQUEST.
compositeMedia:
description: 'A composite media composed of one or more media objects, set if reference_type is COMPOSITE_MEDIA. The media length field must be set to the sum of the lengths of all composite media objects. Note: All composite media must have length specified.'
type: array
items:
$ref: '#/components/schemas/GdataCompositeMedia'
type: object
description: A reference to data stored on the filesystem, on GFS or in blobstore.
GdataObjectId:
type: object
properties:
objectName:
description: The name of the object.
type: string
generation:
description: Generation of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions
format: int64
type: string
bucketName:
description: The name of the bucket to which this object belongs.
type: string
description: This is a copy of the tech.blob.ObjectId proto, which could not be used directly here due to transitive closure issues with JavaScript support; see http://b/8801763.
GdataDiffChecksumsResponse:
properties:
chunkSizeBytes:
type: string
description: The chunk size of checksums. Must be a multiple of 256KB.
format: int64
objectSizeBytes:
description: The total size of the server object.
type: string
format: int64
objectLocation:
$ref: '#/components/schemas/GdataCompositeMedia'
description: If set, calculate the checksums based on the contents and return them to the caller.
checksumsLocation:
$ref: '#/components/schemas/GdataCompositeMedia'
description: Exactly one of these fields must be populated. If checksums_location is filled, the server will return the corresponding contents to the user. If object_location is filled, the server will calculate the checksums based on the content there and return that to the user. For details on the format of the checksums, see http://go/scotty-diff-protocol.
objectVersion:
description: The object version of the object the checksums are being returned for.
type: string
type: object
description: Backend response for a Diff get checksums response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.
GdataCompositeMedia:
description: A sequence of media data references representing composite data. Introduced to support Bigstore composite objects. For details, visit http://go/bigstore-composites.
properties:
referenceType:
description: Describes what the field reference contains.
enum:
- PATH
- BLOB_REF
- INLINE
- BIGSTORE_REF
- COSMO_BINARY_REFERENCE
type: string
objectId:
$ref: '#/components/schemas/GdataObjectId'
description: Reference to a TI Blob, set if reference_type is BIGSTORE_REF.
crc32cHash:
format: uint32
type: integer
description: crc32.c hash for the payload.
length:
description: Size of the data, in bytes
type: string
format: int64
inline:
description: Media data, set if reference_type is INLINE
format: byte
type: string
blobstore2Info:
$ref: '#/components/schemas/GdataBlobstore2Info'
description: Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob.
path:
description: Path to the data, set if reference_type is PATH
type: string
blobRef:
format: byte
type: string
description: Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
deprecated: true
cosmoBinaryReference:
format: byte
type: string
description: A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
md5Hash:
description: MD5 hash for the payload.
type: string
format: byte
sha1Hash:
format: byte
type: string
description: SHA-1 hash for the payload.
type: object
GoogleLongrunningOperation:
type: object
description: This resource represents a long-running operation that is the result of a network API call.
properties:
response:
additionalProperties:
description: Properties of the object. Contains field @type with type URL.
description: The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
type: object
name:
description: The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
type: string
error:
$ref: '#/components/schemas/GoogleRpcStatus'
description: The error result of the operation in case of failure or cancellation.
done:
type: boolean
description: If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
metadata:
additionalProperties:
description: Properties of the object. Contains field @type with type URL.
description: Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
type: object
GdataDiffUploadRequest:
type: object
properties:
checksumsInfo:
$ref: '#/components/schemas/GdataCompositeMedia'
description: The location of the checksums for the new object. Agents must clone the object located here, as the upload server will delete the contents once a response is received. For details on the format of the checksums, see http://go/scotty-diff-protocol.
objectVersion:
type: string
description: The object version of the object that is the base version the incoming diff script will be applied to. This field will always be filled in.
objectInfo:
$ref: '#/components/schemas/GdataCompositeMedia'
description: The location of the new object. Agents must clone the object located here, as the upload server will delete the contents once a response is received.
description: A Diff upload request. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.
GdataDownloadParameters:
description: Parameters specific to media downloads.
properties:
ignoreRange:
description: Determining whether or not Apiary should skip the inclusion of any Content-Range header on its response to Scotty.
type: boolean
allowGzipCompression:
description: A boolean to be returned in the response to Scotty. Allows/disallows gzip encoding of the payload content when the server thinks it's advantageous (hence, does not guarantee compression) which allows Scotty to GZip the response to the client.
type: boolean
type: object
GoogleRpcError:
type: object
description: The error envelope every Google API returns.
properties:
error:
type: object
properties:
code:
type: integer
message:
type: string
status:
type: string
details:
type: array
items:
type: object
GdataBlobstore2Info:
properties:
uploadFragmentListCreationInfo:
description: A serialized Object Fragment List Creation Info passed from Bigstore -> Scotty for a GCS upload. This field must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.
type: string
format: byte
blobId:
type: string
description: The blob id, e.g., /blobstore/prod/playground/scotty
downloadExternalReadToken:
format: byte
description: A serialized External Read Token passed from Bigstore -> Scotty for a GCS download. This field must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.
type: string
uploadMetadataContainer:
type: string
format: byte
description: Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.
blobGeneration:
description: The blob generation id.
format: int64
type: string
downloadReadHandle:
format: byte
description: Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads.
type: string
readToken:
description: The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.
type: string
description: Information to read/write to blobstore2.
type: object
GoogleFirebaseAppdistroV1UploadReleaseRequest:
type: object
description: Request message for `UploadRelease`.
properties:
blob:
$ref: '#/components/schemas/GdataMedia'
description: Binary to upload
GoogleRpcStatus:
type: object
description: 'The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).'
properties:
message:
type: string
description: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
details:
type: array
items:
additionalProperties:
description: Properties of the object. Contains field @type with type URL.
type: object
description: A list of messages that carry the error details. There is a common set of message types for APIs to use.
code:
description: The status code, which should be an enum value of google.rpc.Code.
type: integer
format: int32
GdataDiffUploadResponse:
type: object
properties:
objectVersion:
type: string
description: The object version of the object at the server. Must be included in the end notification response. The version in the end notification response must correspond to the new version of the object that is now stored at the server, after the upload.
originalObject:
$ref: '#/components/schemas/GdataCompositeMedia'
description: The location of the original file for a diff upload request. Must be filled in if responding to an upload start notification.
description: Backend response for a Diff upload request. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.
GdataDiffDownloadResponse:
type: object
properties:
objectLocation:
$ref: '#/components/schemas/GdataCompositeMedia'
description: The original object location.
description: Backend response for a Diff download response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.
GdataContentTypeInfo:
type: object
description: Detailed Content-Type information from Scotty. The Content-Type of the media will typically be filled in by the header or Scotty's best_guess, but this extended information provides the backend with more information so that it can make a better decision if needed. This is only used on media upload requests from Scotty.
properties:
fromHeader:
description: The content type of the file as specified in the request headers, multipart headers, or RUPIO start request.
type: string
fromFusionId:
type: string
description: The content type of the file detected by Fusion ID. go/fusionid
bestGuess:
type: string
description: Scotty's best guess of what the content type of the file is.
fromFileName:
description: The content type of the file derived from the file extension of the original file name used by the client.
type: string
fusionIdDetectionMetadata:
type: string
format: byte
description: Metadata information from Fusion ID detection. Serialized FusionIdDetectionMetadata proto. Only set if from_fusion_id is set.
fromUrlPath:
description: The content type of the file derived from the file extension of the URL path. The URL path is assumed to represent a file name (which is typically only true for agents that are providing a REST API).
type: string
fromBytes:
type: string
description: The content type of the file derived by looking at specific bytes (i.e. "magic bytes") of the actual file.
GdataDiffVersionResponse:
properties:
objectVersion:
description: The version of the object stored at the server.
type: string
objectSizeBytes:
description: The total size of the server object.
format: int64
type: string
description: Backend response for a Diff get version response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.
type: object
securitySchemes:
apiKey:
type: apiKey
in: query
name: key
description: API key; accepted by methods that do not need user data.
oauth2:
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://accounts.google.com/o/oauth2/auth
tokenUrl: https://oauth2.googleapis.com/token
scopes:
https://www.googleapis.com/auth/cloud-platform: See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
externalDocs:
url: https://firebase.google.com/products/app-distribution
x-provenance:
method: harvested
publisher: Google
source: https://firebaseappdistribution.googleapis.com/$discovery/rest?version=v1
note: converted by discovery-to-openapi.py from Google's Discovery document (revision 20261110)