gRPCanduril.entitymanager.v1EntityManagerAPI

PublishEntity

Create or update an entity and get a response confirming whether the Entity Manager API succesfully processes the entity. Ideal for testing environments. When publishing an entity, only your integration can modify or delete that entity; other sources, such as the UI or other integrations, can’t. If you’re pushing entity updates so fast that your publish task can’t keep up with your update rate (a rough estimate of >= 1 Hz), use the PublishEntities request instead.

PublishEntityRequest

Request
This endpoint expects an object.
entityobject

Create or update an entity. Required 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, Entity Manager updates the entity. If no entity_id is provided, it creates an entity.

PublishEntityResponse

Response
This endpoint returns an object.