Getting Started

To begin using the stable Version 3 of the V.cloud API, follow these steps:

Prerequisites

Before you start, make sure you have:

An active V.cloud account.
Your V.cloud Project API Key.
Basic understanding of RESTful APIs and JSON format.
A tool to make API requests (Postman, Curl, or any HTTP client library).

Base URL

The production API endpoint is:

Authentication

Include your project key with every request:

key: <Your VCloud Project API-Key>

Content Type Requirement

All requests must be sent in JSON format with the appropriate content type header:

Content-Type: application/json

Example API Request

Check a room's status using the following curl command:

curl -X GET {{V.cloud}}/api/v3/rooms/room_status?room_id={{room_id}} \
  -H "Content-Type: application/webhook+json" \
  -H "key: <Your VCloud Project API-Key>"

Postman Collection

For easier API testing, use the Version 3 Postman collection.