Reference: Stability index updates

API Gateway schema fields are indexed to a level of stability, which correlates with the level of support and maintenance Tanium provides for that field.

Stability level Description Support provided

0 - Deprecated

Deprecated fields stop receiving support. Fields might be deprecated in favor of other fields for improved performance, functionality support, or other reasons. After 12 months from the initial announcement, deprecated fields receive support and maintenance for a minimum of six months. Starting with the next release after that six month period, deprecated fields might be removed from the API Gateway schema.
1.0 - Experimental (Early Development) Experimental fields in early development are not stable, and might change significantly as functionality is developed and tested. Experimental fields are subject to update or removal, without guarantee of backwards compatibility. After an evaluation period of indeterminate length, an experimental field's stability index might be updated and the field kept in the API Gateway schema, or the field might be removed from the API Gateway schema.
1.1 - Experimental (Active Development) Experimental fields in active development are not stable, and the implemented functionality is closer to meeting requirements than experimental fields in early development.
1.2 - Experimental (Release Candidate) Experimental fields as release candidate are not stable, and the functionality is ready for evaluation. Functionality or other changes might occur in response to the evaluation.
2 - Legacy Legacy fields are not actively developed. Alternative fields in the API Gateway schema provide improved functionality. Legacy fields receive support and maintenance for existing functionality, but do not receive ongoing feature functionality updates.
3 - Stable Stable fields have active support. Stable fields receive ongoing feature functionality updates as needed, and support and maintenance.

Fields are not required to advance sequentially through each stability, nor are they required to be indexed to each stability level.

For the best results, if a field's stability changes to 0 - Deprecated or 2 - Legacy, update your requests to replace the deprecated or legacy field with the recommended replacement.

August 2023 stability index changes

No fields changed stability in this release.

July 2023 stability index changes

This release introduces the stability index.

  • Existing fields in active support are changed to stability 3 - Stable.

  • Unless otherwise stated below, fields deprecated in prior releases are changed to stability 0 - Deprecated.

The following field is changed to stability 0 - Deprecated; support for this field ends February 2025.

Deprecated field Replacement field Notes
query.endpointLastSeen query.endpoints (filter: {path: id, op: EQ, value: "endpoint-id"}) and include query.endpoints.edges.node.eidLastSeen in the request

The query.endpointLastSeen (eids) argument does not map directly to a replacement argument. Instead, create a query.endpoints filter argument, using {path: id, op: EQ, value: "endpoint-id"} to filter the request to return selected endpoints based on ID, then also return query.endpoints.edges.node.eidLastSeen in the response to view an endpoint's last seen time.

For more information, see an endpoints query with an endpoint ID filter returning eidlastSeen example syntax.

The following fields are changed to stability 1.0 - Experimental (Early Development), 1.1 - Experimental (Active Development), or 1.2 - Experimental (Release Candidate).

Experimental field Notes
query.directConnectEndpoint.performance._dev_query (1.2 - Experimental (Release Candidate))  

The following fields are changed to stability 2 - Legacy.

Legacy field Replacement field Notes

mutation.closeDirectConnection

mutation.directConnectClose

The mutation.closeDirectConnection (input) argument maps one-to-one to the mutation.directConnectClose (input) argument.

For more information, see a mutation.directConnectClose example request.

mutation.killProcess

mutation.directConnectProcessTerminate

Certain arguments for mutation.killProcess (input) map one-to-one to mutation.directConnectProcessTerminate (input) arguments:

  • name
  • pid
  • signal

The mutation.killProcess (input: {connectionID: ID}) optional argument maps to the mutation.directConnectProcessTerminate (input: {connectionID: ID!} required argument.

The mutation.killProcess (input: {endpoint: {endpointID: ID}}) argument does not map directly to a replacement argument. Instead of passing an endpoint ID, pass an open connection ID in the mutation.directConnectProcessTerminate (input: {connectionID: ID!}) argument.

For more information, see a mutation.directConnectProcessTerminate example request.

mutation.openDirectConnection

mutation.directConnectOpen

The mutation.openDirectConnection (input {endpointID: ID}) optional argument maps to the mutation.directConnectOpen (input {endpointID: ID!}) required argument.

For more information, see a mutation.directConnectOpen example request.

mutation.pingDirectConnection

mutation.directConnectPing

The mutation.PingDirectConnection (input) argument maps one-to-one to the mutation.directConnectPing (input) argument.

For more information, see a mutation.directConnectPing example request.

query.directEndpoint

query.directConnectEndpoint

The query.directEndpoint (input: {endpointID: ID}) does not map directly to a replacement argument. Instead of passing an endpoint ID, pass an open connection ID in the query.directConnectEndpoint (input: {connectionID: ID!}) argument.

For more information, see a query.directConnectEndpoint.performance example request, a query.directConnectEndpoint.processes example request, or a query.directConnectEndpoint.alerts example request.