View API documentation (YAML file) Skip Navigation

View API documentation (YAML file)

This example uses the Swagger UI editor to view the
CylanceON-PREM
YAML file.
The purpose of the YAML file is to generate the Curl command or Request URL with your selected parameters. The file does not include logic required to test the API in Swagger.
  1. Download the
    CylanceON-PREM
    YAML file:
    1. Log in to your
      CylanceON-PREM
      Console.
    2. Select
      Configuration > Applications
      .
    3. Click the
      API Documentation
      link. The API documentation opens in a new browser window.
    4. Right-click on the documentation and select
      Save as
      to download the
      api-docs.yaml
      file.
  2. Open the
    api-docs.yaml
    file in an editor, such as Notepad ++. Add your
    CylanceON-PREM
    fully qualified domain name (FQDN) to the URLs under
    servers
    . The image below uses
    login.onprem-cylance.com
    as the hostname.
  3. Save the api-docs.yml file.
  4. Open a web browser and type in http://editor.swagger.io. The Swagger Editor displays.
  5. Select
    File > Import file
    , select the api-docs.yml file, then click
    Open
    . Your updated YAML file is displayed in the Swagger Editor.
  6. To view the API documentation click an API, such as Get Devices to view its parameters and responses.
  7. (Optional) To generate the web service endpoint with your selected parameters:
    1. Under Servers, select
      /cyapi/v1
      for the OAuth Access Token API, or select
      /cyapi/v1/client
      for all other API requests.
    2. Click on
      Try it out
      to enable adding any parameter updates you want to include in the request.
    3. Update or add any parameters by selecting options.
    4. Update the request body with your values for POST and PATCH requests.
    5. Scroll to the end of the parameters, then click
      Execute
      . The Curl command and Request URL display:
      The Server Response will return Failed to Fetch. The purpose of the YAML file is to generate the Curl command or Request URL. The file does not include logic required to test the API in Swagger.
  8. You can now use these commands to update your
    CylanceON-PREM
    appliance from the API.