PatchJob

List all patch job endpoint

Get list of patch job types

get

Authorizations

PRIVATE-TOKENstringRequired

Responses

200

application/json

typeIdinteger · integerRead-onlyRequired

Patch job type ID

typeDescriptionstringRead-onlyRequired

Patch job type description

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/patchJob/type

GET /v3/patchJob/type HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "typeId": 1,
    "typeDescription": "text"
  }
]

Get list of patch job runtime types

get

Authorizations

PRIVATE-TOKENstringRequired

Responses

200

application/json

typeIdinteger · integerRead-onlyRequired

Patch job type ID

typeDescriptionstringRead-onlyRequired

Patch job type description

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/patchJob/runtimeType

GET /v3/patchJob/runtimeType HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "typeId": 1,
    "typeDescription": "text"
  }
]

Get list of patch job status

get

Authorizations

PRIVATE-TOKENstringRequired

Responses

200

application/json

idinteger · integerRead-onlyRequired

Patch job status ID

descriptionstringRead-onlyRequired

Patch job status description

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/patchJob/status

GET /v3/patchJob/status HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "description": "text"
  }
]

Show a preview of the number of game application instances that are affected by the selection

post

Authorizations

PRIVATE-TOKENstringRequired

Body

deploymentEnvironmentIdstringRequired

Deployment environment ID

applicationIdstringRequired

Application ID

fleetstring[]Required

List of fleet ID

applicationBuildstring[]Required

List of application build ID

Responses

200

application/json

regionstringRead-onlyRequired

Region name of application instances

dataCenterstringRead-onlyRequired

Data center location name

buildVersionstringRead-onlyRequired

Application build version number

numberOfInstancesinteger · integerRead-onlyRequired

Number of application instances

403

Invalid credentials

500

Internal Server Error

application/json

post

/v3/patchJob/applicationInstancePreview

POST /v3/patchJob/applicationInstancePreview HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 102

{
  "deploymentEnvironmentId": "text",
  "applicationId": "text",
  "fleet": [
    "text"
  ],
  "applicationBuild": [
    "text"
  ]
}

[
  {
    "region": "text",
    "dataCenter": "text",
    "buildVersion": "text",
    "numberOfInstances": 1
  }
]

Get the list of all patch jobs

get

Authorizations

PRIVATE-TOKENstringRequired

Header parameters

RANGED-DATAstringOptional

Example header and default range: RANGED-DATA:start=0,results=25

Responses

200

application/json

idstringRead-onlyRequired

Patch job ID

deploymentEnvironmentIdstringRequired

Deployment environment ID

applicationIdstringRequired

Application ID

patchJobMethodIdinteger · integerRequired

Patch job type, you can find the list available patch job type GET /v3/patchJob/type

patchJobMethodstringRead-onlyRequired

Name of the patch job method

patchJobNamestringRequired

Name of the patch job (unique)

statusinteger · integerRead-onlyRequired

Status of the patch job, you can find the list available patch job type GET /v3/patchJob/status

stopMethodIdinteger · integerRequired

Stop method of an application instance, you can find the list available application instance stop methods GET /v3/application/stopMethod

stopMethodNamestringRead-onlyRequired

Name of the stop method

stopMethodTimeoutinteger · integerOptional

Stop method timeout of an application instance in seconds

commentsstringOptional

Comments for patch job

schedulerStartTimeinteger · integerOptional

Start time when the patch job will be started. The default value is 0, this means start directly after creation of the patch job, else the patch job will start at the provided UTC timestamp

patchJobStartTimeinteger · integerRead-onlyRequired

Timestamp when the patch job has been started in UTC

createdAtinteger · integerRead-onlyRequired

Timestamp when the patch job has been created

changedAtinteger · integerRead-onlyRequired

Timestamp when the patch job last has been changed

finishedAtinteger · integerRead-onlyRequired

Timestamp when the patch job has been finished in UTC

isRevertableinteger · integerRead-onlyRequired

If the patch job can be cancelled, when is 1 you can cancel the patch job else not

revertsPatchJobIdinteger · integer · nullableRead-onlyRequired

If filled in, this ID points to the patch job that has been reverted by this patch job

revertedByPatchJobIdinteger · integer · nullableRead-onlyRequired

If filled in, this ID points to the PatchJob that has reverted this patch job

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/patchJob

GET /v3/patchJob HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": "text",
    "deploymentEnvironmentId": "text",
    "applicationId": "text",
    "patchJobMethodId": 1,
    "patchJobMethod": "text",
    "patchJobName": "text",
    "status": 1,
    "stopMethodId": 1,
    "stopMethodName": "text",
    "stopMethodTimeout": 1,
    "comments": "text",
    "schedulerStartTime": 1,
    "patchJobStartTime": 1,
    "patchJobOverallProgress": {
      "total": 1,
      "downloaded": 1,
      "stopped": 1,
      "success": 1,
      "failed": 1,
      "started": 1,
      "canceled": 1,
      "remaining": 1
    },
    "applicationBuild": [
      {
        "id": "text",
        "oldApplicationBuildId": "text",
        "newApplicationBuildId": "text"
      }
    ],
    "fleet": [
      {
        "id": "text",
        "fleetId": "text"
      }
    ],
    "email": [
      {
        "id": "text",
        "email": "text",
        "progressReport": 1,
        "resultReport": 1,
        "createdAt": 1,
        "changedAt": 1
      }
    ],
    "createdAt": 1,
    "changedAt": 1,
    "finishedAt": 1,
    "isRevertable": 1,
    "revertsPatchJobId": 1,
    "revertedByPatchJobId": 1
  }
]

Create a patch job

post

Authorizations

PRIVATE-TOKENstringRequired

Body

idstringRead-onlyRequired

Patch job ID

deploymentEnvironmentIdstringRequired

Deployment environment ID

applicationIdstringRequired

Application ID

patchJobMethodIdinteger · integerRequired

Patch job type, you can find the list available patch job type GET /v3/patchJob/type

patchJobMethodstringRead-onlyRequired

Name of the patch job method

patchJobNamestringRequired

Name of the patch job (unique)

statusinteger · integerRead-onlyRequired

Status of the patch job, you can find the list available patch job type GET /v3/patchJob/status

stopMethodIdinteger · integerRequired

Stop method of an application instance, you can find the list available application instance stop methods GET /v3/application/stopMethod

stopMethodNamestringRead-onlyRequired

Name of the stop method

stopMethodTimeoutinteger · integerOptional

Stop method timeout of an application instance in seconds

commentsstringOptional

Comments for patch job

schedulerStartTimeinteger · integerOptional

Start time when the patch job will be started. The default value is 0, this means start directly after creation of the patch job, else the patch job will start at the provided UTC timestamp

patchJobStartTimeinteger · integerRead-onlyRequired

