ICloudService – Steam Web API Documentation

This page is just a reference of all the known Steam APIs, I do not know how they work. Please do not email me with questions.

UNDOCUMENTEDPOSTBeginAppUploadBatch

Indicate a batch of files that will be uploaded / deleted for an app.

https://api.steampowered.com/ICloudService/BeginAppUploadBatch/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
appid		uint32	No	App ID for this batch is for.
machine_name		string	No	Client machine name (may be user's alias).
files_to_upload[0]		string[]	No	Filenames of files to upload in this batch
files_to_delete[0]		string[]	No	Filenames of files to delete in this batch
client_id		uint64	No	Client ID number
app_build_id		uint64	No	Current local build of the app which made these changes
access_token		string	Yes	OAuth access token for the user
files_to_upload		string list	Yes	List of all files to be uploaded (new files or updates for existing files) as part of this batch.
files_to_delete		string list	Yes	List of all files to be deleted from Steam Cloud as part of this batch.

UNDOCUMENTEDPOSTBeginHTTPUpload

Begins the process of uploading a file to Steam external storage services. File should be uploaded via HTTP PUT to the returned URL, after which the upload must be finalized by a call to CommitHTTPUpload.

https://api.steampowered.com/ICloudService/BeginHTTPUpload/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
appid		uint32	No	App ID for which the file is being uploaded.
file_size		uint32	No	Original file size in bytes.
filename		string	No	Name of the file to store in the cloud.
file_sha		string	No	Hex string (40 digits) representing the SHA1 digest of the file.
is_public		bool	No	True if the file should be marked public on the UFS, false otherwise.
platforms_to_sync[0]		string[]	No	Array of string specifying which platforms to sync; value values: all, Windows, MacOS, linux, Switch, iPhoneOS, Android.
request_headers_names[0]		string[]	No	Names for headers you'll want to set on your upload request. May be left blank.
request_headers_values[0]		string[]	No	Values for headers you'll want to set on your upload request. The number of names must equal the number of values.
upload_batch_id		uint64	No	ID of this batch returned by prior BeginAppUploadBatch call.

UNDOCUMENTEDPOSTBeginUGCUpload

https://api.steampowered.com/ICloudService/BeginUGCUpload/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
appid		uint32	No	App ID this UGC belongs to.
file_size		uint32	No	File size in bytes.
filename		string	No	Name of the file.
file_sha		string	No	Hex string (40 digits) representing the SHA1 digest of the file.
content_type		string	No	MIME content type of the file

UNDOCUMENTEDPOSTCommitHTTPUpload

Commits a file upload initiated by BeginHTTPUpload and transferred via HTTP PUT.

https://api.steampowered.com/ICloudService/CommitHTTPUpload/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
transfer_succeeded		bool	No	True if the HTTP PUT to the upload URL succeeded (URL provided in response to Cloud.BeginHTTPUpload), false if a failure occurred.
appid		uint32	No	App ID for which the file is being uploaded. Must match the app ID provided to Cloud.BeginHTTPUpload.
file_sha		string	No	Hex string (40 digits) representing the SHA1 digest of the file. Must match the SHA1 digest provided to Cloud.BeginHTTPUpload.
filename		string	No	Filename as specified in the Cloud.BeginHTTPUpload request.

UNDOCUMENTEDPOSTCommitUGCUpload

Commits a file upload initiated by BeginUGCUpload and transferred via HTTP PUT.

https://api.steampowered.com/ICloudService/CommitUGCUpload/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
transfer_succeeded		bool	No	True if the HTTP PUT to the upload URL succeeded (URL provided in response to Cloud.BeginUGCUpload), false if a failure occurred.
appid		uint32	No	App ID for which the file is being uploaded. Must match the app ID provided to Cloud.BeginUGCUpload.
ugcid		fixed64	No	UGC ID of the uploaded file.

UNDOCUMENTEDPOSTCompleteAppUploadBatch

Indicate that the batch is complete or being stopped for some other reason.

https://api.steampowered.com/ICloudService/CompleteAppUploadBatch/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
appid		uint32	No	App ID for this batch is for.
batch_id		uint64	No	ID of this batch.
batch_eresult		uint32	No	result of this batch.

UNDOCUMENTEDPOSTCompleteAppUploadBatchBlocking

Indicate that the batch is complete or being stopped for some other reason.

https://api.steampowered.com/ICloudService/CompleteAppUploadBatchBlocking/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
appid		uint32	No	App ID for this batch is for.
batch_id		uint64	No	ID of this batch.
batch_eresult		uint32	No	result of this batch.

UNDOCUMENTEDPOSTDelete

Deletes a file from the user's cloud.

https://api.steampowered.com/ICloudService/Delete/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
filename		string	No
appid		uint32	No	App ID the file belongs to.
upload_batch_id		uint64	No	ID of this batch returned by prior BeginAppUploadBatch call.

UNDOCUMENTEDGETEnumerateUserFiles

Enumerates Cloud files for a user of a given app ID. Returns up to 500 files at a time.

https://api.steampowered.com/ICloudService/EnumerateUserFiles/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
appid		uint32	No	App ID to enumerate the files of.
extended_details		bool	No	Get extended details back on the files found. Defaults to only returned the app Id and UGC Id of the files found.
count		uint32	No	Maximum number of results to return on this call. Defaults to a maximum of 500 files returned.
start_index		uint32	No	Starting index to begin enumeration at. Defaults to the beginning of the list.
access_token		string	Yes	OAuth access token for the user

UNDOCUMENTEDGetFileDetails

Returns details on a Cloud file.

https://api.steampowered.com/ICloudService/GetFileDetails/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
ugcid		uint64	No	ID of the Cloud file to get details for.
appid		uint32	No	App ID the file belongs to.