PublishEntities

Create or update one or more entities rapidly using PublishEntities, which doesn’t return error messages for invalid entities or provide server feedback. When publishing entities, only your integration can modify or delete those entities; other sources, such as the UI or other integrations, can’t. When you use PublishEntities, you gain higher throughput at the expense of receiving no server responses or validation. In addition, due to gRPC stream mechanics, you risk losing messages queued on the outgoing gRPC buffer if the stream connection is lost prior to the messages being sent. If you need validation responses, are developing in testing environments, or have lower entity update rates, use PublishEntity.

PublishEntitiesRequest

Stream Request
This endpoint expects an object.
entityobject

Sends a stream of entity objects to create or update. Each entity requires the following fields:

  • entity_id: Unique string identifier. Can be a Globally Unique Identifier (GUID).
  • expiry_time: Expiration time that must be greater than the current time and less than 30 days in the future. The Entities API will reject any entity update with an expiry_time in the past. When the expiry_time has passed, the Entities API will delete the entity from the COP and send a DELETE event.
  • is_live: Boolean that when true, creates or updates the entity. If false and the entity is still live, triggers a DELETE event.
  • provenance.integration_name: String that uniquely identifies the integration responsible for publishing the entity.
  • provenance.data_type.
  • provenance.source_update_time. This can be earlier than the RPC call if the data entered is older.
  • aliases.name: Human-readable string that represents the name of an entity.
  • ontology.template For additional required fields that are determined by template, see com.anduril.entitymanager.v1.Template. If an entity_id is provided, the entity updates. If no entity_id is provided, the entity is created.

PublishEntitiesResponse

Response
This endpoint returns an object.