Export to OpenAPI specification

  • Freigeben Version: Australia
  • Aktualisiert 12. März 2026
  • 1 Minute Lesedauer

    • Export a REST API as an OpenAPI specification to import it into another web services tool.

    Vorbereitungen

    Role required: web_service_admin, rest_api_explorer, or admin

    Prozedur

    1. Navigate to All > System Web Services > REST > REST API Explorer.
    2. Select the API you want to export.
      For example, use these choices to select the Table API for export.
      Field Value
      Namespace now
      API Name Table API
      API Version latest
    3. Below the list of API methods, select the link for the export format you want to use.
      OptionBezeichnung
      Export OpenAPI Specification (YAML) Format the export in YAML.
      Export OpenAPI Specification (JSON) Format the export in JSON.
      The browser displays a window to select a download location.
    4. Select the download location and file name.
    5. Save the file.

    Ergebnisse

    The system downloads the API in the format you selected.

    Nächste Maßnahme

    Import the API into a web services tool such as Postman or Insomnia.