Artboard
Deployments

Get Deployment Batches

GET
/otto/api/deployment/batches

Query Parameters

offset?number|null

GET /otto/api/deployment/batches Parameter

Formatdouble
Range-1.7976931348623157e+308 <= value <= 1.7976931348623157e+308
limit?number|null

GET /otto/api/deployment/batches Parameter

Formatdouble
Range-1.7976931348623157e+308 <= value <= 1.7976931348623157e+308

Response Body

application/json

application/json

curl -X GET "https://your.server.net/otto/api/deployment/batches"
{
  "response": {
    "batches": [
      {
        "id": -1.7976931348623157e+308,
        "name": "string",
        "file_count": -1.7976931348623157e+308,
        "final_result": "successful",
        "running": -1.7976931348623157e+308,
        "status": "queued",
        "log": [
          {
            "level": "info",
            "phase": "scheduled",
            "message": "string",
            "timeElapsed": 9007199254740991,
            "file": "string"
          }
        ],
        "deployment_payload": {
          "source": {
            "type": "url",
            "url": "string"
          },
          "name": "string",
          "preDeploymentScript": {
            "file": {
              "name": "string",
              "user": "string",
              "password": "string"
            },
            "script": {
              "name": "string",
              "param": "string",
              "timeout": 9007199254740991
            },
            "abortIfScriptFails": true
          },
          "postDeploymentScript": {
            "file": {
              "name": "string",
              "user": "string",
              "password": "string"
            },
            "script": {
              "name": "string",
              "param": "string",
              "timeout": 9007199254740991
            },
            "rollbackIfScriptFails": false
          },
          "fileOperations": [
            {
              "operation": "migrate",
              "clone": {
                "fileName": "string",
                "user": "string",
                "password": "string",
                "encryptionKey": "string"
              },
              "dataSource": {
                "fileName": "string",
                "user": "string",
                "password": "string",
                "encryptionKey": "string"
              },
              "target": {
                "fileName": "string",
                "encryptionKey": "string"
              },
              "dataMigrationOptions": {
                "-target_locale": "string",
                "-force": true,
                "-ignore_valuelists": true,
                "-ignore_accounts": true,
                "-ignore_fonts": true,
                "-reevaluate": true,
                "-rebuildindexes": true,
                "-v": true
              }
            }
          ],
          "concurrency": 1,
          "options": {
            "closeFilesMessage": "string",
            "notifications": [
              {
                "type": "slack",
                "channelUrl": "string",
                "label": "string"
              }
            ],
            "closeFilesAfterBuild": false,
            "keepFilesClosedAfterComplete": false,
            "transferContainerData": false
          }
        },
        "build_manifest": {
          "status": "completed",
          "buildId": "string",
          "zipArchive": "string",
          "textFiles": [
            {
              "fileName": "string",
              "content": "string"
            }
          ],
          "files": [
            {
              "fileName": "string",
              "clone": true,
              "user": "string",
              "password": "string",
              "encryptionKey": "string",
              "size": -1.7976931348623157e+308,
              "hasContainerData": true
            }
          ],
          "zipSize": 1.7976931348623157e+308,
          "completedFiles": 9007199254740991,
          "message": "string",
          "log": [
            {
              "level": "info",
              "phase": "scheduling",
              "message": "string",
              "timeElapsed": 9007199254740991,
              "file": "string"
            }
          ],
          "startedAt": "string",
          "chainedActionResults": [
            {
              "action": {
                "sendOnFailure": false,
                "type": "build_start",
                "id": "string",
                "url": "string",
                "apiKey": "string",
                "input": null
              },
              "result": null,
              "success": true
            }
          ],
          "ottofmsId": -1.7976931348623157e+308,
          "preDeploymentScript": {
            "file": {
              "name": "string",
              "user": "string",
              "password": "string"
            },
            "script": {
              "name": "string",
              "param": "string",
              "timeout": 9007199254740991
            },
            "abortIfScriptFails": true
          },
          "postDeploymentScript": {
            "file": {
              "name": "string",
              "user": "string",
              "password": "string"
            },
            "script": {
              "name": "string",
              "param": "string",
              "timeout": 9007199254740991
            },
            "rollbackIfScriptFails": false
          }
        },
        "started_at": "2019-08-24T14:15:22Z",
        "batchId": -1.7976931348623157e+308,
        "type": "sub-deployment",
        "schedule_id": "string"
      }
    ]
  },
  "messages": [
    {
      "code": 0.1,
      "text": "ok"
    }
  ]
}
{
  "response": {},
  "messages": [
    {
      "code": 18011,
      "text": "OttoFMS sample error"
    }
  ]
}