1. I wonder if my cell is deployed
  2. What is the difference between deploying & publishing my API?
  3. I want a resource to be accessible without authentication
  4. I cannot find where to download Client SDKs
  5. I get a 400 error (Bad request) when I try to invoke my API
  6. I get a 405 error (Method Not allowed) when I try to invoke my API
  7. I get a 415 error (Unsupported Media Type) when I try to invoke my API
  8. I get a 500 error when I try to invoke my API
  9. I need examples of POST and PUT requests
  10. I get an HTTP Error when I try to invoke my API
  11. The swagger button is disabled
  12. What is the difference between "Public" and "Anyone" settings for my API?
  13. Why has my store been undeployed?
  14. My csv file import failed
  15. I cannot find my cells anymore
  16. What happens when I downgrade my Plan?
  17. How do I allow third-party cookies in my browser ?

1. I wonder if my cell is deployed

Once your cell has been deployed, a confirmation message displays on top of your screen to inform you that the deployment is successful.

Confirmation message

If you have any doubt, go to the Messages tab which reports the last actions performed on your cell.

Messages tab

Jump to the Check your messages section of our online documentation for further information.

Back to list

2. What is the difference between deploying & publishing my API?

Deploying your API

When you deploy a cell, Restlet Cloud generates source code, compiles and deploys it in the cloud so that it will be executed in the Restlet Cloud runtime environment. As long as you have not deployed your data stores and web APIs, they are not available to store data or receive HTTP requests.

Jump to the Cell deployment section of our online documentation for further information.

Publishing your API

When you publish your API, you specify that it is in a stable state and is available to be used by end users or imported by other cells: you bring it into production. A Published cell (APIs, data stores, etc.) cannot undergo structural modifications or be deleted as this could break clients or other cells using it.

Jump to the Cell lifecycle section of our online documentation for further information.

Back to list

3. I want a resource to be accessible without authentication

The API credentials (login/password) are used to identify the users of your API. If you want a Resource to be accessible without authentication, you can modify the security access directly on a method and set it to Anyone, meaning a user authenticated or not.

Open your API's Overview, in the Resources section, select a resource method e.g. GET method.
In the central panel, click on the Security tab. Select the Anyone checkbox.
Click on the Save button.

Access to anyone

Back to list

4. I cannot find where to download Client SDKs

Deploy your web API.
Go to the Downloads tab.
From the Client SDKs section, select the SDK you want to download.
Click on the Download... button (working version or latest deployed version).

Download client SDKs

Jump to the Generate custom client SDKs section of our user guide for further information.

Back to list

5. I get a 400 error (Bad request) when I try to invoke my API

Make sure the syntax you are using is valid.

When using POSTMAN Chrome Extension to invoke your API, you may have entered your content in the address instead of entering it in the input area underneath the Headers.

POSTMAN POST request

Jump to our POST and PUT requests examples for further information.

Back to list

6. I get a 405 error (Method Not Allowed) when I try to invoke my API

Make sure the method you are using is allowed.

Open your API's Overview, in the Resources section, click on the resource you call e.g. contacts. The methods available are listed below the resource name.

Methods allowed

Back to list

7. I get a 415 error (Unsupported Media Type) when I try to invoke my API

Make sure the format used is valid.

When using POSTMAN Chrome Extension to invoke your API, you may have forgotten to set the Content Type Header to application/json.

Jump to our POST and PUT requests examples for further information.

Back to list

8. I get a 500 error when I try to invoke my API

Before invoking your API, make sure you call the last version of your API and Data Store. You need to (re)deploy your API and the Data Stores (or/and File Stores) associated.

(Re)deploy your API

Open your API's Overview and click on the Deploy button in the top right corner of your screen.

(Re)deploy your Data Stores

To retrieve the different cells your API uses, open your API's Overview and click on the Settings tab.
Click on the Imports section to see the different stores linked to your API.

