Endpoints Deploy Controller Resource

POST /deploy/endpoints

Request Body
media type data type
application/json EndpointsDeployDetails (JSON)
Response Body
media type data type description
application/json EndpointsDeployTask (JSON)

Example

Request
POST /deploy/endpoints
Content-Type: application/json
Accept: application/json

                
{
  "sshSettings" : {
    "username" : "...",
    "password" : "...",
    "addressIp" : "..."
  },
  "endpointAdminPassword" : "...",
  "ispFqdn" : "...",
  "deployMethod" : "ENDPOINTS_SERVER_WITH_ISP_SERVER",
  "variables" : "..."
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "creationTime" : 12345,
  "status" : "FAILED",
  "auditEntityName" : "...",
  "guid" : "...",
  "ver" : 12345,
  "nameAndGuid" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "nameGuidAndType" : {
    "type" : {
      "name" : "ENUM_NAME",
      "description" : "Enum description"
    },
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }
}
                
              

POST /deploy/endpoints/output

Request Body
media type data type
application/json EndpointsDeployOutputRequest (JSON)
Response Body
media type data type description
application/json EndpointsDeployOutputDetails (JSON)

Example

Request
POST /deploy/endpoints/output
Content-Type: application/json
Accept: application/json

                
{
  "taskId" : "...",
  "offset" : 12345
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "offset" : 12345,
  "content" : "...",
  "taskStatus" : "FINISHED"
}
                
              

POST /deploy/endpoints/read-task

Request Body
media type data type
application/json string (JSON)

Example

Request
POST /deploy/endpoints/read-task
Content-Type: application/json

                
...
                
              
Response
HTTP/1.1 201 Created

              

GET /deploy/endpoints/running-task

Response Body
media type data type description
application/json EndpointsDeployTask (JSON)

Example

Request
GET /deploy/endpoints/running-task
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "creationTime" : 12345,
  "status" : "FAILED",
  "auditEntityName" : "...",
  "guid" : "...",
  "ver" : 12345,
  "nameAndGuid" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "nameGuidAndType" : {
    "type" : {
      "name" : "ENUM_NAME",
      "description" : "Enum description"
    },
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }
}
                
              

GET /deploy/endpoints/task

Response Body
media type data type description
application/json array of EndpointsDeployTask (JSON)

Example

Request
GET /deploy/endpoints/task
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "creationTime" : 12345,
  "status" : "RUNNING",
  "auditEntityName" : "...",
  "guid" : "...",
  "ver" : 12345,
  "nameAndGuid" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "nameGuidAndType" : {
    "type" : {
      "name" : "ENUM_NAME",
      "description" : "Enum description"
    },
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }
} ]
                
              

GET /deploy/endpoints/advanced-options/{deployMethod}

Request Parameters
name type description
deployMethod path
Response Body
media type data type description
application/json AdvancedOptionsDetails (JSON)

Example

Request
GET /deploy/endpoints/advanced-options/{deployMethod}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "advancedOptions" : "...",
  "roleDownloadStatus" : "RUNNING",
  "failMessage" : "..."
}
                
              

GET /deploy/endpoints/progress/{deployTaskGuid}

Request Parameters
name type description
deployTaskGuid path
Response Body
media type data type description
application/json DeployTaskProgressDetails (JSON)

Example

Request
GET /deploy/endpoints/progress/{deployTaskGuid}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "toDoTasksNumber" : 12345,
  "doneTasksNumber" : 12345,
  "lastTaskName" : "..."
}