General Best Practices

Overview

To ensure forward compatibility of your integration with Tufin Orchestration Suite we recommend that you:

• Do not use unpublished APIs
• Do not directly access the internal PostgreSQL databases, for either retrieving or modifying data

You should never embed authentication information into your applications.

Group Members

When you retrieve a single network_object element or a single services element of the type group, the API response includes all the group members. This also occurs when you retrieve a list of network_objects or services and restrict the returned type to group.

To make more efficient API calls, set the optional show_members = false: The call will return only the names and IDs of the members.

show_members is available for the following APIs:

• Get network objects by device
• Get specific network object
• Get network objects by revision
• Get specific network objects by revision
• Get services by device
• Get specific service
• Get services by revision
• Get specific service by revision
  

To maintain full backwards compatibility, the default value of the show_members parameter is true.

Content Negotiation

TOS is compliant with the REST API standard (JAX_RS) 2.1, which is compliant with Java EE8. Compliance with the updated standards requires supporting more strongly typed content negotiation in our REST API. To prevent receiving HTTP error 415 (Unsupported Media Type) from the server, the REST client must specify the correct Content-Type and the Java client must provide the correct client.type.