Timestamp when the patch job has been started in UTC

createdAtinteger · integerRead-onlyRequired

Timestamp when the patch job has been created

changedAtinteger · integerRead-onlyRequired

Timestamp when the patch job last has been changed

finishedAtinteger · integerRead-onlyRequired

Timestamp when the patch job has been finished in UTC

isRevertableinteger · integerRead-onlyRequired

If the patch job can be cancelled, when is 1 you can cancel the patch job else not

revertsPatchJobIdinteger · integer · nullableRead-onlyRequired

If filled in, this ID points to the patch job that has been reverted by this patch job

revertedByPatchJobIdinteger · integer · nullableRead-onlyRequired

If filled in, this ID points to the PatchJob that has reverted this patch job

Responses

200

application/json

idstringRead-onlyRequired

Patch job ID

deploymentEnvironmentIdstringRequired

Deployment environment ID

applicationIdstringRequired

Application ID

patchJobMethodIdinteger · integerRequired

Patch job type, you can find the list available patch job type GET /v3/patchJob/type

patchJobMethodstringRead-onlyRequired

Name of the patch job method

patchJobNamestringRequired

Name of the patch job (unique)

statusinteger · integerRead-onlyRequired

Status of the patch job, you can find the list available patch job type GET /v3/patchJob/status

stopMethodIdinteger · integerRequired

Stop method of an application instance, you can find the list available application instance stop methods GET /v3/application/stopMethod

stopMethodNamestringRead-onlyRequired

Name of the stop method

stopMethodTimeoutinteger · integerOptional

Stop method timeout of an application instance in seconds

commentsstringOptional

Comments for patch job

schedulerStartTimeinteger · integerOptional

Start time when the patch job will be started. The default value is 0, this means start directly after creation of the patch job, else the patch job will start at the provided UTC timestamp

patchJobStartTimeinteger · integerRead-onlyRequired

Timestamp when the patch job has been started in UTC

createdAtinteger · integerRead-onlyRequired

Timestamp when the patch job has been created

changedAtinteger · integerRead-onlyRequired

Timestamp when the patch job last has been changed

finishedAtinteger · integerRead-onlyRequired

Timestamp when the patch job has been finished in UTC

isRevertableinteger · integerRead-onlyRequired

If the patch job can be cancelled, when is 1 you can cancel the patch job else not

revertsPatchJobIdinteger · integer · nullableRead-onlyRequired

If filled in, this ID points to the patch job that has been reverted by this patch job

revertedByPatchJobIdinteger · integer · nullableRead-onlyRequired

If filled in, this ID points to the PatchJob that has reverted this patch job

403

Invalid credentials

500

Internal Server Error

application/json

post

/v3/patchJob

POST /v3/patchJob HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 357

{
  "deploymentEnvironmentId": "text",
  "applicationId": "text",
  "patchJobMethodId": 1,
  "patchJobName": "text",
  "stopMethodId": 1,
  "stopMethodTimeout": 1,
  "comments": "text",
  "schedulerStartTime": 1,
  "applicationBuild": [
    {
      "oldApplicationBuildId": "text",
      "newApplicationBuildId": "text"
    }
  ],
  "fleet": [
    {
      "fleetId": "text"
    }
  ],
  "email": [
    {
      "email": "text",
      "progressReport": 1,
      "resultReport": 1
    }
  ]
}

[
  {
    "id": "text",
    "deploymentEnvironmentId": "text",
    "applicationId": "text",
    "patchJobMethodId": 1,
    "patchJobMethod": "text",
    "patchJobName": "text",
    "status": 1,
    "stopMethodId": 1,
    "stopMethodName": "text",
    "stopMethodTimeout": 1,
    "comments": "text",
    "schedulerStartTime": 1,
    "patchJobStartTime": 1,
    "patchJobOverallProgress": {
      "total": 1,
      "downloaded": 1,
      "stopped": 1,
      "success": 1,
      "failed": 1,
      "started": 1,
      "canceled": 1,
      "remaining": 1
    },
    "applicationBuild": [
      {
        "id": "text",
        "oldApplicationBuildId": "text",
        "newApplicationBuildId": "text"
      }
    ],
    "fleet": [
      {
        "id": "text",
        "fleetId": "text"
      }
    ],
    "email": [
      {
        "id": "text",
        "email": "text",
        "progressReport": 1,
        "resultReport": 1,
        "createdAt": 1,
        "changedAt": 1
      }
    ],
    "createdAt": 1,
    "changedAt": 1,
    "finishedAt": 1,
    "isRevertable": 1,
    "revertsPatchJobId": 1,
    "revertedByPatchJobId": 1
  }
]

Get the detail of a patch job

get

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

patchJobIdstringRequired

The Id of the patch job for which to fetch the information

Responses

200

application/json

idstringRead-onlyRequired

Patch job ID

deploymentEnvironmentIdstringRequired

Deployment environment ID

applicationIdstringRequired

Application ID

patchJobMethodIdinteger · integerRequired

Patch job type, you can find the list available patch job type GET /v3/patchJob/type

patchJobMethodstringRead-onlyRequired

Name of the patch job method

patchJobNamestringRequired

Name of the patch job (unique)

statusinteger · integerRead-onlyRequired

Status of the patch job, you can find the list available patch job type GET /v3/patchJob/status

stopMethodIdinteger · integerRequired

Stop method of an application instance, you can find the list available application instance stop methods GET /v3/application/stopMethod

stopMethodNamestringRead-onlyRequired

Name of the stop method

stopMethodTimeoutinteger · integerOptional

Stop method timeout of an application instance in seconds

commentsstringOptional

Comments for patch job

schedulerStartTimeinteger · integerOptional

Start time when the patch job will be started. The default value is 0, this means start directly after creation of the patch job, else the patch job will start at the provided UTC timestamp

patchJobStartTimeinteger · integerRead-onlyRequired

Timestamp when the patch job has been started in UTC

createdAtinteger · integerRead-onlyRequired

Timestamp when the patch job has been created

changedAtinteger · integerRead-onlyRequired

Timestamp when the patch job last has been changed

finishedAtinteger · integerRead-onlyRequired

Timestamp when the patch job has been finished in UTC

isRevertableinteger · integerRead-onlyRequired

If the patch job can be cancelled, when is 1 you can cancel the patch job else not

revertsPatchJobIdinteger · integer · nullableRead-onlyRequired

If filled in, this ID points to the patch job that has been reverted by this patch job

revertedByPatchJobIdinteger · integer · nullableRead-onlyRequired

If filled in, this ID points to the PatchJob that has reverted this patch job

403

Invalid credentials

404

Invalid patchJobId

500

Internal Server Error

application/json

get

/v3/patchJob/{patchJobId}

