Continuing Port Management Task


Overview

This API can be used to do “Continue Task” of the port management in case of any failure task during the port management. Exact same parameters that were passed on initial launch, in the request body are required.


Synchronous / Asynchronous

  • Asynchronous


Request

HTTP Request Method

  • PUT


HTTP Request Path

{endpoint}/ecl-api/process/{processid}/restart?tenantid={tenantid}&usertoken={x-subject-token}

HTTP Request Header

X-Auth-Token: <token_id>

Request Parameter

Request Parameters

Parameter

Type

Format

Description

Required

processId

String

Numeric

Process ID of the execurion

Yes

tenantid

String

UUID

Tenant ID of the owner (UUID)

Yes

usertoken

String

UUID

User Token (UUID)

Yes

Request Body Parameter

Please refer to appropriate section ( Port Management for Single Constitution FW/UTM , Port Management for HA Constitution FW/UTM or Port Management for WAF ) depending on what type of port management (Single Constitution FW/UTM, HA FW/UTM, WAF) was executed, as exact same parameters on initial launch are required.

Response

HTTP Response Code

Response Codes

Response Code

Description

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

405

Method Not Allowed

500

Internal Server Error

Response Parameter

Response Parameters

Parameter

Type

Format

Description

message

String

-

Message of the response

processId

String

Numeric

Process ID of the execution, this number is necessary to check the status of port management

taskid

String

Numeric

Task ID that previously failed and resumed

Sample Response Body

Normal Response

{
    "message":"Continue task request accepted successfully",
    "processId":"209561"
    "taskid":"4"
}

Error Response

{
    "error": {
         "message": "error message"
    }
}
Get Port Management Status
Revision History