sync xsoar integration playbook status to IoT

POST 
/pub/v4.0/xsoar/status

sync xsoar integration playbook status

Request

Query Parameters

customerid stringrequired

The customer ID to which the API call is directed

application/json

Body

required

status stringrequired

playboook status - error/success/disabled/license_limit_exceeded

timestamp numberrequired

timestamp

integration_name stringrequired

name of the integration instance

message string

status message

custom_integration_name string

customized integration name

Responses

200

Successful Response

application/json

Schema

Schema

received string

if IoT has received the integration information

Example (from schema)

{
  "received": "string"
}

xsoarStatusResponse

{
  "received": "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"
}

xsoarStatusResponse

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

Loading...