Collect Profile ACL Sync Job Status

POST 
/pub/v4.0/xsoar/profile/aclSync/status

Receive the Profile ACL sync status from Xsoar server

Request

Query Parameters

customerid stringrequired

The customer ID to which the API call is directed

jobid stringrequired

The ACL Sync Job Id that users initiate to sync to Xsoar server

application/json

Body

required

status stringrequired

The status of the job

message stringrequired

Any message that needs to report to IoT side regarding the job

Responses

200

Successful Response

application/json

Schema

Schema

successCase string

To indicate if this is a success case or not

Example (from schema)

{
  "successCase": "string"
}

xsoarProfileSyncResponse

{
  "successCase": "yes"
}

4XX

Client Error Response

application/json

Schema

Schema

code string

STATUS_CODE

msg string

GENERAL_MESSAGE

Example (from schema)

{
  "code": "string",
  "msg": "string"
}

Bad Request

{
  "code": 400,
  "msg": "Bad Request. This occurs when an HTTP request contains an invalid query string."
}

Forbidden access

{
  "code": 403,
  "msg": "Forbidden access. Either the provided API key is invalid or it does not have the required RBAC permissions to run this API."
}

Too many requests

{
  "code": 429,
  "msg": "Too many requests. The number of requests for device details for a single device exceeded the rate limit of 180 queries per minute per tenant."
}

5XX

Server Error Response

application/json

Schema

Schema

code string

STATUS_CODE

msg string

GENERAL_MESSAGE

Example (from schema)

{
  "code": "string",
  "msg": "string"
}

xsoarProfileSyncResponse

{
  "code": 500,
  "msg": "Internal server error. A unified status for API communication type errors."
}

Loading...