Syndeia Cloud's REST API is published using Swagger which provides a platform for interactive documentation - learn about the REST endpoints and also try them out directly in the documentation.

Accessing REST API documentation

Open a web browser to port 9000 of the root of your Syndeia Cloud instance, ex: http://myhost.mydomain.com:9000. You should see a web page like the one below. If you do not see the web page below, it implies that your Syndeia Cloud server is not running. Contact your Syndeia administrator. Click on the API icon ("REST API Swagger Documentation").

Once you log in with your Syndeia username and password, you will be redirected to the Syndeia Cloud 3.3 Home Page. The link to the Swagger documentation is available on this page in the bar on the left as highlighted below. Click on the API option as shown below.

The Swagger REST API Documentation page should open as shown below. The REST endpoints are organized based on the simple conceptual model presented in the previous section (see here).

Making REST API requests through Swagger

The first step in making REST API requests is to sign-in. You should have an account on the Syndeia Cloud sever. If not, request your admin to create an account for you before proceeding further.

The sign-in request authenticates the user and returns a token if succesful. The token is then used for every REST API request to the Syndeia Cloud server. Follow the steps below to sign-in and register the token so that you do not have to specify it for each request.

1. Click on POST /signIn button under the Auth category.

2. Click the Try it out button on the right-hand side (RHS). The "User info for signIn" fields should show up.

3. Click the Edit button. The field should now become editable.

4. Fill out your account credentials.

5. Click the blue Execute button.

6. If successful, you should receive an HTTP 200 response back with JSON data. If there was a form error, you should receive an HTTP 4XX response back with an appropriate error message.

7. Select and copy the token JSON string into the clipboard

8. Click the Authorize button at the top of the page (RHS), a popup screen should show.

9. Paste the copied token (previous step) in the Value field, and then click the Authorize button, followed by clicking the Done button.

10. Now you should be able to use any of the other API endpoints on the page and have your token automatically submitted with your requests.

Browser not supported