TRY ME

Try Valo for free

We want to show you something amazing.

We'll send you a link to download a fully functional Valo copy to play with.



Great! Check your email and enjoy Valo



Apologies, we seem to be having a problem processing your input, please try again

URIs

Valo exposes its services via a RESTful API.

This means you can iteract with Valo services as if they were normal web resources - i.e. Valo services are accessible via HTTP and identified by URIs.

You may prefer to interact with Valo via one of the language specific SDKs. Even so resources are identified by URI so the content of this page is still relevant.

Placeholders

In the Valo API documentation, URI segments that begin with a ‘:’ character represent placeholders that you need to replace with your own value.

As an example if you read the Cluster API documentation you will see that URIs of the form /cluster/nodes/:name identify a cluster node.

Here :name is a placeholder for the name of a node. You choose this when adding a node to a Valo cluster.

So a valid URI for a cluster node might be /cluster/nodes/server27.

Tenants

Most URIs in the Valo API require you to specify a “tenant”. These URIs begin with: /:service/:tenant.

Tenants allow you to keep resources belonging to different owners seperate.

As an example, if you have a single Valo cluster deployed in your organisation, you might have seperate tenants for the “it” and “sales” departments.

In this case resources belonging to the “it” department would be located at URIs beginning with /:service/it and resources belonging to the “sales” department would be located at URIs beginning with /:service/sales.

Tenants must be explicitly created before they can be used. This is done via the Cluster API.

Collections

Many URIs in the Valo API require to you specify a “collection”. These URIs begin with: /:service/:tenant/:collection.

Collections allow you to keep resources logically grouped.

Continuing the previous example, the “it” department might manage both “windows” and “linux” servers.

In this case resources related to “windows” servers would be located at URIs beginning with /:service/it/windows and resources related to “linux” servers would be located at URIs beginning with /:service/it/linux.

Collections do not require explicit creation.

Stream URIs

As Streams are the most commonly used resource in Valo we have a page dedicated to Stream URIs.