REST API for Webhooks Management

Returns a CSRF Token.

get

/system/api/v1/csrfToken

Request

There are no request parameters for this operation.

Response

Supported Media Types

application/json

200 Response

Root Schema : CSRF Token

Type: object

Token information

Show Source

expiresAt(optional): string

The token expiration date. Date and time values are in ISO 8601 `yyyy-MM-dd'T'HH:mm:ss.SSS'Z'` format using a UTC timezone.

Example: 2019-06-19T15:20:00.003
token(optional): string

The token string

Example: 8htW64iW8dJg7qyNuh7o1U3oDBocVk6CY2xkPiXS9eFbWJrBFP48f/8kNHebiP3fbQ5mHifqaENk\r\nCMxk380w4joxNTYwNTI3NTMyOTU5

{
    "type":"object",
    "properties":{
        "token":{
            "type":"string",
            "example":"8htW64iW8dJg7qyNuh7o1U3oDBocVk6CY2xkPiXS9eFbWJrBFP48f/8kNHebiP3fbQ5mHifqaENk\\r\\nCMxk380w4joxNTYwNTI3NTMyOTU5",
            "description":"The token string"
        },
        "expiresAt":{
            "type":"string",
            "example":"2019-06-19T15:20:00.003",
            "description":"The token expiration date. Date and time values are in ISO 8601 &#x60;yyyy-MM-dd&#39;T&#39;HH:mm:ss.SSS&#39;Z&#39;&#x60; format using a UTC timezone."
        }
    },
    "description":"Token information"
}

500 Response

Internal Server Error

Root Schema : ErrorResponse

Type: object

Error Response.

Show Source

errorCode(optional): string

Error code.
errorMessage(optional): string

Error Message.
httpMessage(optional): string

Http status message.
httpStatusCode(optional): integer(int32)

Http status code.

{
    "type":"object",
    "properties":{
        "httpStatusCode":{
            "type":"integer",
            "format":"int32",
            "description":"Http status code."
        },
        "httpMessage":{
            "type":"string",
            "description":"Http status message."
        },
        "errorCode":{
            "type":"string",
            "description":"Error code."
        },
        "errorMessage":{
            "type":"string",
            "description":"Error Message."
        }
    },
    "description":"Error Response."
}