Turbine Labs

Turbine Labs API

The Turbine Labs API provides CRUD operations for core object types, and is mostly RESTy. The easiest way to interact with the API is with…

Developer tools#openapi#cloud

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

The Turbine Labs API provides CRUD operations for core object types, and is
mostly RESTy. The easiest way to interact with the API is with
tbnctl.
If you want to make direct HTTP calls, however, you can obtain an access
token using tbnctl, and then pass it in the Authorization header,
prefixed by Token :

curl -H "Authorization: Token  " https://api.turbinelabs.io/v1.0/cluster

Endpoints 44

Zone

  • GETget a list of zones/zone?filters=stringGet all zones. possibly with filters
  • POSTcreate zone/zoneCreate a new zone.
  • GETget zone/zone/:zoneKeyGet details for a single zone
  • DELETEdelete zone/zone/:zoneKey?checksum=9cd24183-f848-48f8-6f55-0f07240700b9Delete a zone.

Proxy

  • GETlist proxies/proxy?filters=stringGet a list of proxies
  • POSTcreate proxy/proxyCreate a new proxy
  • GETget proxy/proxy/:proxyKeyGet details for a single proxy
  • DELETEdelete proxy/proxy/:proxyKey?checksum=9cd24183-f848-48f8-6f55-0f07240700b9Delete existing proxy

Listener

  • GETlist listeners/listener?filters=stringGet a list of listeners
  • POSTcreate listener/listenerCreate a new listener
  • GETget listener/listener/:listenerKeyGet details for a single listener
  • PUTmodify listener/listener/:listenerKeyModify an existing listener
  • DELETEdelete listener/listener/:listenerKey?checksum=9cd24183-f848-48f8-6f55-0f07240700b9Delete existing listener

Domain

  • GETget domains/domain?filters=stringGet a list of domains
  • POSTcreate domain/domainCreate a new domain
  • GETget domain/domain/:domainKeyGet details for a single domain
  • DELETEdelete domain/domain/:domainKey?checksum=9cd24183-f848-48f8-6f55-0f07240700b9Delete an existing domain

Route

  • GETget routes/route?filters=stringGet a list of routes
  • POSTcreate route/routeCreate a new route
  • GETget route/route/:routeKeyGet details for an existing route
  • PUTmodify route/route/:routeKeyModify an existing route
  • DELETEdelete route/route/:routeKey?checksum=9cd24183-f848-48f8-6f55-0f07240700b9Delete an existing route
  • DELETEdelete shared_rules object/shared_rules/:sharedRulesKey?checksum=9cd24183-f848-48f8-6f55-0f07240700b9Delete an existing shared_rules object

Shared Rules

  • GETget shared_rules/shared_rules?filters=stringGet a list of shared_rules
  • POSTcreate shared_rules/shared_rulesCreate a new shared_rules object
  • GETget shared_rules object/shared_rules/:sharedRulesKeyGet details for an existing shared_rules object
  • PUTmodify shared_rules object/shared_rules/:sharedRulesKeyModify an existing shared_rules object

Cluster

  • GETget clusters/cluster?filters=stringGet a list of clusters
  • POSTcreate cluster/clusterCreate a new cluster
  • GETget cluster/cluster/:clusterKeyGet details for an existing cluster
  • PUTmodify cluster/cluster/:clusterKeyModify an existing cluster
  • DELETEdelete cluster/cluster/:clusterKey?checksum=9cd24183-f848-48f8-6f55-0f07240700b9Delete an existing cluster
  • POSTadd instance/cluster/:clusterKey/instancesAdd a new instance to a cluster
  • DELETEremove instance/cluster/:clusterKey/instances/:instanceIdentifier?checksum=9cd24183-f848-48f8-6f55-0f07240700b9Remove an instance from a cluster

Audit Log

  • GETAllows an arbitrary filter to be specified and applied to the org\'s change log./changelog/adhoc?filter=stringPerform an adhoc query against the change log for your org. The filter is a JSON encoded FilterSum as defined in this file.
  • GETget changes related to the indicated cluster/changelog/cluster-graph/:clusterKey?start=0.0&end=0.0&max_results=0.0&ref_id=string&direction=beforeGets all changes to a cluster.
  • GETget changes related to the indicated domain/changelog/domain-graph/:domainKey?start=0.0&end=0.0&max_results=0.0&ref_id=string&direction=beforeGets all changes to a domain, the proxies that front the specified domain, routes within that domain, the shared rules of each route, the clusters connected…
  • GETget changes related to the indicated route/changelog/route-graph/:routeKey?start=0.0&end=0.0&max_results=0.0&ref_id=string&direction=beforeGets all changes to a route, the domains associated with it, the shared rules it references, and the clusters connected to it.
  • GETget changes related to the indicated SharedRules/changelog/shared-rules-graph/:sharedRulesKey?start=0.0&end=0.0&max_results=0.0&ref_id=string&direction=beforeGets all changes associated with set of Shared Rules; the domains using it and the clusters referenced by it.
  • GETget changes in a specified zone/changelog/zone/:zoneKey?start=0.0&end=0.0&max_results=0.0&ref_id=string&direction=beforeRetrieve all changes in the specified zone.

User Management

  • GETReturns the user object for the account authorized and making this request./admin/user/selfRequest the user object for an authorized requesting account.
  • DELETEDelete the specified access token./admin/user/self/access_token/:access-token-key?checksum=9cd24183-f848-48f8-6f55-0f07240700b9
  • GETLists Access Tokens that are configured for the authenticated user./admin/user/self/access_tokens
  • POSTCreates a new Access Token and associates it with the authenticated user./admin/user/self/access_tokens

API details

Base URL
https://api.turbinelabs.io/v1.0
Authentication
An API key in the Authorization header
Operations
44 operations on 25 pathsGET 22POST 9DELETE 9PUT 4
Main resources
Cluster 7Audit Log 6Route 6Listener 5Domain 4Proxy 4Shared Rules 4User Management 4Zone 4
Response formats
application/json
Description format
Swagger 2.0, API version 1.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Turbine Labs API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Turbine Labs API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “get a list of zones” (GET /zone?filters=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Turbine Labs API?

The Turbine Labs API provides CRUD operations for core object types, and is mostly RESTy. The easiest way to interact with the API is with… It is listed under Developer tools and has 44 endpoints.

Who publishes the Turbine Labs API?

It is listed from Turbine Labs's public API description (an OpenAPI document), not published by Turbine Labs on Swastik Codes. Anyone who controls turbinelabs.io can claim the profile by adding a DNS TXT record.

What is the base URL of the Turbine Labs API?

Requests go to https://api.turbinelabs.io/v1.0. Endpoint paths are added to this base URL.

How do I authenticate with the Turbine Labs API?

With an API key in the Authorization header.

How many endpoints does the Turbine Labs API have?

44 operations on 25 paths (22 GET, 9 POST, 9 DELETE, 4 PUT). The largest groups are Cluster, Audit Log, Route, Listener.

Is forking the Turbine Labs API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.