To open a Store, click on the store you want to open from the Imports section.
Click on the name of the store in the central panel.

Open store

Click on the Deploy button in the top right corner of your screen.

Check the Entity Store Traces

If you still get a 500 error message, open your Entity Store's Overview page. Click the Messages tab. The Traces section may display a runtime error. Click on it and check its Content. If the content does not help you, send it to our Help Desk to allow a quick resolution.

Entity Store Traces

Back to list

9. I need examples of POST and PUT requests

To perform your POST and PUT requests, of course you can directly use your web browser, but we recommend that you use POSTMAN Chrome Extension that gives you a graphical view of your requests.

Open your API's Overview page.
Click on the relevant endpoint.
Copy your API credentials (Endpoint URI, Login and Password).
Paste them in POSTMAN to access your API.

POST request

Paste your API Endpoint URI followed by your resource name in POSTMAN e.g. https://myapi.restlet.net/v1/contacts.
Select the POST request from the drop-down menu. Make sure raw format and JSON language are selected.
Set Content Type Header to application/json.
Enter your new entry in the input area underneath and click Send. The new entry displays in the bottom section of the screen.

POSTMAN POST request

PUT request

Paste your API Endpoint URI followed by your resource name and the entry you want to modify in POSTMAN e.g. https://myapi.restlet.net/v1/contacts/{contactid}.
Select the PUT request from the drop-down menu.
Make sure raw format and JSON language are selected.
Set Content Type Header to application/json.
Enter your modifications in the input area underneath and click Send. The updated entry displays in the bottom section of the screen.

POSTMAN PUT request

Back to list

10. List of HTTP Errors Codes

http error code http error name actions / remedies
400 Bad Request Make sure the syntax you are using is valid. When using POSTMAN Chrome Extension to invoke your API, you may have entered your content in the address instead of entering it in the input area underneath the Headers.
401 Unauthorized Make sure you entered the right credentials.
403 Forbidden Make sure the method you are using is allowed or make sure you entered credentials (access is not public).
405 Method Not Allowed Make sure the method you are using is allowed: open your API's Overview, in the Resources section, click on the resource you call e.g. contacts. The methods available are listed below the resource name.
415 Unsupported Media Type When using POSTMAN Chrome Extension to invoke your API, you may have forgotten to set the Content Type Header to application/json.
422 Unprocessable Entity Make sure that the data you POST refer to the representation's properties and not to the column names they are mapping. Also make sure you use the right value type (string, integer) in yoclass="anchor" ur POST.
500 Internal Server Error Before invoking your API, make sure you call the last version of your API and Data Store. You need to (re)deploy your API and the Data Stores (or/and File Stores) associated.

Back to list

11. The swagger button is disabled

You may have removed your API https endpoint. To test your API via Swagger UI, you need an https endpoint.

swagger UI button disabled

From your API, go to the Overview tab.
From the Endpoints section, click on the Add button and add an https endpoint.
The swagger button is now enabled for your http endpoint.

swagger UI button enabled

Jump to the Test your API section of our online documentation for further information.

Back to list

12. What is the difference between "Public" and "Anyone" settings for my API?

It is important you do not confuse the Public checkbox which makes your API's Overview public with the Anyone checkbox that lets you deactivate authentication on a specific method.

Make your API Description public

You can make the Description of an API publicly available and not the API itself. In this instance, accessing your API would still require your credentials (which can be found in the Overview tab by clicking your Endpoint on the left).

From your API's Overview, click General information.
Select the Share API Overview checkbox.

Make your API Description public

Deactivate authentication

on a particular method

If you wish to make your API available to anyone (without authentication), you can set each method independently.

From your API's Overview, select a method from the Resources section.
Click on the Security tab and select the Anyone checkbox.

Anyone checkbox

for your whole API

If you wish for anyone to be able to access an API you can set this up right from the beginning when exporting your web API from the data store, so that you do not have to deactivate authentication for each resource and method manually.

