messaging-eastus-release-a.citrixworkspacesapi.net Open in urlscan Pro
52.150.55.255  Public Scan

Submitted URL: https://messaging-eastus-release-a.citrixworkspacesapi.net/
Effective URL: https://messaging-eastus-release-a.citrixworkspacesapi.net/swagger/ui/index
Submission: On February 03 via api from IE — Scanned from DE

Form analysis 9 forms found in the DOM

<form id="api_selector">
  <div class="input"><input placeholder="http://example.com/api" id="input_baseUrl" name="baseUrl" type="text"></div>
  <div class="input"><input placeholder="api_key" id="input_apiKey" name="apiKey" type="text"></div>
  <div class="input"><a id="explore" class="header__btn" href="#" data-sw-translate="">Explore</a></div>
</form>

<form accept-charset="UTF-8" class="sandbox">
  <div style="margin:0;padding:0;display:inline"></div>
  <h4 data-sw-translate="">Parameters</h4>
  <table class="fullwidth parameters">
    <thead>
      <tr>
        <th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
        <th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
        <th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
        <th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
        <th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
      </tr>
    </thead>
    <tbody class="operation-params">
      <tr>
        <td class="code required"><label for="mendpoint0.5630222191559147">endpoint</label></td>
        <td>
          <input class="parameter required" minlength="1" name="endpoint" placeholder="(required)" id="mendpoint0.5630222191559147" type="text" value="">
        </td>
        <td>
          <strong><span class="markdown">
              <p>The target endpoint.</p>
            </span></strong>
        </td>
        <td>path</td>
        <td><span class="model-signature">string</span></td>
      </tr>
      <tr>
        <td class="code required"><label for="mcustomer0.36187387227599244">customer</label></td>
        <td>
          <input class="parameter required" minlength="1" name="customer" placeholder="(required)" id="mcustomer0.36187387227599244" type="text" value="">
        </td>
        <td>
          <strong><span class="markdown"></span></strong>
        </td>
        <td>path</td>
        <td><span class="model-signature">string</span></td>
      </tr>
      <tr>
        <td class="code"><label for="mmessage.headers0.7198448757230209">message.headers</label></td>
        <td>
          <textarea class="body-textarea" name="message.headers" id="mmessage.headers0.7198448757230209" placeholder="Provide multiple values in new lines."></textarea>
        </td>
        <td class="markdown">
          <p>Optional message headers.</p>
        </td>
        <td>query</td>
        <td>
          <span class="model-signature">Array[]</span>
        </td>
      </tr>
      <tr>
        <td class="code"><label for="mmessage.payload.position0.1533150084351349">message.payload.position</label></td>
        <td>
          <input class="parameter" minlength="0" name="message.payload.position" placeholder="" id="mmessage.payload.position0.1533150084351349" type="text" value="">
        </td>
        <td class="markdown"></td>
        <td>query</td>
        <td>
          <span class="model-signature">long</span>
        </td>
      </tr>
      <tr>
        <td class="code"><label for="mmessage.payload.readTimeout0.8485105517478337">message.payload.readTimeout</label></td>
        <td>
          <input class="parameter" minlength="0" name="message.payload.readTimeout" placeholder="" id="mmessage.payload.readTimeout0.8485105517478337" type="text" value="">
        </td>
        <td class="markdown"></td>
        <td>query</td>
        <td>
          <span class="model-signature">integer</span>
        </td>
      </tr>
      <tr>
        <td class="code"><label for="mmessage.payload.writeTimeout0.4706997902105763">message.payload.writeTimeout</label></td>
        <td>
          <input class="parameter" minlength="0" name="message.payload.writeTimeout" placeholder="" id="mmessage.payload.writeTimeout0.4706997902105763" type="text" value="">
        </td>
        <td class="markdown"></td>
        <td>query</td>
        <td>
          <span class="model-signature">integer</span>
        </td>
      </tr>
    </tbody>
  </table>
  <div class="sandbox_header">
    <input class="submit" type="submit" value="Try it out!" data-sw-translate="">
    <a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
    <span class="response_throbber" style="display:none"></span>
  </div>
</form>

