Cato Networks Knowledge Base

Search

Cato API Schema

Overview of Cato API Schema

Cato regularly updates the schema for the Cato API, and adds new fields and parameters. The new updated versions of the schema have no impact on accounts that continue to use previous versions. 

Note: If there is a new version of the schema that is incompatible with previous versions, then Cato will notify customers at least 3 months in advance before making the change.

The GQL file attached to this article is the latest version of the GraphQL schema for the Cato API.

Please click Follow to automatically receive email notifications for updates to the Cato API schema.

Was this article helpful?

4 out of 8 found this helpful

Comments

10 comments

Date Votes
  • Comment author
    Yaakov Simon
    • Edited

    October 7, 2020 - Updated the schema:

    • accountMetrics/accountSnapshot > Sites > SiteInfo - added region and countryName
    • accountSnapshot > Sites > Devices > Interfaces - updated tunnelRemoteIPInfo, recentConnections
    • accountSnapshot > users - VPN users information and metrics
    0
  • Comment author
    Yaakov Simon

    November 3, 2020 - Released v. 16 of the API schema with these changes:

    • Added scalar version to the beginning of the schema with the version number as a comment
    • Added jitterUpstream and jitterDownstream fields to accountMetrics
    0
  • Comment author
    Yaakov Simon

    December 23, 2020 - Released v. 32 of the API schema

    0
  • Comment author
    Yaakov Simon

    January 3, 2021 - Released v. 34 of the API schema

    0
  • Comment author
    Yaakov Simon

    Feb 17, 2021 - Released v.40 of the API schema 

    0
  • Comment author
    Yaakov Simon

    January 2, 2023 - Uploaded newest version of the API schema

    0
  • Comment author
    Yaakov Simon

    January, 31, 2023 - Uploaded newest version of the API schema

    0
  • Comment author
    Ricardo Perez
    • Edited

    Hi Yaakov,

    I was trying to generate a Python model based on the provided schema, 45 version, and I am receiving the following error:

    TypeError: Field 'Query.appStats' can only be defined once.

    Checking the schema I found

        """Beta"""
      appStats(
        """Account ID"""
        accountID: ID!
        timeFrame: TimeFrame!
        measures: [EventsMeasure]
        dimensions: [EventsDimension]
        filters: [EventsFilter!]
      ): EventsTimeSeries

    When changed to (or removed completely)

        """Beta"""
      EventsTimeSeries(
        """Account ID"""
        accountID: ID!
        timeFrame: TimeFrame!
        measures: [EventsMeasure]
        dimensions: [EventsDimension]
        filters: [EventsFilter!]
      ): EventsTimeSeries

    Does not produce errors.
    I am currently using sgqlc 13 for creating the model.
    The schema version 41 works correctly with this version of sgqlc.

    Is it possible that the new schema version requires other tool/modification ?

    Thank you!

    0
  • Comment author
    Yaakov Simon

    Ricardo Perez On Jan 31 we uploaded a new version of the API schema which is version 44. I searched the schema and there is no match for Beta, and Support confirmed that this new version works correctly.

    Thanks for your comment and patience!

    Yaakov

    0
  • Comment author
    Thomas Jongerius

    Yaakov Simon, today I see an inconsistency on the API version on this page and the new reference on https://api.sta.catonet.works/documentation/#introduction (https://api.catonetworks.com/api/schema ) can you confirm what is running in production?

    0

Please sign in to leave a comment.