How to use the API
The API has its own user interface accessible from a web browser. This is an easy way to see resources, perform actions, and see the equivalent cURL or HTTP request & response. To access it:
- Click on your user avatar in the upper right corner.
- Click Account & API Keys.
- Under the API Keys section, find the API Endpoint field and click the link. The link will look something like
<RANCHER_FQDN>is the fully qualified domain name of your Rancher deployment.
Go to the URL endpoint at
<RANCHER_FQDN> is the fully qualified domain name of your Rancher deployment.
API requests must include authentication information. Authentication is done with HTTP basic authentication using API Keys. API keys can create new clusters and have access to multiple clusters via
/v3/clusters/. Cluster and project roles apply to these keys and restrict what clusters and projects the account can see and what actions they can take.
By default, some cluster-level API tokens are generated with infinite time-to-live (
ttl=0). In other words, API tokens with
ttl=0 never expire unless you invalidate them. For details on how to invalidate them, refer to the API tokens page.
The API is generally RESTful but has several features to make the definition of everything discoverable by a client so that generic clients can be written instead of having to write specific code for every type of resource. For detailed info about the generic API spec, see here.
Every type has a Schema which describes:
- The URL to get to the collection of this type of resources
- Every field the resource can have, along with their type, basic validation rules, whether they are required or optional, etc.
- Every action that is possible on this type of resource, with their inputs and outputs (also as schemas).
- Every field that filtering is allowed on
- What HTTP verb methods are available for the collection itself, or for individual resources in the collection.
So the theory is that you can load just the list of schemas and know everything about the API. This is in fact how the UI for the API works, it contains no code specific to Rancher itself. The URL to get Schemas is sent in every HTTP response as a
X-Api-Schemasheader. From there you can follow the
collectionlink on each schema to know where to list resources, and other
linksinside of the returned resources to get any other information.
In practice, you will probably just want to construct URL strings. We highly suggest limiting this to the top-level to list a collection (
/v3/<type>) or get a specific resource (
/v3/<type>/<id>). Anything deeper than that is subject to change in future releases.
Resources have relationships between each other called links. Each resource includes a map of
linkswith the name of the link and the URL to retrieve that information. Again you should
GETthe resource and then follow the URL in the
linksmap, not construct these strings yourself.
Most resources have actions, which do something or change the state of the resource. To use these, send a HTTP
POSTto the URL in the
actionsmap for the action you want. Some actions require input or produce output, see the individual documentation for each type or the schemas for specific information.
To edit a resource, send a HTTP
links.updatelink on the resource with the fields that you want to change. If the link is missing then you don’t have permission to update the resource. Unknown fields and ones that are not editable are ignored.
To delete a resource, send a HTTP
links.removelink on the resource. If the link is missing then you don’t have permission to update the resource.
To create a new resource, HTTP
POSTto the collection URL in the schema (which is
Most collections can be filtered on the server-side by common fields using HTTP query parameters. The
filters map shows you what fields can be filtered on and what the filtered values were for the request you made. The API UI has controls to setup filtering and show you the appropriate request. For simple “equals” matches it’s just
field=value. Modifiers can be added to the field name, e.g.
field_gt=42 for “field is greater than 42”. See the API spec for full details.
Most collections can be sorted on the server-side by common fields using HTTP query parameters. The
sortLinks map shows you what sorts are available, along with the URL to get the collection sorted by that. It also includes info about what the current response was sorted by, if specified.
API responses are paginated with a limit of 100 resources per page by default. This can be changed with the
limit query parameter, up to a maximum of 1000, e.g.
pagination map in collection responses tells you whether or not you have the full result set and has a link to the next page if you do not.
Capturing Rancher API Calls
You can use browser developer tools to capture how the Rancher API is called. For example, you could follow these steps to use the Chrome developer tools to get the API call for provisioning an RKE cluster:
- In the Rancher UI, go to Cluster Management and click Create.
- Click one of the cluster types. This example uses Digital Ocean.
- Fill out the form with a cluster name and node template, but don’t click Create.
- You will need to open the developer tools before the cluster creation to see the API call being recorded. To open the tools, right-click on the Rancher UI and click Inspect.
- In the developer tools, click the Network tab.
- On the Network tab, make sure Fetch/XHR is selected.
- In the Rancher UI, click Create. In the developer tools, you should see a new network request with the name
cluster?_replace=trueand click Copy > Copy as cURL.
- Paste the result into any text editor. You will be able to see the POST request, including the URL it was sent to, all of the headers, and the full body of the request. This command can be used to create a cluster from the command line. Note: The request should be stored in a safe place because it contains credentials.