Server-Side Cloud Script - List Functions

  • Reference
Service:
CloudScript
API Version:
240412

Lists all currently registered Azure Functions for a given title.

POST https://titleId.playfabapi.com/CloudScript/ListFunctions

Request Header

Name Required Type Description
X-EntityToken True

string

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Request Body

Name Type Description
CustomTags

object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Responses

Name Type Description
200 OK

ListFunctionsResult

400 Bad Request

ApiErrorWrapper

This is the outer wrapper for all responses with errors

Security

X-EntityToken

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Type: apiKey
In: header

Definitions

Name Description
ApiErrorWrapper

The basic wrapper around every failed API response
FunctionModel
ListFunctionsRequest

A title can have many functions, ListHttpFunctions will return a list of all the currently registered HTTP triggered functions for a given title.
ListFunctionsResult
TriggerType

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

FunctionModel

Name Type Description
FunctionAddress

string

The address of the function.
FunctionName

string

The name the function was registered under.
TriggerType

TriggerType

The trigger type for the function.

ListFunctionsRequest

A title can have many functions, ListHttpFunctions will return a list of all the currently registered HTTP triggered functions for a given title.

Name Type Description
CustomTags

object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

ListFunctionsResult

Name Type Description
Functions

FunctionModel[]

The list of functions that are currently registered for the title.

TriggerType

Name Type Description
HTTP

string

Queue

string