<form accept-charset="UTF-8" class="sandbox">
  <div style="margin:0;padding:0;display:inline"></div>
  <h4 data-sw-translate="">Parameters</h4>
  <table class="fullwidth parameters">
    <thead>
      <tr>
        <th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
        <th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
        <th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
        <th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
        <th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
      </tr>
    </thead>
    <tbody class="operation-params">
      <tr>
        <td class="code required"><label for="mcustomer0.625581971678749">customer</label></td>
        <td>
          <input class="parameter required" minlength="1" name="customer" placeholder="(required)" id="mcustomer0.625581971678749" type="text" value="">
        </td>
        <td>
          <strong><span class="markdown"></span></strong>
        </td>
        <td>path</td>
        <td><span class="model-signature">string</span></td>
      </tr>
    </tbody>
  </table>
  <div class="sandbox_header">
    <input class="submit" type="submit" value="Try it out!" data-sw-translate="">
    <a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
    <span class="response_throbber" style="display:none"></span>
  </div>
</form>

<form accept-charset="UTF-8" class="sandbox">
  <div style="margin:0;padding:0;display:inline"></div>
  <h4 data-sw-translate="">Parameters</h4>
  <table class="fullwidth parameters">
    <thead>
      <tr>
        <th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
        <th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
        <th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
        <th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
        <th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
      </tr>
    </thead>
    <tbody class="operation-params">
      <tr>
        <td class="code required"><label for="mcustomer0.5449832081184909">customer</label></td>
        <td>
          <input class="parameter required" minlength="1" name="customer" placeholder="(required)" id="mcustomer0.5449832081184909" type="text" value="">
        </td>
        <td>
          <strong><span class="markdown"></span></strong>
        </td>
        <td>path</td>
        <td><span class="model-signature">string</span></td>
      </tr>
    </tbody>
  </table>
  <div class="sandbox_header">
    <input class="submit" type="submit" value="Try it out!" data-sw-translate="">
    <a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
    <span class="response_throbber" style="display:none"></span>
  </div>
</form>

<form accept-charset="UTF-8" class="sandbox">
  <div style="margin:0;padding:0;display:inline"></div>
  <h4 data-sw-translate="">Parameters</h4>
  <table class="fullwidth parameters">
    <thead>
      <tr>
        <th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
        <th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
        <th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
        <th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
        <th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
      </tr>
    </thead>
    <tbody class="operation-params">
      <tr>
        <td class="code required"><label for="mcustomer0.745429647513389">customer</label></td>
        <td>
          <input class="parameter required" minlength="1" name="customer" placeholder="(required)" id="mcustomer0.745429647513389" type="text" value="">
        </td>
        <td>
          <strong><span class="markdown"></span></strong>
        </td>
        <td>path</td>
        <td><span class="model-signature">string</span></td>
      </tr>
    </tbody>
  </table>
  <div class="sandbox_header">
    <input class="submit" type="submit" value="Try it out!" data-sw-translate="">
    <a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
    <span class="response_throbber" style="display:none"></span>
  </div>
</form>

<form accept-charset="UTF-8" class="sandbox">
  <div style="margin:0;padding:0;display:inline"></div>
  <h4 data-sw-translate="">Parameters</h4>
  <table class="fullwidth parameters">
    <thead>
      <tr>
        <th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
        <th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
        <th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
        <th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
        <th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
      </tr>
    </thead>
    <tbody class="operation-params">
      <tr>
        <td class="code required"><label for="mcustomer0.17335712786118562">customer</label></td>
        <td>
          <input class="parameter required" minlength="1" name="customer" placeholder="(required)" id="mcustomer0.17335712786118562" type="text" value="">
        </td>
        <td>
          <strong><span class="markdown"></span></strong>
        </td>
        <td>path</td>
        <td><span class="model-signature">string</span></td>
      </tr>
    </tbody>
  </table>
  <div class="sandbox_header">
    <input class="submit" type="submit" value="Try it out!" data-sw-translate="">
    <a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
    <span class="response_throbber" style="display:none"></span>
  </div>
</form>

