cancel
Showing results for 
Search instead for 
Did you mean: 
Create a Post
Highlighted
phlrnnr
Copper

What is the recommended POST syntax for Gaia REST API?

Jump to solution

In sk143612, the syntax for a POST to the Gaia REST API is:

https://<your-server-ip>/gaia_api/<command>

However, the online documentation included once the Gaia API is installed shows the syntax as:

https://<server-ip>:<port>/gaia_api/v1/<command>

                           

What is the recommended syntax?  With the /v1/ or without?

Thanks!

Tags (4)
1 Solution

Accepted Solutions
Admin
Admin

Re: What is the recommended POST syntax for Gaia REST API?

Jump to solution

I am going to recommend with v1 and here's why: upgrades to the API.

If you use the version number in the API call, you should always get the same behavior, even as the API is updated.

If you don't include the version number, I believe it will always default to the latest version, which may change behavior as the API evolves.

1 Reply
Admin
Admin

Re: What is the recommended POST syntax for Gaia REST API?

Jump to solution

I am going to recommend with v1 and here's why: upgrades to the API.

If you use the version number in the API call, you should always get the same behavior, even as the API is updated.

If you don't include the version number, I believe it will always default to the latest version, which may change behavior as the API evolves.