GET /v3/patchJob/{patchJobId} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": "text",
    "deploymentEnvironmentId": "text",
    "applicationId": "text",
    "patchJobMethodId": 1,
    "patchJobMethod": "text",
    "patchJobName": "text",
    "status": 1,
    "stopMethodId": 1,
    "stopMethodName": "text",
    "stopMethodTimeout": 1,
    "comments": "text",
    "schedulerStartTime": 1,
    "patchJobStartTime": 1,
    "patchJobOverallProgress": {
      "total": 1,
      "downloaded": 1,
      "stopped": 1,
      "success": 1,
      "failed": 1,
      "started": 1,
      "canceled": 1,
      "remaining": 1
    },
    "applicationBuild": [
      {
        "id": "text",
        "oldApplicationBuildId": "text",
        "newApplicationBuildId": "text"
      }
    ],
    "fleet": [
      {
        "id": "text",
        "fleetId": "text"
      }
    ],
    "email": [
      {
        "id": "text",
        "email": "text",
        "progressReport": 1,
        "resultReport": 1,
        "createdAt": 1,
        "changedAt": 1
      }
    ],
    "createdAt": 1,
    "changedAt": 1,
    "finishedAt": 1,
    "isRevertable": 1,
    "revertsPatchJobId": 1,
    "revertedByPatchJobId": 1
  }
]

Update the detail of a patch job

put

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

patchJobIdstringRequired

The Id of the patch job

Body

idstringRead-onlyRequired

Patch job ID

deploymentEnvironmentIdstringRequired

Deployment environment ID

applicationIdstringRequired

Application ID

patchJobMethodIdinteger · integerRequired

Patch job type, you can find the list available patch job type GET /v3/patchJob/type

patchJobMethodstringRead-onlyRequired

Name of the patch job method

patchJobNamestringRequired

Name of the patch job (unique)

statusinteger · integerRead-onlyRequired

Status of the patch job, you can find the list available patch job type GET /v3/patchJob/status

stopMethodIdinteger · integerRequired

Stop method of an application instance, you can find the list available application instance stop methods GET /v3/application/stopMethod

stopMethodNamestringRead-onlyRequired

Name of the stop method

stopMethodTimeoutinteger · integerOptional

Stop method timeout of an application instance in seconds

commentsstringOptional

Comments for patch job

schedulerStartTimeinteger · integerOptional

Start time when the patch job will be started. The default value is 0, this means start directly after creation of the patch job, else the patch job will start at the provided UTC timestamp

patchJobStartTimeinteger · integerRead-onlyRequired

Timestamp when the patch job has been started in UTC

createdAtinteger · integerRead-onlyRequired

Timestamp when the patch job has been created

changedAtinteger · integerRead-onlyRequired

Timestamp when the patch job last has been changed

finishedAtinteger · integerRead-onlyRequired

Timestamp when the patch job has been finished in UTC

isRevertableinteger · integerRead-onlyRequired

If the patch job can be cancelled, when is 1 you can cancel the patch job else not

revertsPatchJobIdinteger · integer · nullableRead-onlyRequired

If filled in, this ID points to the patch job that has been reverted by this patch job

revertedByPatchJobIdinteger · integer · nullableRead-onlyRequired

If filled in, this ID points to the PatchJob that has reverted this patch job

Responses

200

application/json

idstringRead-onlyRequired

Patch job ID

deploymentEnvironmentIdstringRequired

Deployment environment ID

applicationIdstringRequired

Application ID

patchJobMethodIdinteger · integerRequired

Patch job type, you can find the list available patch job type GET /v3/patchJob/type

patchJobMethodstringRead-onlyRequired

Name of the patch job method

patchJobNamestringRequired

Name of the patch job (unique)

statusinteger · integerRead-onlyRequired

Status of the patch job, you can find the list available patch job type GET /v3/patchJob/status

stopMethodIdinteger · integerRequired

Stop method of an application instance, you can find the list available application instance stop methods GET /v3/application/stopMethod

stopMethodNamestringRead-onlyRequired

Name of the stop method

stopMethodTimeoutinteger · integerOptional

Stop method timeout of an application instance in seconds

commentsstringOptional

Comments for patch job

schedulerStartTimeinteger · integerOptional

Start time when the patch job will be started. The default value is 0, this means start directly after creation of the patch job, else the patch job will start at the provided UTC timestamp

patchJobStartTimeinteger · integerRead-onlyRequired

Timestamp when the patch job has been started in UTC

createdAtinteger · integerRead-onlyRequired

Timestamp when the patch job has been created

changedAtinteger · integerRead-onlyRequired

Timestamp when the patch job last has been changed

finishedAtinteger · integerRead-onlyRequired

Timestamp when the patch job has been finished in UTC

isRevertableinteger · integerRead-onlyRequired

If the patch job can be cancelled, when is 1 you can cancel the patch job else not

revertsPatchJobIdinteger · integer · nullableRead-onlyRequired

If filled in, this ID points to the patch job that has been reverted by this patch job

revertedByPatchJobIdinteger · integer · nullableRead-onlyRequired

If filled in, this ID points to the PatchJob that has reverted this patch job

403

Invalid credentials

404

Invalid patchJobId

500

Internal Server Error

application/json

put

/v3/patchJob/{patchJobId}

PUT /v3/patchJob/{patchJobId} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 357

{
  "deploymentEnvironmentId": "text",
  "applicationId": "text",
  "patchJobMethodId": 1,
  "patchJobName": "text",
  "stopMethodId": 1,
  "stopMethodTimeout": 1,
  "comments": "text",
  "schedulerStartTime": 1,
  "applicationBuild": [
    {
      "oldApplicationBuildId": "text",
      "newApplicationBuildId": "text"
    }
  ],
  "fleet": [
    {
      "fleetId": "text"
    }
  ],
  "email": [
    {
      "email": "text",
      "progressReport": 1,
      "resultReport": 1
    }
  ]
}

[
  {
    "id": "text",
    "deploymentEnvironmentId": "text",
    "applicationId": "text",
    "patchJobMethodId": 1,
    "patchJobMethod": "text",
    "patchJobName": "text",
    "status": 1,
    "stopMethodId": 1,
    "stopMethodName": "text",
    "stopMethodTimeout": 1,
    "comments": "text",
    "schedulerStartTime": 1,
    "patchJobStartTime": 1,
    "patchJobOverallProgress": {
      "total": 1,
      "downloaded": 1,
      "stopped": 1,
      "success": 1,
      "failed": 1,
      "started": 1,
      "canceled": 1,
      "remaining": 1
    },
    "applicationBuild": [
      {
        "id": "text",
        "oldApplicationBuildId": "text",
        "newApplicationBuildId": "text"
      }
    ],
    "fleet": [
      {
        "id": "text",
        "fleetId": "text"
      }
    ],
    "email": [
      {
        "id": "text",
        "email": "text",
        "progressReport": 1,
        "resultReport": 1,
        "createdAt": 1,
        "changedAt": 1
      }
    ],
    "createdAt": 1,
    "changedAt": 1,
    "finishedAt": 1,
    "isRevertable": 1,
    "revertsPatchJobId": 1,
    "revertedByPatchJobId": 1
  }
]