<form accept-charset="UTF-8" class="sandbox">
  <div style="margin:0;padding:0;display:inline"></div>
  <h4 data-sw-translate="">Parameters</h4>
  <table class="fullwidth parameters">
    <thead>
      <tr>
        <th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
        <th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
        <th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
        <th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
        <th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
      </tr>
    </thead>
    <tbody class="operation-params">
      <tr>
        <td class="code required"><label for="mcustomer0.011587492846318881">customer</label></td>
        <td>
          <input class="parameter required" minlength="1" name="customer" placeholder="(required)" id="mcustomer0.011587492846318881" type="text" value="">
        </td>
        <td>
          <strong><span class="markdown"></span></strong>
        </td>
        <td>path</td>
        <td><span class="model-signature">string</span></td>
      </tr>
    </tbody>
  </table>
  <div class="sandbox_header">
    <input class="submit" type="submit" value="Try it out!" data-sw-translate="">
    <a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
    <span class="response_throbber" style="display:none"></span>
  </div>
</form>

<form accept-charset="UTF-8" class="sandbox">
  <div style="margin:0;padding:0;display:inline"></div>
  <h4 data-sw-translate="">Parameters</h4>
  <table class="fullwidth parameters">
    <thead>
      <tr>
        <th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
        <th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
        <th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
        <th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
        <th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
      </tr>
    </thead>
    <tbody class="operation-params">
      <tr>
        <td class="code required"><label for="mcustomer0.04051154590935924">customer</label></td>
        <td>
          <input class="parameter required" minlength="1" name="customer" placeholder="(required)" id="mcustomer0.04051154590935924" type="text" value="">
        </td>
        <td>
          <strong><span class="markdown"></span></strong>
        </td>
        <td>path</td>
        <td><span class="model-signature">string</span></td>
      </tr>
    </tbody>
  </table>
  <div class="sandbox_header">
    <input class="submit" type="submit" value="Try it out!" data-sw-translate="">
    <a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
    <span class="response_throbber" style="display:none"></span>
  </div>
</form>

<form accept-charset="UTF-8" class="sandbox">
  <div style="margin:0;padding:0;display:inline"></div>
  <h4 data-sw-translate="">Parameters</h4>
  <table class="fullwidth parameters">
    <thead>
      <tr>
        <th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
        <th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
        <th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
        <th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
        <th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
      </tr>
    </thead>
    <tbody class="operation-params">
      <tr>
        <td class="code required"><label for="mcustomer0.8599395946520314">customer</label></td>
        <td>
          <input class="parameter required" minlength="1" name="customer" placeholder="(required)" id="mcustomer0.8599395946520314" type="text" value="">
        </td>
        <td>
          <strong><span class="markdown"></span></strong>
        </td>
        <td>path</td>
        <td><span class="model-signature">string</span></td>
      </tr>
    </tbody>
  </table>
  <div class="sandbox_header">
    <input class="submit" type="submit" value="Try it out!" data-sw-translate="">
    <a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
    <span class="response_throbber" style="display:none"></span>
  </div>
</form>

Text Content

swagger
Explore

