Arcus

custom commands All Arcus custom commands endpoints

Sends a command to a host (all application instances will receive the command)

post

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Body

application/json

Responses

200

OK

application/json

idinteger · integerRead-onlyRequired

Task ID

namestringRead-onlyRequired

Task name

batchIdinteger · integerRead-onlyRequired

The ID of the batch the task belongs to

categoryIdinteger · integerRead-onlyRequired

The ID of the task category. Valid values are:

• 1: game server

entityIdinteger · integerRead-onlyRequired

The ID of the entity the task is being executed for. E.g. a game server ID (categoryId 1)

currentActionIdxinteger · integerRead-onlyRequired

Currently active action index - relates to the action index as found in the template.

executeAtinteger · integerRead-onlyRequired

Unix timestamp indicating the start of execution.

lastActivityAtinteger · integerRead-onlyRequired

Unix timestamp indicating lastest activity.

finishedAtinteger · integerRead-onlyRequired

Unix timestamp at which the task was finished.

resultCodeinteger · integerRead-onlyRequired

The result of the task. 0: pending, 1: in progress, 2: paused, 125: cancelled, 126: done with error, 127: done

resultTextstringRead-onlyRequired

The result of the task in message form.

403

Invalid credentials

500

Internal Server Error

application/json

post

/v3/customCommand/host/{hostId}

HTTPcURLJavaScriptPython

POST /v3/customCommand/host/{hostId} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 49

{
  "customCommand": [
    {
      "key": "text",
      "value": "text"
    }
  ]
}

[
  {
    "id": 1,
    "name": "text",
    "batchId": 1,
    "categoryId": 1,
    "entityId": 1,
    "currentActionIdx": 1,
    "executeAt": 1,
    "lastActivityAt": 1,
    "finishedAt": 1,
    "resultCode": 1,
    "resultText": "text"
  }
]

Sends a command to a application instance

post

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Body

application/json

Responses

200

OK

application/json

idinteger · integerRead-onlyRequired

Task ID

namestringRead-onlyRequired

Task name

batchIdinteger · integerRead-onlyRequired

The ID of the batch the task belongs to

categoryIdinteger · integerRead-onlyRequired

The ID of the task category. Valid values are:

• 1: game server

entityIdinteger · integerRead-onlyRequired

The ID of the entity the task is being executed for. E.g. a game server ID (categoryId 1)

currentActionIdxinteger · integerRead-onlyRequired

Currently active action index - relates to the action index as found in the template.

executeAtinteger · integerRead-onlyRequired

Unix timestamp indicating the start of execution.

lastActivityAtinteger · integerRead-onlyRequired

Unix timestamp indicating lastest activity.

finishedAtinteger · integerRead-onlyRequired

Unix timestamp at which the task was finished.

resultCodeinteger · integerRead-onlyRequired

The result of the task. 0: pending, 1: in progress, 2: paused, 125: cancelled, 126: done with error, 127: done

resultTextstringRead-onlyRequired

The result of the task in message form.

403

Invalid credentials

500

Internal Server Error

application/json

post

/v3/customCommand/applicationInstance/{applicationInstanceId}

HTTPcURLJavaScriptPython

POST /v3/customCommand/applicationInstance/{applicationInstanceId} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 49

{
  "customCommand": [
    {
      "key": "text",
      "value": "text"
    }
  ]
}

[
  {
    "id": 1,
    "name": "text",
    "batchId": 1,
    "categoryId": 1,
    "entityId": 1,
    "currentActionIdx": 1,
    "executeAt": 1,
    "lastActivityAt": 1,
    "finishedAt": 1,
    "resultCode": 1,
    "resultText": "text"
  }
]