Get summary of all patch jobs

get

Authorizations

PRIVATE-TOKENstringRequired

Header parameters

RANGED-DATAstringOptional

Example header and default range: RANGED-DATA:start=0,results=25

Responses

200

application/json

idstringRead-onlyRequired

Patch job ID

deploymentEnvironmentIdstringRead-onlyRequired

Deployment environment ID

applicationIdstringRead-onlyRequired

Application ID

applicationNamestringRead-onlyRequired

Name of the application

newApplicationBuildNamestringRead-onlyRequired

Name of all the application builds that will be patched

patchJobMethodIdinteger · integerRead-onlyRequired

Patch job type, you can find the list available patch job type GET /v3/patchJob/type

patchJobMethodNamestringRead-onlyRequired

Name of the patch job chosen

patchJobNamestringRead-onlyRequired

Name of the patch job (unique)

statusinteger · integerRead-onlyRequired

Status of the patch job

commentsstringRead-onlyRequired

Comments for patch job

schedulerStartTimeinteger · integerRead-onlyRequired

When the patch job needs to start, default value is 0 this means it’s start directly after creating the patch job, else there needs to give a timestamp in UTC when the job needs to start

patchJobStartTimeinteger · integerRead-onlyRequired

Timestamp when the patch job has been started in UTC

finishedAtinteger · integerRead-onlyRequired

Timestamp when the patch job has been finished in UTC

isRevertableinteger · integerRead-onlyRequired

If the patch job can be cancelled

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/patchJob/summary

GET /v3/patchJob/summary HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": "text",
    "deploymentEnvironmentId": "text",
    "applicationId": "text",
    "applicationName": "text",
    "newApplicationBuildName": "text",
    "patchJobMethodId": 1,
    "patchJobMethodName": "text",
    "patchJobName": "text",
    "status": 1,
    "comments": "text",
    "schedulerStartTime": 1,
    "patchJobStartTime": 1,
    "finishedAt": 1,
    "isRevertable": 1,
    "patchJobOverallProgress": {
      "total": 1,
      "downloaded": 1,
      "stopped": 1,
      "success": 1,
      "failed": 1,
      "started": 1,
      "canceled": 1,
      "remaining": 1
    }
  }
]

Gets the list of patch job fleet based on deploymentEnvironmentId and applicationId

get

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

deploymentEnvironmentIdstringRequired

The Id of the deployment environment

applicationIdstringRequired

The Id of the application (game or utility)

Responses

200

application/json

idstringRead-onlyRequired

ID of the fleet

namestringRead-onlyRequired

Name of the fleet

403

Invalid credentials

404

Invalid deploymentEnvironmentId or applicationId

500

Internal Server Error

application/json

get

/v3/patchJob/deploymentEnvironment/{deploymentEnvironmentId}/application/{applicationId}/fleet

GET /v3/patchJob/deploymentEnvironment/{deploymentEnvironmentId}/application/{applicationId}/fleet HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": "text",
    "name": "text",
    "applicationBuild": [
      {
        "id": "text",
        "name": "text",
        "osId": 1
      }
    ]
  }
]

Gets the list of reporting emails for a specific patch job

get

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

patchJobIdstringRequired

The Id of the patch job

Responses

200

application/json

idstringRead-onlyRequired

ID of a patch job email

emailstringRequired

Email address for reporting (unique)

progressReportinteger · integerRequired

If 1 progress report will be send, if 0 no progress report will be send

resultReportinteger · integerRequired

If 1 result report will be send, if 0 no result report will be send

createdAtinteger · integerRead-onlyRequired

Timestamp when the patch job email has been created

changedAtinteger · integerRead-onlyRequired

Timestamp when the patch job email last has been changed

403

Invalid credentials

404

Invalid patchJobId

500

Internal Server Error

application/json

get

/v3/patchJob/{patchJobId}/email

GET /v3/patchJob/{patchJobId}/email HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": "text",
    "email": "text",
    "progressReport": 1,
    "resultReport": 1,
    "createdAt": 1,
    "changedAt": 1
  }
]

Create a patch job report email

post

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

patchJobIdstringRequired

The Id of the patch job

Body

idstringRead-onlyRequired

ID of a patch job email

emailstringRequired

Email address for reporting (unique)

progressReportinteger · integerRequired

If 1 progress report will be send, if 0 no progress report will be send

resultReportinteger · integerRequired

If 1 result report will be send, if 0 no result report will be send

createdAtinteger · integerRead-onlyRequired

Timestamp when the patch job email has been created

changedAtinteger · integerRead-onlyRequired

Timestamp when the patch job email last has been changed

Responses

200

application/json

idstringRead-onlyRequired

ID of a patch job email

emailstringRequired

Email address for reporting (unique)

progressReportinteger · integerRequired

If 1 progress report will be send, if 0 no progress report will be send

resultReportinteger · integerRequired

If 1 result report will be send, if 0 no result report will be send

createdAtinteger · integerRead-onlyRequired

Timestamp when the patch job email has been created

changedAtinteger · integerRead-onlyRequired

Timestamp when the patch job email last has been changed

403

Invalid credentials

404

Invalid patchJobId

500

Internal Server Error

application/json

post

/v3/patchJob/{patchJobId}/email

POST /v3/patchJob/{patchJobId}/email HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 52

{
  "email": "text",
  "progressReport": 1,
  "resultReport": 1
}

[
  {
    "id": "text",
    "email": "text",
    "progressReport": 1,
    "resultReport": 1,
    "createdAt": 1,
    "changedAt": 1
  }
]

Put a given patch job on hold

put

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

patchJobIdstringRequired

The Id of the patch job to put on hold

Responses

200

application/json

idstringRead-onlyRequired

Patch job ID

deploymentEnvironmentIdstringRequired

Deployment environment ID

applicationIdstringRequired

Application ID

patchJobMethodIdinteger · integerRequired

Patch job type, you can find the list available patch job type GET /v3/patchJob/type

patchJobMethodstringRead-onlyRequired

Name of the patch job method

patchJobNamestringRequired

Name of the patch job (unique)

statusinteger · integerRead-onlyRequired

Status of the patch job, you can find the list available patch job type GET /v3/patchJob/status

stopMethodIdinteger · integerRequired

Stop method of an application instance, you can find the list available application instance stop methods GET /v3/application/stopMethod

stopMethodNamestringRead-onlyRequired

Name of the stop method

stopMethodTimeoutinteger · integerOptional

Stop method timeout of an application instance in seconds

