GraphQL API Stability Levels

APIs within LogScale are assigned a stability to indicate how much the API endpoint can be relied upon not to change. Below is a list of the GraphQL API specific stability levels, with explanations of each:

  • Long-Term indicates stability of at least 1 year. These are queries, mutations, and fields that are rarely changed. When significant changes are needed, often times a new function is created as a replacement — usually the same name, but with something like V2 at the end. The old function will be switched to Deprecated and will work for quite a long time.

  • Short-Term indicates stability of at least 12 weeks. These are functions and fields that are fairly stable, but may be modified based on feedback from CrowdStrike clients. At some point, they could be changed to Long-Term to indicate no further changes are expected.

  • Preview indicates it may change in the future before it's released. In fact, some functions may very experimental and may not have been tested enough. There may be problems with using them and relying on them in production. Also, they may be and often are changed to resolve problems or to provide better usage and results. Some preview functions and fields may need renaming or may be eliminated completely — without any notification to users. Use these preview queries, mutations and fields, cautiously.

  • Deprecated indicates the query, mutation, or field, or datatype is being eliminated. For these, the version in which it will be last available will be given. Since the GraphQL documentation is not versioned, whatever is in the documentation works now, and whatever is eliminated will no longer be found in the documentation. As a result, you should monitor the release notes for upcoming changes and migrate your code away from deprecated functions and fields, and use instead the recommended replacements.

Stability for endpoints, mutations, queries, and datatypes are highlighted on each page. They're located in a box below the Summary and Related section, right above the Syntax section.

Stability for individual fields of datatypes are noted in the tables on their documentation pages, or in the tables of the Input Parameters and Returned Values sections of query and mutation documentation pages. Fields for which stability are not indicated explicitly, look to the stability of the parent datatype, query or mutation: their stability will be applied to the children.