Scheduled Task - Abort Task Instance

Service:

Admin

API Version:

240426

Abort an ongoing task instance.

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

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	Required	Type	Description
TaskInstanceId	True	string	ID of a task instance that is being aborted.
CustomTags		object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Responses

Name	Type	Description
200 OK	EmptyResponse
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
AbortTaskInstanceRequest	If the task instance has already completed, there will be no-op.
ApiErrorWrapper	The basic wrapper around every failed API response
EmptyResponse

AbortTaskInstanceRequest

If the task instance has already completed, there will be no-op.

Name	Type	Description
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
TaskInstanceId	string	ID of a task instance that is being aborted.

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

EmptyResponse

Error Codes

Name	Code
TaskInstanceNotFound	1262