commentsstringOptional

Comments for patch job

schedulerStartTimeinteger · integerOptional

Start time when the patch job will be started. The default value is 0, this means start directly after creation of the patch job, else the patch job will start at the provided UTC timestamp

patchJobStartTimeinteger · integerRead-onlyRequired

Timestamp when the patch job has been started in UTC

createdAtinteger · integerRead-onlyRequired

Timestamp when the patch job has been created

changedAtinteger · integerRead-onlyRequired

Timestamp when the patch job last has been changed

finishedAtinteger · integerRead-onlyRequired

Timestamp when the patch job has been finished in UTC

isRevertableinteger · integerRead-onlyRequired

If the patch job can be cancelled, when is 1 you can cancel the patch job else not

revertsPatchJobIdinteger · integer · nullableRead-onlyRequired

If filled in, this ID points to the patch job that has been reverted by this patch job

revertedByPatchJobIdinteger · integer · nullableRead-onlyRequired

If filled in, this ID points to the PatchJob that has reverted this patch job

403

Invalid credentials

404

Invalid patchJobId

500

Internal Server Error

application/json

put

/v3/patchJob/{patchJobId}/hold

PUT /v3/patchJob/{patchJobId}/hold HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": "text",
    "deploymentEnvironmentId": "text",
    "applicationId": "text",
    "patchJobMethodId": 1,
    "patchJobMethod": "text",
    "patchJobName": "text",
    "status": 1,
    "stopMethodId": 1,
    "stopMethodName": "text",
    "stopMethodTimeout": 1,
    "comments": "text",
    "schedulerStartTime": 1,
    "patchJobStartTime": 1,
    "patchJobOverallProgress": {
      "total": 1,
      "downloaded": 1,
      "stopped": 1,
      "success": 1,
      "failed": 1,
      "started": 1,
      "canceled": 1,
      "remaining": 1
    },
    "applicationBuild": [
      {
        "id": "text",
        "oldApplicationBuildId": "text",
        "newApplicationBuildId": "text"
      }
    ],
    "fleet": [
      {
        "id": "text",
        "fleetId": "text"
      }
    ],
    "email": [
      {
        "id": "text",
        "email": "text",
        "progressReport": 1,
        "resultReport": 1,
        "createdAt": 1,
        "changedAt": 1
      }
    ],
    "createdAt": 1,
    "changedAt": 1,
    "finishedAt": 1,
    "isRevertable": 1,
    "revertsPatchJobId": 1,
    "revertedByPatchJobId": 1
  }
]

Unhold the given patch job

put

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

patchJobIdstringRequired

The Id of the patch job

Responses

200

application/json

idstringRead-onlyRequired

Patch job ID

deploymentEnvironmentIdstringRequired

Deployment environment ID

applicationIdstringRequired

Application ID

patchJobMethodIdinteger · integerRequired

Patch job type, you can find the list available patch job type GET /v3/patchJob/type

patchJobMethodstringRead-onlyRequired

Name of the patch job method

patchJobNamestringRequired

Name of the patch job (unique)

statusinteger · integerRead-onlyRequired

Status of the patch job, you can find the list available patch job type GET /v3/patchJob/status

stopMethodIdinteger · integerRequired

Stop method of an application instance, you can find the list available application instance stop methods GET /v3/application/stopMethod

stopMethodNamestringRead-onlyRequired

Name of the stop method

stopMethodTimeoutinteger · integerOptional

Stop method timeout of an application instance in seconds

commentsstringOptional

Comments for patch job

schedulerStartTimeinteger · integerOptional

Start time when the patch job will be started. The default value is 0, this means start directly after creation of the patch job, else the patch job will start at the provided UTC timestamp

patchJobStartTimeinteger · integerRead-onlyRequired

Timestamp when the patch job has been started in UTC

createdAtinteger · integerRead-onlyRequired

Timestamp when the patch job has been created

changedAtinteger · integerRead-onlyRequired

Timestamp when the patch job last has been changed

finishedAtinteger · integerRead-onlyRequired

Timestamp when the patch job has been finished in UTC

isRevertableinteger · integerRead-onlyRequired

If the patch job can be cancelled, when is 1 you can cancel the patch job else not

revertsPatchJobIdinteger · integer · nullableRead-onlyRequired

If filled in, this ID points to the patch job that has been reverted by this patch job

revertedByPatchJobIdinteger · integer · nullableRead-onlyRequired

If filled in, this ID points to the PatchJob that has reverted this patch job

403

Invalid credentials

404

Invalid patchJobId

500

Internal Server Error

application/json

put

/v3/patchJob/{patchJobId}/unhold

PUT /v3/patchJob/{patchJobId}/unhold HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": "text",
    "deploymentEnvironmentId": "text",
    "applicationId": "text",
    "patchJobMethodId": 1,
    "patchJobMethod": "text",
    "patchJobName": "text",
    "status": 1,
    "stopMethodId": 1,
    "stopMethodName": "text",
    "stopMethodTimeout": 1,
    "comments": "text",
    "schedulerStartTime": 1,
    "patchJobStartTime": 1,
    "patchJobOverallProgress": {
      "total": 1,
      "downloaded": 1,
      "stopped": 1,
      "success": 1,
      "failed": 1,
      "started": 1,
      "canceled": 1,
      "remaining": 1
    },
    "applicationBuild": [
      {
        "id": "text",
        "oldApplicationBuildId": "text",
        "newApplicationBuildId": "text"
      }
    ],
    "fleet": [
      {
        "id": "text",
        "fleetId": "text"
      }
    ],
    "email": [
      {
        "id": "text",
        "email": "text",
        "progressReport": 1,
        "resultReport": 1,
        "createdAt": 1,
        "changedAt": 1
      }
    ],
    "createdAt": 1,
    "changedAt": 1,
    "finishedAt": 1,
    "isRevertable": 1,
    "revertsPatchJobId": 1,
    "revertedByPatchJobId": 1
  }
]

Cancel the given patch job

put

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

patchJobIdstringRequired

The Id of the patch job

Responses

200

application/json

idstringRead-onlyRequired

Patch job ID

deploymentEnvironmentIdstringRequired

Deployment environment ID

applicationIdstringRequired

Application ID

patchJobMethodIdinteger · integerRequired

Patch job type, you can find the list available patch job type GET /v3/patchJob/type

patchJobMethodstringRead-onlyRequired

Name of the patch job method

patchJobNamestringRequired

Name of the patch job (unique)

statusinteger · integerRead-onlyRequired

Status of the patch job, you can find the list available patch job type GET /v3/patchJob/status

stopMethodIdinteger · integerRequired

Stop method of an application instance, you can find the list available application instance stop methods GET /v3/application/stopMethod

stopMethodNamestringRead-onlyRequired

Name of the stop method