Citrix.CloudServices.Messaging.Api



 * ENDPOINTS
   
    * Show/Hide
    * List Operations
    * Expand Operations
   
   
   * * POST /{CUSTOMER}/ENDPOINTS/{ENDPOINT}
       
        * Sends a message to an endpoint in the context of a given customer.
       
       RESPONSE CLASS (STATUS 200)
       
       OK
       
        * Model
        * Example Value
       
       Inline Model {}
       
       {}
       
       
       Response Content Type application/json text/json
       
       PARAMETERS
       
       Parameter Value Description Parameter Type Data Type endpoint
       
       The target endpoint.
       
       path string customer path string message.headers
       
       Optional message headers.
       
       query Array[] message.payload.position query long
       message.payload.readTimeout query integer message.payload.writeTimeout
       query integer
       
       Hide Response
       
       CURL
       
       
       
       REQUEST URL
       
       
       
       RESPONSE BODY
       
       
       
       RESPONSE CODE
       
       
       
       RESPONSE HEADERS
       
       
   
   
   * * GET /{CUSTOMER}/ENDPOINTS/CONNECT
       
        * Initiate web socket connection with client
       
       RESPONSE CLASS (STATUS 200)
       
       OK
       
        * Model
        * Example Value
       
       Inline Model {}
       
       {}
       
       
       Response Content Type application/json text/json
       
       PARAMETERS
       
       Parameter Value Description Parameter Type Data Type customer path string
       
       Hide Response
       
       CURL
       
       
       
       REQUEST URL
       
       
       
       RESPONSE BODY
       
       
       
       RESPONSE CODE
       
       
       
       RESPONSE HEADERS
       
       
   
   
   * * GET /{CUSTOMER}/ENDPOINTS/CONNECTURL
       
        * return connect url
       
       RESPONSE CLASS (STATUS 200)
       
       OK
       
        * Model
        * Example Value
       
       Citrix.CloudServices.Messaging.Api.Models.MessagingConnectResponse {
       messagingConnectUrl (string, optional):
       }
       
       {
         "messagingConnectUrl": "string"
       }
       
       
       Response Content Type application/json text/json
       
       PARAMETERS
       
       Parameter Value Description Parameter Type Data Type customer path string
       
       Hide Response
       
       CURL
       
       
       
       REQUEST URL
       
       
       
       RESPONSE BODY
       
       
       
       RESPONSE CODE
       
       
       
       RESPONSE HEADERS
       
       
   
   
   * * POST /{CUSTOMER}/ENDPOINTS
       
        * return if it is websocket request or not
       
       RESPONSE CLASS (STATUS 200)
       
       boolean
       
       
       Response Content Type application/json text/json
       
       PARAMETERS
       
       Parameter Value Description Parameter Type Data Type customer path string
       
       Hide Response
       
       CURL
       
       
       
       REQUEST URL
       
       
       
       RESPONSE BODY
       
       
       
       RESPONSE CODE
       
       
       
       RESPONSE HEADERS
       
       


 * HEALTHCHECK
   
    * Show/Hide
    * List Operations
    * Expand Operations
   
   
   * * GET /{CUSTOMER}/STATUS/CONNECT
       
        * Verifies the service is reachable.
       
       RESPONSE CLASS (STATUS 200)
       
       boolean
       
       
       Response Content Type application/json text/json
       
       PARAMETERS
       
       Parameter Value Description Parameter Type Data Type customer path string
       
       Hide Response
       
       CURL
       
       
       
       REQUEST URL
       
       
       
       RESPONSE BODY
       
       
       
       RESPONSE CODE
       
       
       
       RESPONSE HEADERS
       
       
   
   
   * * GET /{CUSTOMER}/STATUS/UP
       
        * Verifies that the dependencies required for this service are
          available.
       
       RESPONSE CLASS (STATUS 200)
       
       OK
       
        * Model
        * Example Value
       
       Inline Model {}
       
       {}
       
       
       Response Content Type application/json text/json
       
       PARAMETERS
       
       Parameter Value Description Parameter Type Data Type customer path string
       
       Hide Response
       
       CURL
       
       
       
       REQUEST URL
       
       
       
       RESPONSE BODY
       
       
       
       RESPONSE CODE
       
       
       
       RESPONSE HEADERS
       
       
   
   
   * * GET /{CUSTOMER}/STATUS/INSTANCE/READINESS
       
        * Verifies that the critical dependencies required for this service are
          available.
       
       RESPONSE CLASS (STATUS 200)
       
       OK
       
        * Model
        * Example Value
       
       Inline Model {}
       
       {}
       
       
       Response Content Type application/json text/json
       
       PARAMETERS
       
       Parameter Value Description Parameter Type Data Type customer path string
       
       Hide Response
       
       CURL
       
       
       
       REQUEST URL
       
       
       
       RESPONSE BODY
       
       
       
       RESPONSE CODE
       
       
       
       RESPONSE HEADERS
       
       


 * PING
   
    * Show/Hide
    * List Operations
    * Expand Operations
   
   
   * * GET /{CUSTOMER}/PING
       
        * Service ping.
       
       RESPONSE CLASS (STATUS 200)
       
       boolean
       
       
       Response Content Type application/json text/json
       
       PARAMETERS
       
       Parameter Value Description Parameter Type Data Type customer path string
       
       Hide Response
       
       CURL
       
       
       
       REQUEST URL
       
       
       
       RESPONSE BODY
       
       
       
       RESPONSE CODE
       
       
       
       RESPONSE HEADERS
       
       

[ BASE URL: , API VERSION: V1 ]