Sift | Docs
APIReferenceREST (HTTP/JSON)Protobuf descriptor service

AddProtobufDescriptor

Used to register a protobuf message to be ingested.

POST
/api/v2/protobuf-descriptors:add

Request Body

application/jsonRequired

protobufDescriptorobject

forceDuplicateRegistrationboolean

If set to true, the service will ignore checks that this descriptor has already been registered and will ensure that it is registered as the latest proto descriptor for the message type.

curl -X POST "<API_URL>/api/v2/protobuf-descriptors:add" \
  -H "Authorization: Bearer <API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "protobufDescriptor": {
      "messageTypeFullName": "string",
      "fileDescriptorSet": "string",
      "protoFileName": "string",
      "namespace": "string",
      "protobufDescriptorId": "string"
    },
    "forceDuplicateRegistration": true
  }'

A successful response.

{
  "protobufDescriptor": {
    "messageTypeFullName": "string",
    "fileDescriptorSet": "string",
    "protoFileName": "string",
    "namespace": "string",
    "protobufDescriptorId": "string"
  }
}

Previous

AddProtobufDescriptor POST

Next

CheckProtobufDescriptorCompatibility POST