stopMethodTimeoutinteger · integerOptional

Stop method timeout of an application instance in seconds

commentsstringOptional

Comments for patch job

schedulerStartTimeinteger · integerOptional

Start time when the patch job will be started. The default value is 0, this means start directly after creation of the patch job, else the patch job will start at the provided UTC timestamp

patchJobStartTimeinteger · integerRead-onlyRequired

Timestamp when the patch job has been started in UTC

createdAtinteger · integerRead-onlyRequired

Timestamp when the patch job has been created

changedAtinteger · integerRead-onlyRequired

Timestamp when the patch job last has been changed

finishedAtinteger · integerRead-onlyRequired

Timestamp when the patch job has been finished in UTC

isRevertableinteger · integerRead-onlyRequired

If the patch job can be cancelled, when is 1 you can cancel the patch job else not

revertsPatchJobIdinteger · integer · nullableRead-onlyRequired

If filled in, this ID points to the patch job that has been reverted by this patch job

revertedByPatchJobIdinteger · integer · nullableRead-onlyRequired

If filled in, this ID points to the PatchJob that has reverted this patch job

403

Invalid credentials

404

Invalid patchJobId

500

Internal Server Error

application/json

put

/v3/patchJob/{patchJobId}/cancel

PUT /v3/patchJob/{patchJobId}/cancel HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": "text",
    "deploymentEnvironmentId": "text",
    "applicationId": "text",
    "patchJobMethodId": 1,
    "patchJobMethod": "text",
    "patchJobName": "text",
    "status": 1,
    "stopMethodId": 1,
    "stopMethodName": "text",
    "stopMethodTimeout": 1,
    "comments": "text",
    "schedulerStartTime": 1,
    "patchJobStartTime": 1,
    "patchJobOverallProgress": {
      "total": 1,
      "downloaded": 1,
      "stopped": 1,
      "success": 1,
      "failed": 1,
      "started": 1,
      "canceled": 1,
      "remaining": 1
    },
    "applicationBuild": [
      {
        "id": "text",
        "oldApplicationBuildId": "text",
        "newApplicationBuildId": "text"
      }
    ],
    "fleet": [
      {
        "id": "text",
        "fleetId": "text"
      }
    ],
    "email": [
      {
        "id": "text",
        "email": "text",
        "progressReport": 1,
        "resultReport": 1,
        "createdAt": 1,
        "changedAt": 1
      }
    ],
    "createdAt": 1,
    "changedAt": 1,
    "finishedAt": 1,
    "isRevertable": 1,
    "revertsPatchJobId": 1,
    "revertedByPatchJobId": 1
  }
]

Stops the given patch job and set the patch job to success

put

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

patchJobIdstringRequired

The Id of the patch job

Responses

204

No Content

403

Invalid credentials

404

Invalid patchJobId

422

unprocessable patchJob

500

Internal Server Error

application/json

put

/v3/patchJob/{patchJobId}/stop

PUT /v3/patchJob/{patchJobId}/stop HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

No content

Delete a patch job report email

delete

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

patchJobIdstringRequired

The Id of the patch job

patchJobReportEmailIdstringRequired

The Id of the patch job report email

Responses

200

application/json

idstringRead-onlyRequired

Patch job ID

deploymentEnvironmentIdstringRequired

Deployment environment ID

applicationIdstringRequired

Application ID

patchJobMethodIdinteger · integerRequired

Patch job type, you can find the list available patch job type GET /v3/patchJob/type

patchJobMethodstringRead-onlyRequired

Name of the patch job method

patchJobNamestringRequired

Name of the patch job (unique)

statusinteger · integerRead-onlyRequired

Status of the patch job, you can find the list available patch job type GET /v3/patchJob/status

stopMethodIdinteger · integerRequired

Stop method of an application instance, you can find the list available application instance stop methods GET /v3/application/stopMethod

stopMethodNamestringRead-onlyRequired

Name of the stop method

stopMethodTimeoutinteger · integerOptional

Stop method timeout of an application instance in seconds

commentsstringOptional

Comments for patch job

schedulerStartTimeinteger · integerOptional

Start time when the patch job will be started. The default value is 0, this means start directly after creation of the patch job, else the patch job will start at the provided UTC timestamp

patchJobStartTimeinteger · integerRead-onlyRequired

Timestamp when the patch job has been started in UTC

createdAtinteger · integerRead-onlyRequired

Timestamp when the patch job has been created

changedAtinteger · integerRead-onlyRequired

Timestamp when the patch job last has been changed

finishedAtinteger · integerRead-onlyRequired

Timestamp when the patch job has been finished in UTC

isRevertableinteger · integerRead-onlyRequired

If the patch job can be cancelled, when is 1 you can cancel the patch job else not

revertsPatchJobIdinteger · integer · nullableRead-onlyRequired

If filled in, this ID points to the patch job that has been reverted by this patch job

revertedByPatchJobIdinteger · integer · nullableRead-onlyRequired

If filled in, this ID points to the PatchJob that has reverted this patch job

403

Invalid credentials

404

Invalid patchJobId or reportEmailId

500

Internal Server Error

application/json

delete

/v3/patchJob/{patchJobId}/email/{patchJobReportEmailId}

DELETE /v3/patchJob/{patchJobId}/email/{patchJobReportEmailId} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": "text",
    "deploymentEnvironmentId": "text",
    "applicationId": "text",
    "patchJobMethodId": 1,
    "patchJobMethod": "text",
    "patchJobName": "text",
    "status": 1,
    "stopMethodId": 1,
    "stopMethodName": "text",
    "stopMethodTimeout": 1,
    "comments": "text",
    "schedulerStartTime": 1,
    "patchJobStartTime": 1,
    "patchJobOverallProgress": {
      "total": 1,
      "downloaded": 1,
      "stopped": 1,
      "success": 1,
      "failed": 1,
      "started": 1,
      "canceled": 1,
      "remaining": 1
    },
    "applicationBuild": [
      {
        "id": "text",
        "oldApplicationBuildId": "text",
        "newApplicationBuildId": "text"
      }
    ],
    "fleet": [
      {
        "id": "text",
        "fleetId": "text"
      }
    ],
    "email": [
      {
        "id": "text",
        "email": "text",
        "progressReport": 1,
        "resultReport": 1,
        "createdAt": 1,
        "changedAt": 1
      }
    ],
    "createdAt": 1,
    "changedAt": 1,
    "finishedAt": 1,
    "isRevertable": 1,
    "revertsPatchJobId": 1,
    "revertedByPatchJobId": 1
  }
]

Create, update and remove patch job report email

put

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

patchJobIdstringRequired

The Id of the patch job

Body

Responses

200

application/json

idstringRead-onlyRequired

ID of a patch job email

emailstringRequired

Email address for reporting (unique)

progressReportinteger · integerRequired

