Server-Side Cloud Script - Get Cloud Script Revision

Service:

Admin

API Version:

240514

Gets the contents and information of a specific Cloud Script revision.

POST https://titleId.playfabapi.com/Admin/GetCloudScriptRevision

Request Header

Name	Required	Type	Description
X-SecretKey	True	string	This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Request Body

Name	Type	Description
Revision	number	Revision number. If left null, defaults to the latest revision
Version	number	Version number. If left null, defaults to the latest version

Responses

Name	Type	Description
200 OK	GetCloudScriptRevisionResult
400 Bad Request	ApiErrorWrapper	This is the outer wrapper for all responses with errors

Security

X-SecretKey

This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Type: apiKey
In: header

Definitions

Name	Description
ApiErrorWrapper	The basic wrapper around every failed API response
CloudScriptFile
GetCloudScriptRevisionRequest
GetCloudScriptRevisionResult

ApiErrorWrapper

The basic wrapper around every failed API response

Name	Type	Description
code	integer	Numerical HTTP code
error	string	Playfab error code
errorCode	integer	Numerical PlayFab error code
errorDetails	object	Detailed description of individual issues with the request object
errorMessage	string	Description for the PlayFab errorCode
status	string	String HTTP code

CloudScriptFile

Name	Type	Description
FileContents	string	Contents of the Cloud Script javascript. Must be string-escaped javascript.
Filename	string	Name of the javascript file. These names are not used internally by the server, they are only for developer organizational purposes.

GetCloudScriptRevisionRequest

Name	Type	Description
Revision	number	Revision number. If left null, defaults to the latest revision
Version	number	Version number. If left null, defaults to the latest version

GetCloudScriptRevisionResult

Name	Type	Description
CreatedAt	string	Time this revision was created
Files	CloudScriptFile[]	List of Cloud Script files in this revision.
IsPublished	boolean	True if this is the currently published revision
Revision	number	Revision number.
Version	number	Version number.

Error Codes

Name	Code
RevisionNotFound	1125
VersionNotFound	1124