Zipkin API
Zipkin's v2 API currently includes a POST endpoint that can receive spans.
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Zipkin's v2 API currently includes a POST endpoint that can receive spans.
Endpoints 9
- GETGET /services
/servicesReturns a list of all service names associated with span endpoints. - GETGET /spans
/spans?serviceName=stringGet all the span names recorded by a particular service - POSTUploads a list of spans encoded per content-type, for example json.
/spans - GETGET /traces
/tracesInvoking this request retrieves traces matching the below filters. Results should be filtered against endTs, subject to limit and lookback. For example, if… - GETGET /trace/{traceId}
/trace/:traceId - GETGET /traceMany
/traceMany?traceIds=stringInvoking this request retrieves any traces with the specified IDs. Results return in any order, and can be empty. Use /trace/{traceId} to request a single… - GETGET /dependencies
/dependencies?endTs=0Returns service links derived from spans. - GETGET /autocompleteKeys
/autocompleteKeysReturns a subset of keys from Span.tags configured for value autocompletion. This helps sites populate common keys into the annotationQuery parameter of the… - GETGET /autocompleteValues
/autocompleteValues?key=stringReturns all known values of Span.tags for the given autocomplete key. Refer to the description of /autocompleteKeys for the use case.
API details
- Base URL
https://localhost:9411/api/v2- Authentication
- None declared in the description
- Operations
- 9 operations on 8 pathsGET 8POST 1
- Description format
- Swagger 2.0, API version
2 - Links
- OpenAPI document
- Listed from
- Zipkin's published OpenAPI description (openzipkin/zipkin-api) (Apache-2.0)
How to test the Zipkin API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Zipkin API collection, without the publisher's secrets.
- Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
- Send a requestPick an endpoint, for example “GET /services” (GET /services), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Zipkin API?
Zipkin's v2 API currently includes a POST endpoint that can receive spans. It is listed under Developer tools and has 9 endpoints.
Who publishes the Zipkin API?
It is listed from Zipkin's public API description (an OpenAPI document), not published by Zipkin on Swastik Codes. Anyone who controls zipkin.io can claim the profile by adding a DNS TXT record.
What is the base URL of the Zipkin API?
Requests go to https://localhost:9411/api/v2. Endpoint paths are added to this base URL.
How do I authenticate with the Zipkin API?
Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.
How many endpoints does the Zipkin API have?
9 operations on 8 paths (8 GET, 1 POST).
Is forking the Zipkin API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.