If 1 progress report will be send, if 0 no progress report will be send

resultReportinteger · integerRequired

If 1 result report will be send, if 0 no result report will be send

createdAtinteger · integerRead-onlyRequired

Timestamp when the patch job email has been created

changedAtinteger · integerRead-onlyRequired

Timestamp when the patch job email last has been changed

403

Invalid credentials

404

Invalid patchJobId

500

Internal Server Error

application/json

put

/v3/patchJob/{patchJobId}/email/bulk

PUT /v3/patchJob/{patchJobId}/email/bulk HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 72

{
  "patchJobEmail": [
    {
      "email": "text",
      "progressReport": 1,
      "resultReport": 1
    }
  ]
}

[
  {
    "id": "text",
    "email": "text",
    "progressReport": 1,
    "resultReport": 1,
    "createdAt": 1,
    "changedAt": 1
  }
]

Get gives back the progress of the patch job

get

Authorizations

PRIVATE-TOKENstringRequired

Responses

200

application/json

patchJobIdstringRead-onlyRequired

Patch job ID

patchJobNamestringRead-onlyRequired

Name of the patch job

changedAtinteger · integerRead-onlyRequired

Unix timestamp when the status of the patch job has been changed

finishedAtinteger · integerRead-onlyRequired

Unix timestamp when the patch job finished (if 0 then the patch job is still running)

startedAtinteger · integerRead-onlyRequired

Unix timestamp when the patch job started

patchJobMethodNamestringRead-onlyRequired

Name of the patch job method (strategy)

patchJobStatusinteger · integerRead-onlyRequired

Status of the patch job

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/patchJob/{patchJobId}/report/progress

GET /v3/patchJob/{patchJobId}/report/progress HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "patchJobId": "text",
    "patchJobName": "text",
    "changedAt": 1,
    "finishedAt": 1,
    "startedAt": 1,
    "patchJobMethodName": "text",
    "patchJobStatus": 1,
    "deploymentEnvironment": {
      "id": "text",
      "name": "text"
    },
    "oldApplicationBuilds": [
      {
        "id": "text",
        "name": "text",
        "version": "text"
      }
    ],
    "newApplicationBuild": {
      "id": "text",
      "name": "text",
      "version": "text"
    },
    "progress": {
      "total": 1,
      "downloaded": 1,
      "stopped": 1,
      "success": 1,
      "failed": 1,
      "started": 1,
      "canceled": 1,
      "remaining": 1
    },
    "fleetData": [
      {
        "fleet": {
          "id": "text",
          "name": "text"
        },
        "progress": {
          "total": 1,
          "downloaded": 1,
          "stopped": 1,
          "success": 1,
          "failed": 1,
          "started": 1,
          "canceled": 1,
          "remaining": 1
        },
        "deploymentRegionData": [
          {
            "deploymentRegion": {
              "id": "text",
              "name": "text"
            },
            "progress": {
              "total": 1,
              "downloaded": 1,
              "stopped": 1,
              "success": 1,
              "failed": 1,
              "started": 1,
              "canceled": 1,
              "remaining": 1
            },
            "dcLocationData": [
              {
                "dcLocation": {
                  "id": 1,
                  "name": "text"
                },
                "dcLocationRegionName": "text",
                "progress": {
                  "total": 1,
                  "downloaded": 1,
                  "stopped": 1,
                  "success": 1,
                  "failed": 1,
                  "started": 1,
                  "canceled": 1,
                  "remaining": 1
                }
              }
            ]
          }
        ]
      }
    ]
  }
]

Get a list of failed application instances

get

Authorizations

PRIVATE-TOKENstringRequired

Header parameters

RANGED-DATAstringRequired

Example header and default range: RANGED-DATA:start=0,results=25

Responses

200

application/json

idstringRead-onlyRequired

Application instance ID

deploymentEnvironmentIdstringRead-onlyRequired

The deployment environment ID of this application instance

deploymentEnvironmentNamestringRead-onlyRequired

The deployment environment name of this application instance

fleetIdstringRead-onlyRequired

The fleet ID of this application instance

fleetNamestringRead-onlyRequired

The fleet name of this application instance

hostIdinteger · integerRead-onlyRequired

The application instance is host on this server.

isVirtualinteger · integerRead-onlyRequired

0 if this instance runs on a bare metal server, 1 if it runs on a VM

applicationIdstringRead-onlyRequired

The application ID of this application instance

applicationNamestringRead-onlyRequired

The application name of this application instance

applicationTypeinteger · integerRead-onlyRequired

The type of the application, the different types can be found in: GET /application/type

applicationBuildIdstringRead-onlyRequired

The application build ID of this application instance

applicationBuildNamestringRead-onlyRequired

The application build name of this application instance

installIdstring · nullableOptionalDeprecated

ID of the application install

dcLocationIdinteger · integerRead-onlyRequired

The datacenter ID of where this application instance is located

dcLocationNamestringRead-onlyRequired

The datacenter name of where this application instance is located

regionIdstringRead-onlyRequired

The deployment region ID of where this application instance is located

regionNamestringRead-onlyRequired

The deployment region name of where this application instance is located

statusinteger · integerRead-onlyRequired

The application instance status, list of application instance status can be found in GET /v3/applicationInstance/status

createdAtinteger · integerRead-onlyRequired

The Unix timestamp at which this application instance is created

startedAtinteger · integerRead-onlyRequired

The Unix timestamp at which this application instance is started

stoppedAtinteger · integerRead-onlyRequired

The Unix timestamp at which this application instance is stopped

pidinteger · integerRead-onlyRequired

The process ID of the application instance running on the host

pidChangedAtinteger · integerRead-onlyRequired

The Unix timestamp of the moment the process ID has been changed on the host

manuallyDeployedinteger · integerRead-onlyRequired

If set to 1, the application instance was manually deployed.

autoRestartinteger · integerRead-onlyRequired

If auto restart is 1 than the application instance will auto restart, when 0 the application instance auto restart will be disabled

markedForDeletioninteger · integerRead-onlyRequired

if an application will be deleted it will be 1 else 0

arcusAvailableinteger · integerRead-onlyRequired

1 if Arcus is available & running for this application instance, 0 otherwise. Note: If your application's managementProtocol is NOT set to Arcus, this value will always be 0, even if your game server would support the Arcus protocol. The protocol is only tested, and this value potentially be set to 1, when the managementProtocol is set to Arcus.

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/patchJob/{patchJobId}/failedApplicationInstances

