Skip to main content
POST
Create Insights Scheduled Scaling Task

Authorizations

X-SecretKey
string
header
required

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

Body

application/json

Task name is unique within a title. Using a task name that's already taken will cause a name conflict error. Too many create-task requests within a short time will cause a create conflict error.

Task name is unique within a title. Using a task name that's already taken will cause a name conflict error. Too many create-task requests within a short time will cause a create conflict error.

IsActive
boolean
required

Whether the schedule is active. Inactive schedule will not trigger task execution.

Name
string
required

Name of the task. This is a unique identifier for tasks in the title.

Parameter
object
required

Task details related to Insights Scaling

CustomTags
object

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

Description
string

Description the task

Schedule
string

Cron expression for the run schedule of the task. The expression should be in UTC.

Response

code
integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status
string

The Http status code as a string.

data
object
Example:
Last modified on October 1, 2026