Skip to content

Introduction

The CloudStick API v1 is a set of HTTP endpoints that adhere to RESTful design principles with predictable URIs. It uses standard HTTP response codes, authentication, and verbs. The API has consistent and well-formed JSON requests and responses with cursor-based pagination to simplify list handling. Error messages are descriptive and easy to understand. All functions of the CloudStick dashboard are accessible via the API, enabling you to script complex unattended scenarios with any tool fluent in HTTP. Depending on the release or addition of new features into CloudStick, this API documentation will develop gradually.

Let’s Kick Off

To get started with cloudStick API, you would require a CloudStick account, If you don’t own one, you can create a new one from here.

Response Codes

Communicate with the API by making an HTTP request at the correct endpoint. The chosen method determines the action taken.

Method Description
DELETE Use the DELETE method to destroy a resource in your account. If it is not found, the operation will return a 4xx error and an appropriate message.
GET To retrieve information about a resource, use the GET method. The data is returned as a JSON object. GET methods are read-only and do not affect any resources.
PATCH Some resources support partial modification with PATCH, which modifies specific attributes without updating the entire object representation.
POST Issue a POST method to create a new object. Include all needed attributes in the request body encoded as JSON.
PUT PUT Use the PUT method to update information about a resource. PUT will set new values on the item without regard to its current values.

Response Codes

We use standard HTTP response codes to show the success or failure of requests. Response codes in the 2xx range indicate success, while codes in the 4xx range indicate an error, such as an authorization failure or a malformed request. All 4xx errors will return a JSON response object with an error attribute explaining the error. Codes in the 5xx range indicate a server-side problem preventing Vultr from fulfilling your request.

Responce Description
200 OK The response contains your requested information.
201 Created Your request was accepted. The resource was created.
202 Accepted Your request was accepted. The resource was created or updated.
204 No Content Your request succeeded, there is no additional information returned.
400 Bad Request Your request was malformed.
401 Unauthorized You did not supply valid authentication credentials.
403 Forbidden You are not allowed to perform that action.
404 Not Found No results were found for your request.
429 Too Many Requests Your request exceeded the API rate limit.
50x Internal Server Error We were unable to perform the request due to server-side problems.

API Endpoint

CloudStick API base URL is:

https://api.cloudstick.io/api/v1/

Headers

Please make sure to use Content-Type:application/json on all requests to CloudStick API

Authentication

The CloudStick API v1 uses an API key and API secret pair for authentication. Make sure to include API key and secret in all your request made to CloudStick API. You can manage the API key and Secret on your Cloudstick dashboard. Please do not share API keys publicly, or embed them in client-side code.

You can manage your API Key and Secret from your CloudStick Dashboard