GET /v3/patchJob/{patchJobId}/failedApplicationInstances HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
RANGED-DATA: text
Accept: */*

[
  {
    "id": "text",
    "deploymentEnvironmentId": "text",
    "deploymentEnvironmentName": "text",
    "fleetId": "text",
    "fleetName": "text",
    "hostId": 1,
    "isVirtual": 1,
    "applicationId": "text",
    "applicationName": "text",
    "applicationType": 1,
    "applicationBuildId": "text",
    "applicationBuildName": "text",
    "dcLocationId": 1,
    "dcLocationName": "text",
    "regionId": "text",
    "regionName": "text",
    "status": 1,
    "createdAt": 1,
    "startedAt": 1,
    "stoppedAt": 1,
    "pid": 1,
    "pidChangedAt": 1,
    "manuallyDeployed": 1,
    "autoRestart": 1,
    "markedForDeletion": 1,
    "arcusAvailable": 1
  }
]

Get a failed application instance

get

Authorizations

PRIVATE-TOKENstringRequired

Responses

200

application/json

idstringRead-onlyRequired

Application instance ID

fleetIdstringRead-onlyRequired

The application's fleet ID

fleetNamestringRead-onlyRequired

The application's fleet name

hostIdinteger · integerRead-onlyRequired

The application instance is host on this server.

isVirtualinteger · integerRead-onlyRequired

0 if this instance runs on a bare metal server, 1 if it runs on a VM

applicationIdstringRead-onlyRequired

The ID of the application

applicationNamestringRead-onlyRequired

The application's application name

applicationTypeinteger · integerRead-onlyRequired

The type of the application, the different types can be found in: GET /v3/application/type]

applicationBuildIdstringRead-onlyRequired

The ID of the application build

applicationBuildNamestringRead-onlyRequired

The application's application build name

installIdinteger · integerOptionalDeprecated

ID of the application install

dcLocationIdinteger · integerRead-onlyRequired

The datacenter ID of where this application instance is located

dcLocationNamestringRead-onlyRequired

The application's dc location name

regionIdstringRead-onlyRequired

The deployment region ID of where this application instance is located

regionNamestringRead-onlyRequired

The application's region name

statusinteger · integerRead-onlyRequired

The application instance status, list of application instance status can be found in GET /v3/applicationInstance/status

createdAtinteger · integerRead-onlyRequired

The Unix timestamp at which this application instance is created

startedAtinteger · integerRead-onlyRequired

The Unix timestamp at which this application instance is started

stoppedAtinteger · integerRead-onlyRequired

The Unix timestamp at which this application instance is stopped

pidinteger · integerRead-onlyRequired

The process ID of the application instance running on the host

pidChangedAtinteger · integerRead-onlyRequired

The Unix timestamp of the moment the process ID has been changed on the host

manuallyDeployedinteger · integerRead-onlyRequired

If set to 1, the application instance was manually deployed.

numPlayersMaxinteger · integerRead-onlyRequired

The maximum number of players on the application instance (this only apply to application instances of the type game)

numPlayersinteger · integerRead-onlyRequired

The number of online players on the application instance (this only apply to application instances of the type game)

liveHostNamestringRead-onlyRequired

The live host name of the application instance (this only apply to application instances of the type game)

liveMapstringRead-onlyRequired

The live map of an application instance (this only apply to application instances of the type game)

liveGameVersionstringRead-onlyRequired

The live game version of an application instance (this only apply to application instances of the type game)

liveRulesstringRead-onlyRequired

The live rules of an application instance (this only apply to application instances of the type game)

autoRestartinteger · integerRead-onlyRequired

If auto restart is 1 than the application instance will auto restart, when 0 the application instance auto restart will be disabled

markedForDeletioninteger · integerRead-onlyRequired

if an application will be deleted it will be 1 else 0

exitCodeinteger · integerRead-onlyRequired

The exit code of the application, if it has crashed during patching else it will be 0

failingReasonstringRead-onlyRequired

The reason why the application instance failed to patch

startParametersstringRead-onlyRequired

The start parameters that were used to start the application

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/patchJob/{patchJobId}/applicationInstance/{applicationInstanceId}/failedApplicationInstance

GET /v3/patchJob/{patchJobId}/applicationInstance/{applicationInstanceId}/failedApplicationInstance HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": "text",
    "fleetId": "text",
    "fleetName": "text",
    "hostId": 1,
    "isVirtual": 1,
    "applicationId": "text",
    "applicationName": "text",
    "applicationType": 1,
    "applicationBuildId": "text",
    "applicationBuildName": "text",
    "dcLocationId": 1,
    "dcLocationName": "text",
    "regionId": "text",
    "regionName": "text",
    "status": 1,
    "createdAt": 1,
    "startedAt": 1,
    "stoppedAt": 1,
    "pid": 1,
    "pidChangedAt": 1,
    "manuallyDeployed": 1,
    "properties": [
      {
        "id": "text",
        "propertyType": 1,
        "propertyKey": "text",
        "propertyValue": "text"
      }
    ],
    "ipAddress": [
      {
        "ipAddress": "text",
        "ipVersion": 1,
        "private": 1
      }
    ],
    "labelReadOnly": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "labelPublic": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "metadata": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "numPlayersMax": 1,
    "numPlayers": 1,
    "liveHostName": "text",
    "liveMap": "text",
    "liveGameVersion": "text",
    "liveRules": "text",
    "autoRestart": 1,
    "markedForDeletion": 1,
    "exitCode": 1,
    "failingReason": "text",
    "startParameters": "text"
  }
]

Last updated 11 months ago

Was this helpful?

hashtagGet list of patch job types

hashtagGet list of patch job runtime types

hashtagGet list of patch job status

hashtagShow a preview of the number of game application instances that are affected by the selection

hashtagGet the list of all patch jobs

hashtagCreate a patch job

hashtagGet the detail of a patch job

hashtagUpdate the detail of a patch job

hashtagGet summary of all patch jobs

hashtagGets the list of patch job fleet based on deploymentEnvironmentId and applicationId

hashtagGets the list of reporting emails for a specific patch job

hashtagCreate a patch job report email

hashtagPut a given patch job on hold

hashtagUnhold the given patch job

hashtagCancel the given patch job

hashtagStops the given patch job and set the patch job to success

hashtagDelete a patch job report email

hashtagCreate, update and remove patch job report email

hashtagGet gives back the progress of the patch job

hashtagGet a list of failed application instances

hashtagGet a failed application instance

Get list of patch job types

Get list of patch job runtime types

Get list of patch job status

Show a preview of the number of game application instances that are affected by the selection

Get the list of all patch jobs

Create a patch job

Get the detail of a patch job

Update the detail of a patch job

Get summary of all patch jobs

Gets the list of patch job fleet based on deploymentEnvironmentId and applicationId

Gets the list of reporting emails for a specific patch job

Create a patch job report email

Put a given patch job on hold

Unhold the given patch job

Cancel the given patch job

Stops the given patch job and set the patch job to success

Delete a patch job report email

Create, update and remove patch job report email

Get gives back the progress of the patch job

Get a list of failed application instances

Get a failed application instance