API DocsRESTProtobuf descriptor service

AddProtobufDescriptor

Used to register a protobuf message to be ingested.

POST
/api/v1/protobuf-descriptors:add

Query Parameters

protobufDescriptor.messageTypeFullNamestring

protobufDescriptor.fileDescriptorSetstring

Format: "byte"

protobufDescriptor.protoFileNamestring

protobufDescriptor.namespacestring

protobufDescriptor.protobufDescriptorIdstring

organizationIdstring

organization_id is deprecated

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/v1/protobuf-descriptors:add?protobufDescriptor.messageTypeFullName=string&protobufDescriptor.fileDescriptorSet=string&protobufDescriptor.protoFileName=string&protobufDescriptor.namespace=string&protobufDescriptor.protobufDescriptorId=string&organizationId=string&forceDuplicateRegistration=true" \
  -H "Authorization: Bearer <API_KEY>"

A successful response.

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

Previous

Ping Service_ Ping GET

Next

DeleteProtobufDescriptors DELETE