From your data store, click on the cog button (on the left of the Deploy button) and select Export web API.
From the creation wizard, click on Customize settings and select No authentication required from the Default permissions drop-down menu.

Anyone checkbox

Back to list

13. Why has my store been undeployed?

If you read this message when opening your store: "This cell has been undeployed due to inactivity", it means you Entity Store has been deactivated as it has not been used for at least two months.

Two actions are now possible. You can either delete your store or activate it again by redeploying it.

Click on the Deploy button.

Deploy your store

You can now use your Entity Store.

Back to list

14. My csv file import failed

Restlet Cloud allows you to import data stored in a csv file in your Entity Store from the data browser. This import will automatically fail after 25 errors. You will get an error message that invites you to navigate to the Traces of the Messages tab.

Error message

From this tab, you will be given the lines for which errors have been detected.

Messages tab

Back to list

15. I cannot find my cells anymore

You may have created two different accounts with the same email address but with two different providers. That is why you cannot find cells you created on a different account.

To have more information on your account, navigate to your account page: click on your name on top right of the screen, select My account.

My account

In the My account tab, you will find the email and the provider with which you created the current account.

In this example, you created an account directly with Restlet Cloud and without any provider:

My account

In this example, you created an account with Google provider:

My account

Back to list

16. What happens when I downgrade my Plan?

As you downgrade to a lower Plan, you will no longer access specific features depending on the Plan you are subscribing to. You will find the impacts of your downgrade on each product below.

Downgrading from Team to Solo Plan

Impacts on Restlet Studio

  • All members will be removed from your team.
  • You will not be allowed to create as many APIs as permitted by your current plan. Existing APIs will not be affected.

Impacts on Restlet Client

  • All members will be removed from your team.
  • Your Maven plugin license will be revoked.

Downgrading from Solo to Free plan

Impacts on Restlet Studio

  • You will not be allowed to create as many APIs as permitted by your current plan. Existing APIs will not be affected.
  • You will no longer benefit from premium support.

Impacts on Restlet Client

  • You will not be allowed to create as many test scenarios as permitted by your current plan. Existing test scenarios will not be affected.
  • You will no longer benefit from premium support.

Downgrading from Team to Free plan

Impacts on Restlet Studio

  • All members will be removed from your team.
  • You will not be allowed to create as many APIs as permitted by your current plan. Existing APIs will not be affected.
  • You will no longer benefit from premium support.

Impacts on Restlet Client

  • All members will be removed from your team.
  • You will not be allowed to create as many test scenarios as permitted by your current plan. Existing test scenarios will not be affected.
  • Your Maven plugin license will be revoked.
  • You will no longer benefit from premium support.

Back to list

17. How do I allow third-party cookies in my browser ?

Third party cookies should be enabled in your browser because we rely on a third-party provider (Auth0) for our security and user account management

Chrome

  1. Click the menu icon in the upper right side of the browser window.

  2. Click Settings.

  3. Click Advanced at the bottom of the page.

  4. Click Content settings...

  5. Click Cookies

  6. Uncheck Block third-party cookies

Firefox

  1. Click the menu icon.

  2. Open the Options window.

  • For Windows users, click Options.
  • For Mac OS users, click Preferences...
  1. Click the Privacy & Security panel.

  2. In the History section, select Firefox will: Remember history.

Safari

  1. Click Safari in the menu bar.

  2. Click Preferences...

  3. Click the Privacy panel.

  4. Uncheck Prevent cross-site tracking

Internet Explorer

  1. Click the cog/tools menu icon in the upper right of the window.

  2. Click Internet Options.

  3. Click the Privacy tab.

  4. Click Advanced.

  5. Check Accept under Third-party cookies section

  6. Click OK

Microsoft Edge

  1. Click the menu icon in the upper right side of the browser window.

  2. Click Settings

  3. Click View Advanced Settings

  4. Select Don't block cookies under Cookies section