API DocsRESTProtobuf descriptor service

ListProtobufDescriptors

Retrieve protobuf descriptors using an optional filter.

GET
/api/v1/protobuf-descriptors

Query Parameters

organizationIdstring

organization_id is deprecated

pageSizeinteger

The maximum number of protobuf descriptors to return. The service may return fewer than this value. If unspecified, at most 50 protobuf descriptors will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

Format: "int64"

pageTokenstring

A page token, received from a previous ListProtobufDescriptors call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListProtobufDescriptors must match the call that provided the page token.

filterstring

A Common Expression Language (CEL) filter string. Available fields to filter by are protobuf_descriptor_id, proto_file_name, namespace, and message_type_full_name. For further information about how to use CELs, please refer to this guide. For more information about the fields used for filtering, please refer to this definition. Optional.

curl -X GET "<API_URL>/api/v1/protobuf-descriptors?organizationId=string&pageSize=0&pageToken=string&filter=string" \
  -H "Authorization: Bearer <API_KEY>"

A successful response.

{
  "protobufDescriptors": [
    {
      "messageTypeFullName": "string",
      "fileDescriptorSet": "string",
      "protoFileName": "string",
      "namespace": "string",
      "protobufDescriptorId": "string"
    }
  ],
  "nextPageToken": "string"
}

Previous

DeleteProtobufDescriptors DELETE

Next

BatchDeleteRemoteFiles POST